From 400df47678c635d6bade3c5741697748f80df6c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Laurent=20Inderm=C3=BChle?= Date: Wed, 29 Nov 2023 20:32:38 +0100 Subject: [PATCH] Enhance documentation for basic install (#1621) - Describe checking out the tag to deploy in basic install instructions - 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. --- docs/installation/basic-install.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/installation/basic-install.md b/docs/installation/basic-install.md index cb17427e..77fb904a 100644 --- a/docs/installation/basic-install.md +++ b/docs/installation/basic-install.md @@ -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/ + +# 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: + +```sh +export VERSION= + +# 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: @@ -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. @@ -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= # Add this extra line: - - awx-demo.yaml + - awx-demo.yml ... ```