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

Add docs for proper kustomization installs #843

Merged
merged 3 commits into from
Mar 28, 2022
Merged

Add docs for proper kustomization installs #843

merged 3 commits into from
Mar 28, 2022

Conversation

mac-chaffee
Copy link
Contributor

Closes #840

This PR adds documentation for installing awx-operator natively with Kustomize, rather than requireing the user to clone the repo. This way, users can provide their own patches and additional resources on top of the base resources.

I also regenerated the table of contents and added a comment telling users how to regenerate it like #793 found.

Copy link
Member

@shanemcd shanemcd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello. Thanks for this, it's a great contribution. One small request, otherwise this all looks awesome.

README.md Outdated Show resolved Hide resolved
@mac-chaffee mac-chaffee requested a review from shanemcd March 24, 2022 23:19
@kurokobo
Copy link
Contributor

Thanks for PR, I have two comments.

kustomize build . | kubectl apply -f -

This requires that the kustomize command have to be installed, but there is no instruction to install kustomize.
The same things can be achieved by kubectl appky -k . without kustomize command, in my opinion this is much easier than installing/using kustomize command. What do you think?

Next, create a file named awx-demo.yml in the same folder
...

  # Add this extra line:
  - awx-demo.yaml

Two filenames are not matched (yaml/yml).

It's recommended to install the standalone version of kustomize rather
than using the version that ships with kubectl because that version is
typically very old and doesn't match the docs.
@mac-chaffee
Copy link
Contributor Author

mac-chaffee commented Mar 26, 2022

The reason I didn't recommend using the version of kustomize that comes with kubectl is because that version is typically quite outdated. Looks like the situation is improving since kubectl v1.23 is catching up, but as recently as kubectl v1.20 is two major versions behind.

I find that the one thing harder than keeping my clusters up-to-date is making sure all my users have updated clients ;)

EDIT: oh and it's very tough to see what version of kustomize you have when using the version shipped with kubectl. You have to go to the source and look at go.mod. So quite frustrating if trying to use some newer feature of kustomize that just doesn't seem to be working.

Copy link
Member

@shanemcd shanemcd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome contribution. Thanks a ton.

@shanemcd shanemcd enabled auto-merge March 28, 2022 20:46
@shanemcd shanemcd merged commit ee84625 into ansible:devel Mar 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for proper kustomization installs
3 participants