mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-27 13:53:12 +00:00
607a7ca58c
* Upgrading to postgres:15 * Changing image from postgres to sclorg * Handle scenario where upgrade status is not defined & correct pg tag * Rework the upgrade logic to be more resiliant for multiple upgrades --------- Co-authored-by: john-westcott-iv <john-westcott-iv@users.noreply.github.com> Co-authored-by: Christian M. Adams <chadams@redhat.com>
140 lines
3.6 KiB
Markdown
140 lines
3.6 KiB
Markdown
Restore Role
|
|
=========
|
|
|
|
The purpose of this role is to restore your AWX deployment from an existing PVC backup. The backup includes:
|
|
- custom deployment specific values in the spec section of the AWX custom resource object
|
|
- backup of the postgresql database
|
|
- secret_key, admin_password, and broadcast_websocket secrets
|
|
- database configuration
|
|
|
|
|
|
|
|
Requirements
|
|
------------
|
|
|
|
This role assumes you are authenticated with an Openshift or Kubernetes cluster:
|
|
- The awx-operator has been deployed to the cluster
|
|
- AWX is deployed to via the operator
|
|
- An AWX backup is available on a PVC in your cluster (see the backup [README.md](../backup/README.md))
|
|
|
|
*Before Restoring from a backup*, be sure to:
|
|
- delete the old existing AWX CR
|
|
- delete the persistent volume claim (PVC) for the database from the old deployment, which has a name like `postgres-<postgres version>-<deployment-name>-postgres-<postgres version>-0`
|
|
|
|
**Note**: Do not delete the namespace/project, as that will delete the backup and the backup's PVC as well.
|
|
|
|
|
|
Usage
|
|
----------------
|
|
|
|
Then create a file named `restore-awx.yml` with the following contents:
|
|
|
|
```yaml
|
|
---
|
|
apiVersion: awx.ansible.com/v1beta1
|
|
kind: AWXRestore
|
|
metadata:
|
|
name: restore1
|
|
namespace: my-namespace
|
|
spec:
|
|
deployment_name: mytower
|
|
backup_name: awxbackup-2021-04-22
|
|
```
|
|
|
|
Note that the `deployment_name` above is the name of the AWX deployment you intend to create and restore to.
|
|
|
|
The namespace specified is the namespace the resulting AWX deployment will be in. The namespace you specified must be pre-created.
|
|
|
|
```
|
|
kubectl create ns my-namespace
|
|
```
|
|
|
|
Finally, use `kubectl` to create the restore object in your cluster:
|
|
|
|
```bash
|
|
$ kubectl apply -f restore-awx.yml
|
|
```
|
|
|
|
This will create a new deployment and restore your backup to it.
|
|
|
|
> :warning: admin_password_secret value will replace the password for the `admin_user` user (by default, this is the `admin` user).
|
|
|
|
|
|
Role Variables
|
|
--------------
|
|
|
|
The name of the backup directory can be found as a status on your AWXBackup object. This can be found in your cluster's console, or with the client as shown below.
|
|
|
|
```bash
|
|
$ kubectl get awxbackup awxbackup1 -o jsonpath="{.items[0].status.backupDirectory}"
|
|
/backups/tower-openshift-backup-2021-04-02-03:25:08
|
|
```
|
|
|
|
```
|
|
backup_dir: '/backups/tower-openshift-backup-2021-04-02-03:25:08'
|
|
```
|
|
|
|
|
|
The name of the PVC can also be found by looking at the backup object.
|
|
|
|
```bash
|
|
$ kubectl get awxbackup awxbackup1 -o jsonpath="{.items[0].status.backupClaim}"
|
|
awx-backup-volume-claim
|
|
```
|
|
|
|
```
|
|
backup_pvc: 'awx-backup-volume-claim'
|
|
```
|
|
|
|
The backup pvc will be created in the same namespace the awxbackup object is created in.
|
|
|
|
If a custom postgres configuration secret was used when deploying AWX, it must be set:
|
|
|
|
```
|
|
postgres_configuration_secret: 'awx-postgres-configuration'
|
|
```
|
|
|
|
If the awxbackup object no longer exists, it is still possible to restore from the backup it created by specifying the pvc name and the back directory.
|
|
|
|
```
|
|
backup_pvc: myoldtower-backup-claim
|
|
backup_dir: /backups/tower-openshift-backup-2021-04-02-03:25:08
|
|
```
|
|
|
|
Variable to define Pull policy.You can pass other options like `Always`, `always`, `Never`, `never`, `IfNotPresent`, `ifnotpresent`.
|
|
|
|
```
|
|
image_pull_policy: 'IfNotPresent'
|
|
```
|
|
|
|
Variable to define resources limits and request for restore CR.
|
|
|
|
```
|
|
restore_resource_requirements:
|
|
limits:
|
|
cpu: "1000m"
|
|
memory: "4096Mi"
|
|
requests:
|
|
cpu: "25m"
|
|
memory: "32Mi"
|
|
```
|
|
|
|
Testing
|
|
----------------
|
|
|
|
You can test this role directly by creating and running the following playbook with the appropriate variables:
|
|
|
|
```
|
|
---
|
|
- name: Restore AWX
|
|
hosts: localhost
|
|
gather_facts: false
|
|
roles:
|
|
- restore
|
|
```
|
|
|
|
License
|
|
-------
|
|
|
|
MIT
|