diff --git a/README.md b/README.md index ac11024a..ec85af54 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) @@ -775,6 +776,18 @@ Example configuration of environment variables eks.amazonaws.com/role-arn: arn:aws:iam:::role/ ``` + +### Uninstall ### + +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 `garbage_collect_secrets: true`. + ### 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.