From cd9bbc3a0e6015df0d78561b9cb9f75f4abfa406 Mon Sep 17 00:00:00 2001 From: eoq Date: Sun, 5 Sep 2021 07:38:16 -0400 Subject: [PATCH 1/4] Add Uninstall section Just a quick instruction on how to remove an AWX deployment from a new user who struggled with it for a bit. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 00c255a5..6ad9b3e3 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w * [Exporting Environment Variables to Containers](#exporting-environment-variables-to-containers) * [Extra Settings](#extra-settings) * [Service Account](#service-account) + * [Uninstall](#uninstall) * [Upgrading](#upgrading) * [Contributing](#contributing) * [Release Process](#release-process) @@ -760,6 +761,17 @@ Example configuration of environment variables eks.amazonaws.com/role-arn: arn:aws:iam:::role/ ``` + +### Uninstall ### + +To uninstall the AWX deployment you need to direct AWX Operator to initiate the removal which will delete all AWX objects except for persistent volumes. + +```bash +$ kubectl delete awx awx-demo +awx.awx.ansible.com "awx-demo" deleted +``` + + ### Upgrading To upgrade AWX, it is recommended to upgrade the awx-operator to the version that maps to the desired version of AWX. To find the version of AWX that will be installed by the awx-operator by default, check the version specified in the `image_version` variable in `roles/installer/defaults/main.yml` for that particular release. From e6d7f88a332eccd1a784fa97f1e6c753565329c5 Mon Sep 17 00:00:00 2001 From: eoq Date: Wed, 8 Sep 2021 16:01:48 -0400 Subject: [PATCH 2/4] Update README.md modified uninstall section based on PR review feedback --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ad9b3e3..838cc7b2 100644 --- a/README.md +++ b/README.md @@ -764,13 +764,14 @@ Example configuration of environment variables ### Uninstall ### -To uninstall the AWX deployment you need to direct AWX Operator to initiate the removal which will delete all AWX objects except for persistent volumes. +To uninstall an AWX deployment instance, you basically need to remove the AWX kind related to that instance. For example, to delete an AWX instance named awx-demo, you would do: ```bash $ kubectl delete awx awx-demo awx.awx.ansible.com "awx-demo" deleted ``` +Deleting an AWX instance will remove all related deployments and statefulsets, however, persistent volumes and secrets will remain. To enforce secrets also getting removed, you can use the garbage_collect_secrets: true. ### Upgrading From b684a5de35fb6cd57719a6d604ca0032cf44acf2 Mon Sep 17 00:00:00 2001 From: eoq Date: Wed, 8 Sep 2021 16:03:18 -0400 Subject: [PATCH 3/4] Update README.md one more tweak to uinstall comments --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 838cc7b2..816091f5 100644 --- a/README.md +++ b/README.md @@ -771,7 +771,7 @@ $ kubectl delete awx awx-demo awx.awx.ansible.com "awx-demo" deleted ``` -Deleting an AWX instance will remove all related deployments and statefulsets, however, persistent volumes and secrets will remain. To enforce secrets also getting removed, you can use the garbage_collect_secrets: true. +Deleting an AWX instance will remove all related deployments and statefulsets, however, persistent volumes and secrets will remain. To enforce secrets also getting removed, you can use garbage_collect_secrets: true. ### Upgrading From 054d5eb93f5aef05b1fc650aeea8da287006e308 Mon Sep 17 00:00:00 2001 From: eoq Date: Wed, 8 Sep 2021 22:14:08 -0400 Subject: [PATCH 4/4] Update README.md added some quotes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 816091f5..64909962 100644 --- a/README.md +++ b/README.md @@ -771,7 +771,7 @@ $ kubectl delete awx awx-demo awx.awx.ansible.com "awx-demo" deleted ``` -Deleting an AWX instance will remove all related deployments and statefulsets, however, persistent volumes and secrets will remain. To enforce secrets also getting removed, you can use garbage_collect_secrets: true. +Deleting an AWX instance will remove all related deployments and statefulsets, however, persistent volumes and secrets will remain. To enforce secrets also getting removed, you can use `garbage_collect_secrets: true`. ### Upgrading