Skip to content

Commit

Permalink
Docs: moved uninstall segment from readme (#1482)
Browse files Browse the repository at this point in the history
  • Loading branch information
LuluNwenyi authored Jul 27, 2023
1 parent 3a1b763 commit 93a7878
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
13 changes: 0 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ NOTE: we are in the process of moving this readme into official docs in the /do
* [AWX Operator](#awx-operator)
* [Table of Contents](#table-of-contents)
* [Usage](#usage)
* [Uninstall](#uninstall)
* [Disable IPV6](#disable-ipv6)
* [Add Execution Nodes](#adding-execution-nodes)
* [Custom Receptor CA](#custom-receptor-ca)
Expand All @@ -32,18 +31,6 @@ NOTE: we are in the process of moving this readme into official docs in the /do

<!--te-->

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

```
$ 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`.

**Note**: If you ever intend to recover an AWX from an existing database you will need a copy of the secrets in order to perform a successful recovery.

### Disable IPV6
Starting with AWX Operator release 0.24.0,[IPV6 was enabled in ngnix configuration](https://github.com/ansible/awx-operator/pull/950) which causes
Expand Down
12 changes: 12 additions & 0 deletions docs/uninstall/uninstall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### 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:

```
$ 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`.

**Note**: If you ever intend to recover an AWX from an existing database you will need a copy of the secrets in order to perform a successful recovery.

0 comments on commit 93a7878

Please sign in to comment.