Skip to content
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

Merged
merged 3 commits into from
Nov 29, 2023

Conversation

laurent-indermuehle
Copy link
Contributor

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 reference awx-demo.yaml with en extra a. I remove this road block for newcomers by using same yml extension everywhere.

ISSUE TYPE
  • Bug, Docs Fix or other nominal change
ADDITIONAL INFORMATION

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.
@rooftopcellist
Copy link
Member

@laurent-indermuehle Thank you for you PR! It looks like there is some confusion here though.

The make deploy install method and the kustomization.yml install method are two different ways to install the awx-operator. So you don't have to make a kustomization.yml file if you are using make deploy (thus "can" rather than "must").

I think we could make this clearer by splitting this up into two different markdown headers.

  • Make Deploy Install
  • Kustomize Install

Would you be open to updating your PR to reflect that?

@laurent-indermuehle
Copy link
Contributor Author

@rooftopcellist thanks for your reply. I will test again tomorrow, but I'm pretty sure make deploy failed when kustomization.yml file is absent. My computer here refuse to load kvm-amd module for whatever reason so it as to wait until I get back to the office. Sorry for the delay.

@laurent-indermuehle
Copy link
Contributor Author

@rooftopcellist sorry for the delay, something came up on Friday.
I took the time to read the makefile and modify my PR accordingly to what I understood.
I hope my explanation are clear enough.

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:
Copy link
Member

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.

Copy link
Contributor Author

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

@rooftopcellist rooftopcellist enabled auto-merge (squash) November 29, 2023 19:21
@rooftopcellist rooftopcellist merged commit 400df47 into ansible:devel Nov 29, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants