From 3754990eeae9b779d19174d8ee9dedb42766e362 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Laurent=20Inderm=C3=BChle?= Date: Tue, 7 Nov 2023 10:10:58 +0100 Subject: [PATCH 1/3] Document missing informations 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 | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/installation/basic-install.md b/docs/installation/basic-install.md index cb17427e9..adaab07cc 100644 --- a/docs/installation/basic-install.md +++ b/docs/installation/basic-install.md @@ -1,5 +1,13 @@ ### 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/ +``` + 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: @@ -12,7 +20,7 @@ If you have a custom operator image you have built, you can specify it with: IMG=quay.io/$YOURNAMESPACE/awx-operator:$YOURTAG make deploy ``` -Otherwise, you can manually create a file called `kustomization.yaml` with the following content: +Otherwise, you must manually create a file called `kustomization.yaml` with the following content: ```yaml apiVersion: kustomize.config.k8s.io/v1beta1 @@ -67,7 +75,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 +112,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 ... ``` From 9d32c06e2bb8c1ae9214c4c1054f8fdf366a60ac Mon Sep 17 00:00:00 2001 From: Laurent Indermuehle Date: Mon, 13 Nov 2023 14:25:10 +0100 Subject: [PATCH 2/3] Revert word change since kustomization as nothing to do with make deploy --- docs/installation/basic-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/basic-install.md b/docs/installation/basic-install.md index adaab07cc..38afcb3cd 100644 --- a/docs/installation/basic-install.md +++ b/docs/installation/basic-install.md @@ -20,7 +20,7 @@ If you have a custom operator image you have built, you can specify it with: IMG=quay.io/$YOURNAMESPACE/awx-operator:$YOURTAG make deploy ``` -Otherwise, you must manually create a file called `kustomization.yaml` with the following content: +Otherwise, you can manually create a file called `kustomization.yaml` with the following content: ```yaml apiVersion: kustomize.config.k8s.io/v1beta1 From b172c6a59a283009bc25da164297ee00f764eedf Mon Sep 17 00:00:00 2001 From: Laurent Indermuehle Date: Mon, 13 Nov 2023 14:27:23 +0100 Subject: [PATCH 3/3] Document how to select the version from a fork --- docs/installation/basic-install.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/installation/basic-install.md b/docs/installation/basic-install.md index 38afcb3cd..77fb904a2 100644 --- a/docs/installation/basic-install.md +++ b/docs/installation/basic-install.md @@ -6,6 +6,18 @@ 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/ )