Adding ansible operator workflow to the README #667
Merged
Conversation
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
openshift-ci-robot
added
the
size/XS
hasbro17
reviewed
Oct 29, 2018
README.md
Outdated
| 2. Define new resource APIs by adding Custom Resource Definitions(CRD) (This can be done in the new command) | ||
| 3. Write the reconciling logic for your object using ansible playbooks and roles. | ||
| 4. Define the mapping between the CRD definition in the `watches.yaml` file. | ||
| 5. Use the SDK CLI to build and generate the operator deployment manifests |
There was a problem hiding this comment.
Nit: Either keep or remove the period(full stop) at the end of the sentence for all bullet points.
4 has it. 5 doesn't.
shawn-hurley
force-pushed
the
docs/add-ao-workdlow
branch
from
b8eff6d to
021106a
Compare
mhrivnak
reviewed
Oct 31, 2018
| 1. Create a new operator project using the SDK Command Line Interface(CLI) | ||
| 2. Define new resource APIs by adding Custom Resource Definitions(CRD) | ||
| 3. Define Controllers to watch and reconcile resources | ||
| 4. Write the reconciling logic for your Controller using the SDK and controller-runtime APIs | ||
| 5. Use the SDK CLI to build and generate the operator deployment manifests | ||
|
|
||
| The following workflow is for a new **Ansible** operator: |
There was a problem hiding this comment.
Don't steps 1, 2, 4 and 5 all largely happen as the result of the operator-sdk new command? I know it only gives you a single CRD to work with, but that will get most people a long way when they start. I'd describe the workflow more as:
- create new operator with the sdk
- write ansible to do stuff
- use sdk to build and run the operator
- optionally add additional CRDs for specific purposes
There was a problem hiding this comment.
I agree I am going to change better align with @mhrivnak's feedback
shawn-hurley
force-pushed
the
docs/add-ao-workdlow
branch
from
021106a to
c62729a
Compare
mhrivnak
approved these changes
Nov 2, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of the change:
Adding workflow for the ansible operator in the README.
Motivation for the change:
Making the workflow just as obvious as golang
/cc @hasbro17