AnsibleAutomationPlatformBackup and AnsibleAutomationPlatformRestore [aap.ansible.com/v1alpha1]

The AnsibleAutomationPlatformBackup and AnsibleAutomationPlatformRestore custom resources manage backup and restore operations for your Ansible Automation Platform deployment on OpenShift Container Platform. You can configure global settings or override them per component.

AnsibleAutomationPlatformBackup
Copy link

Expand
API Group aap.ansible.com
API Version v1alpha1
Kind AnsibleAutomationPlatformBackup
Scope Namespaced

AnsibleAutomationPlatformBackup spec
Copy link

The spec fields for the AnsibleAutomationPlatformBackup custom resource.

Expand
Field Type Description Default
deployment_name String Name of theAnsibleAutomationPlatform instance to back up. Required. -
no_log Boolean Suppress logging of sensitive data during the backup process. true
backup_pvc String Name of the persistent volume claim (PVC) to use for backup storage. This value applies globally to all components unless overridden. -
backup_storage_class String Kubernetes storage class for the backup PVC. Applies globally to the platform gateway. Components that do not specify their ownbackup_storage_class inherit this value. -
backup_storage_requirements String Storage size for the backup PVC, for example15Gi. -
hub Object

Override backup settings for the automation hub component. See Component backup overrides.

 -
controller Object Override backup settings for the automation controller component. See Component backup overrides. -
eda Object Override backup settings for the Event-Driven Ansible component. See Component backup overrides. -

Component backup overrides
Copy link

Each component section (hub, controller, eda) supports the following fields to override global backup settings.

Expand
Field Type Description Default
backup_pvc String Name of the PVC for this component's backup. Overrides the globalbackup_pvc. Inherited from global
backup_storage_requirements String Storage size for this component's backup PVC, for example25Gi. Inherited from global
backup_storage_class String Storage class for this component's backup PVC. Overrides the globalbackup_storage_class. Inherited from global
create_backup_pvc Boolean Set to true to have the operator create the PVC automatically. false
no_log Boolean Suppress logging of sensitive data for this component. Overrides the global no_log. Inherited from global

Example backup custom resource
Copy link

The following example shows a backup custom resource with per-component overrides for PVC names, storage sizes, and storage classes:

apiVersion: aap.ansible.com/v1alpha1
kind: AnsibleAutomationPlatformBackup
metadata:
  name: custom-backup
spec:
  deployment_name: myaap
  no_log: false
  backup_storage_class: rook-cephfs
  hub:
    backup_pvc: custom-hub-backup-pvc
    backup_storage_requirements: 25Gi
    backup_storage_class: rook-cephfs
    create_backup_pvc: true
    no_log: false
  controller:
    backup_pvc: custom-controller-backup-pvc
    backup_storage_requirements: 15Gi
    backup_storage_class: rook-block
    create_backup_pvc: true
    no_log: false
  eda:
    backup_pvc: custom-eda-backup-pvc
    backup_storage_requirements: 7Gi
    backup_storage_class: rook-block
    create_backup_pvc: true
    no_log: false

AnsibleAutomationPlatformRestore
Copy link

Expand
API Group aap.ansible.com
API Version v1alpha1
Kind AnsibleAutomationPlatformRestore
Scope Namespaced

AnsibleAutomationPlatformRestore spec
Copy link

The spec fields for the AnsibleAutomationPlatformRestore custom resource.

Expand
Field Type Description Default
deployment_name String Name of theAnsibleAutomationPlatform instance to restore. Required. -
backup_name String Name of theAnsibleAutomationPlatformBackup resource to restore from. Required. -
no_log Boolean Suppress logging of sensitive data during the restore process. true

Example restore custom resource
Copy link

apiVersion: aap.ansible.com/v1alpha1
kind: AnsibleAutomationPlatformRestore
metadata:
  name: restore-myaap
spec:
  deployment_name: myaap
  backup_name: custom-backup