Red Hat Ansible Automation Platform operator backup and recovery guide

Procedure

1. Log in to Red Hat OpenShift Container Platform.
2. Navigate to Operators → Installed Operators.
3. Select the Ansible Automation Platform Operator installed on your project namespace.
4. Select the Automation Controller Backup tab.
5. Click Create AutomationControllerBackup.
6. Enter a Name for the backup.
7. Enter the Deployment name of the deployed Ansible Automation Platform instance being backed up. For example, if your automation controller must be backed up and the deployment name is aap-controller, enter 'aap-controller' in the Deployment name field.

8. If you want to use a custom, pre-created pvc:

   1. Optionally enter the name of the Backup persistant volume claim.

   2. Optionally enter the Backup PVC storage requirements, and Backup PVC storage class.

      Note

      If no pvc or storage class is provided, the cluster’s default storage class is used to create the pvc.

   3. If you have a large database, specify your storage requests accordingly under Backup management pod resource requirements.

      Note

      You can check the size of the existing postgres database data directory by running the following command inside the postgres pod.

      $ df -h | grep "/var/lib/pgsql/data"

9. Click Create.

   A backup tarball of the specified deployment is created and available for data recovery or deployment rollback. Future backups are stored in separate tar files on the same pvc.

Verification

1. Log in to Red Hat Red Hat OpenShift Container Platform
2. Navigate to Operators → Installed Operators.
3. Select the Ansible Automation Platform Operator installed on your project namespace.
4. Select the AutomationControllerBackup tab.
5. Select the backup resource you want to verify.

6. Scroll to Conditions and check that the Successful status is True.

   Note

   If Successful is False, the backup has failed. Check the automation controller operator logs for the error to fix the issue.

Procedure

1. Create a file named "backup-awx.yml" with the following contents:

   ---
   apiVersion: automationcontroller.ansible.com/v1beta1
   kind: AWXBackup
   metadata:
     name: awxbackup-2024-07-15
     namespace: my-namespace
   spec:
     deployment_name: controller

   Note

   The "deployment_name" above is the name of the automation controller deployment you intend to backup from. The namespace above is the one containing the automation controller deployment you intend to back up.

2. Use the oc apply command to create the backup object in your cluster:

Procedure

1. Log in to Red Hat OpenShift Container Platform.
2. Navigate to Operators → Installed Operators.
3. Select the Ansible Automation Platform Operator installed on your project namespace.
4. Select the Automation Hub Backup tab.
5. Click Create AutomationHubBackup.
6. Enter a Name for the backup.
7. Enter the Deployment name of the deployed Ansible Automation Platform instance being backed up. For example, if your automation hub must be backed up and the deployment name is aap-hub, enter 'aap-hub' in the Deployment name field.

8. If you want to use a custom, pre-created pvc:

   1. Optionally, enter the name of the Backup persistent volume claim, Backup persistent volume claim namespace, Backup PVC storage requirements, and Backup PVC storage class.

9. Click Create.

   A backup of the specified deployment is created and available for data recovery or deployment rollback.

Procedure

1. Log in to Red Hat OpenShift Container Platform.
2. Navigate to Operators → Installed Operators.
3. Select the Ansible Automation Platform Operator installed on your project namespace.
4. Select the Automation Controller Restore tab.
5. Click Create AutomationControllerRestore.
6. Enter a Name for the recovery deployment.

7. Enter a New Deployment name for the restored deployment.

   Note

   This should be different from the original deployment name.

8. Select the Backup source to restore from. Backup CR is recommended.
9. Enter the Backup Name of the AutomationControllerBackup object.

10. Click Create.

    A new deployment is created and your backup is restored to it. This can take approximately 5 to 15 minutes depending on the size of your database.

Verification

1. Log in to Red Hat Red Hat OpenShift Container Platform
2. Navigate to Operators → Installed Operators.
3. Select the Ansible Automation Platform Operator installed on your project namespace.
4. Select the AutomationControllerRestore tab.
5. Select the restore resource you want to verify.

6. Scroll to Conditions and check that the Successful status is True.

   Note

   If Successful is False, the recovery has failed. Check the automation controller operator logs for the error to fix the issue.

1. Create a external-postgres-configuration-secret YAML file, following the template below:

   apiVersion: v1
   kind: Secret
   metadata:
     name: external-restore-postgres-configuration
     namespace: <target_namespace> 1
   stringData:
     host: "<external_ip_or_url_resolvable_by_the_cluster>" 2
     port: "<external_port>" 3
     database: "<desired_database_name>"
     username: "<username_to_connect_as>"
     password: "<password_to_connect_with>" 4
     sslmode: "prefer" 5
     type: "unmanaged"
   type: Opaque

   1

   Namespace to create the secret in. This should be the same namespace you wish to deploy to.

   2

   The resolvable hostname for your database node.

   3

   External port defaults to 5432.

   4

   Value for variable password should not contain single or double quotes (', ") or backslashes (\) to avoid any issues during deployment, backup or restoration.

   5

   The variable sslmode is valid for external databases only. The allowed values are: prefer, disable, allow, require, verify-ca, and verify-full.

2. Apply external-postgres-configuration-secret.yml to your cluster using the oc create command.

   $ oc create -f external-postgres-configuration-secret.yml

3. When creating your AutomationControllerRestore custom resource object, specify the secret on your spec, following the example below:

   kind: AutomationControllerRestore
   apiVersion: automationcontroller.ansible.com/v1beta1
   metadata:
     namespace: my-namespace
     name: awxrestore-2024-07-15
   spec:
     deployment_name: restored_controller
     backup_name: awxbackup-2024-07-15
     postgres_configuration_secret: 'external-restore-postgres-configuration'

Procedure

1. Log in to Red Hat OpenShift Container Platform.
2. Navigate to Operators → Installed Operators.
3. Select the Ansible Automation Platform Operator installed on your project namespace.
4. Select the Automation Hub Restore tab.
5. Click Create AutomationHubRestore.
6. Enter a Name for the recovery deployment.
7. Select the Backup source to restore from. Backup CR is recommended.
8. Enter the Backup Name of the AutomationHubBackup object.

9. Click Create.

   A new deployment is created and your backup is restored to it.

Procedure

1. Delete the existing AutomationController and the associated postgres PVC:

   oc delete automationcontroller <YOUR_DEPLOYMENT_NAME> -n <YOUR_NAMESPACE>
   
   oc delete pvc postgres-13-<YOUR_DEPLOYMENT_NAME>-13-0 -n <YOUR_NAMESPACE>

2. Use AutomationControllerRestore with the same deployment_name in it:

   oc apply -f restore.yaml