-
Notifications
You must be signed in to change notification settings - Fork 99
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
Open
Fryguy
wants to merge
1
commit into
ManageIQ:master
Choose a base branch
from
Fryguy:operator_docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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