-
Notifications
You must be signed in to change notification settings - Fork 640
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
Enhance documentation for basic install #1621
Conversation
Also, the repo already contains a awx-demo.yml file but the doc reference awx-demo.yaml with en extra a. I remove this road block for newcomers by using same 'yml' extension everywhere.
@laurent-indermuehle Thank you for you PR! It looks like there is some confusion here though. The I think we could make this clearer by splitting this up into two different markdown headers.
Would you be open to updating your PR to reflect that? |
@rooftopcellist thanks for your reply. I will test again tomorrow, but I'm pretty sure |
@rooftopcellist sorry for the delay, something came up on Friday. |
git checkout tags/2.7.2 | ||
``` | ||
|
||
If you work from a fork and made modifications since the tag was issued, you must provide the VERSION number to deploy. Otherwise the operator will get stuck in "ImagePullBackOff" state: |
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.
It would be good to point out in a note that if they make changes to the role, they should build the image with the changes, push it to their registry, then specify the custom operator image. or, point them to the contributing guide.
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.
Isn't lines 30-33 already implicitly explaining that @rooftopcellist?
If you have a custom operator image you have built, you can specify it with:
IMG=quay.io/$YOURNAMESPACE/awx-operator:$YOURTAG make deploy
SUMMARY
This PR add missing information about how to choose a release with Git in order for the
make deploy
to not fall inside the "Pull Image Backoff" state.Also, the repo already contains a
awx-demo.yml
file but the doc referenceawx-demo.yaml
with en extraa
. I remove this road block for newcomers by using sameyml
extension everywhere.ISSUE TYPE
ADDITIONAL INFORMATION