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.

Sign up for GitHub

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
Merged

Enhance documentation for basic install #1621

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3754990
Document missing informations
laurent-indermuehle Nov 7, 2023
9d32c06
Revert word change since kustomization as nothing to do with make deploy
laurent-indermuehle Nov 13, 2023
b172c6a
Document how to select the version from a fork
laurent-indermuehle Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions docs/installation/basic-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
### Basic Install

After cloning this repository, you must choose the tag to run:
```sh
git clone git@github.com:ansible/awx-operator.git
cd awx-operator
git tag
git checkout tags/<tag>

# For instance:
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


```sh
export VERSION=<tag>

# For instance:
export VERSION=2.7.2
```

Once you have a running Kubernetes cluster, you can deploy AWX Operator into your cluster using [Kustomize](https://kubectl.docs.kubernetes.io/guides/introduction/kustomize/). Since kubectl version 1.14 kustomize functionality is built-in (otherwise, follow the instructions here to install the latest version of Kustomize: https://kubectl.docs.kubernetes.io/installation/kustomize/ )

There is a make target you can run:
Expand Down Expand Up @@ -67,7 +87,7 @@ So we don't have to keep repeating `-n awx`, let's set the current namespace for
$ kubectl config set-context --current --namespace=awx
```

Next, create a file named `awx-demo.yaml` in the same folder with the suggested content below. The `metadata.name` you provide will be the name of the resulting AWX deployment.
Next, create a file named `awx-demo.yml` in the same folder with the suggested content below. The `metadata.name` you provide will be the name of the resulting AWX deployment.

**Note:** If you deploy more than one AWX instance to the same namespace, be sure to use unique names.

Expand Down Expand Up @@ -104,7 +124,7 @@ Make sure to add this new file to the list of "resources" in your `kustomization
resources:
- github.com/ansible/awx-operator/config/default?ref=<tag>
# Add this extra line:
- awx-demo.yaml
- awx-demo.yml
...
```

Expand Down
Loading