-
Notifications
You must be signed in to change notification settings - Fork 98
Add initial contributing docs for operator #1216
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Contributing | ||
|
|
||
| Please read the [ManageIQ guides](http://github.com/ManageIQ/guides) before contributing. | ||
|
|
||
| Image Dockerfiles and assets are located under the `images` directory. | ||
|
|
||
| The ManageIQ Kubernetes operator is located in the `manageiq-operator` directory. To read more about contributing to the ManageIQ operator, see the [manageiq-operator/CONTRIBUTING.md](manageiq-operator/CONTRIBUTING.md) file. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Contributing | ||
|
|
||
| Please read the [ManageIQ guides](http://github.com/ManageIQ/guides) before contributing. | ||
|
|
||
| ## Development Setup | ||
|
|
||
| ### Pre-requisites | ||
|
|
||
| * In order to compile the operator, install the operator-sdk: | ||
|
|
||
| | | | | ||
| | ---- | --- | | ||
| | dnf | [Installation Docs](https://sdk.operatorframework.io/docs/installation/#install-from-github-release) | | ||
| | brew | `brew install operator-sdk` | | ||
|
|
||
| * Ensure you have a Kubernetes or OpenShift cluster available in which you can test. Set up of the cluster is outside the scope of this document. | ||
|
|
||
| #### Cluster pre-requisites | ||
|
|
||
| * Create a namespace for deployment and development. | ||
| * Ensure you have any ImagePullSecrets configured. | ||
| * Ensure you have Physical Volumes created and available for the various services, such as PostgreSQL. | ||
| * Install the [Strimzi](https://strimzi.io/) operator into the cluster to be used as the Kafka service. | ||
|
|
||
| #### ManageIQ operator setup | ||
|
|
||
| * If you want to develop and run the operator locally, acting on the remote cluster namespace, be sure that the requisite Cluster Resource Definition (CRD), Role, Service Account, and Role Binding are installed in the cluster. | ||
|
|
||
| ``` | ||
| kubectl apply -f config/crd/bases/manageiq.org_manageiqs.yaml | ||
| kubectl apply -f config/rbac/role.yaml | ||
| kubectl apply -f config/rbac/service_account.yaml | ||
| kubectl apply -f config/rbac/role_binding.yaml | ||
| ``` | ||
|
|
||
| ## Development | ||
|
|
||
| To run the operator locally in development: | ||
|
|
||
| ```sh | ||
| $ WATCH_NAMESPACE=<namespace> make run | ||
| ``` | ||
|
|
||
| If you don't already have a ManageIQ CR in the namespace, now you can create one, and the operator will see that and start acting accordingly. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Example: https://github.com/ManageIQ/manageiq-pods/blob/master/manageiq-operator/config/samples/_v1alpha1_manageiq.yaml |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And make