Taking an analytics infrastructure configuration backup

How to backup your analytics subsystem deployment configuration.

About this task

The analytics infrastructure configuration backup consists of:
  • Backup of your analytics CR YAML file.
  • Backup of any custom certificates you configured. For example, the certificates that secure your communication with your remote S3 object-store, and any certificates used for connecting to third-party systems for analytics offload.
Note: Every time that you update the analytics subsystem CR or any custom analytics certificates, take a new analytics infrastructure configuration backup.

The infrastructure configuration backup is also referred to as the config backup.

If you have a disaster, your config backup is essential for restoring your analytics subsystem.

Note: For OpenShift users: The steps that are detailed in this topic use the Kubernetes kubectl command. On OpenShift, use the equivalent oc command in its place.

Procedure

  1. Backup your analytics CR to a file called analytics-subsystem-cr-backup.yaml:
    kubectl get a7s -o yaml > analytics-subsystem-cr-backup.yaml
  2. Backup your analytics database backup secret to a file called analytics-backup-secret_backup.yaml:
    kubectl get secret analytics-backup-secret -o yaml > analytics-backup-secret_backup.yaml

    The backup secret is created when you configure analytics database backups: Configuring analytics database backups. If database backups are not yet configured, ensure that this secret is backed up when it is configured.

  3. If you are using the analytics offload feature, then backup any custom offload certificates that are used:
    kubectl get secret <offload secret name> -o yaml > analytics-offload-secret_backup.yaml

    For more information about offload certificates, see Offload to third-party systems.

  4. If your object-store has a self-signed CA certificate, then backup the secret that contains this certificate:
    kubectl get secret <object-store CA secret name> -o yaml > analytics-objstore-CA-secret_backup.yaml

    For more information about object-store CA certificates, see Creating the object-store CA certificates.

  5. If you manually created or customized any other analytics subsystem certificates, then take a backup of them:
    To identify all the secrets in your analytics namespace, run:
    kubectl get secrets
    For each secret that you want to backup, use the following command:
    kubectl get secret <secret name> -o yaml > <backup filename>

    You do not need to backup any secrets that cert-manager created and maintains. For more information about analytics TLS certificates, see API Connect TLS certificates.

  6. Copy all the backup files that were created in the previous steps to a safe location.