Back up component-specific persistent data and configurations

Verrazzano provides Velero and rancher-backup for backup and recovery at the component and platform level. First, ensure that the backup component prerequisites are met, as indicated here.

The following sections provide detailed configuration information for:

Rancher backup

To initiate a Rancher backup, create the following example custom resource YAML file that uses an Amazon S3 compatible object store as a backend. The operator uses the credentialSecretNamespace value to determine where to look for the Amazon S3 backup secret. Note that in the prerequisites example, you previously created the secret in the verrazzano-backup namespace.

kind: Backup
  name: rancher-backup-test
      credentialSecretName: rancher-backup-creds
      credentialSecretNamespace: verrazzano-backup
      bucketName: myvz-bucket
      folder: rancher-backup
      region: us-phoenix-1
  resourceSetName: rancher-resource-set

The operator creates the backup file, in the *.tar.gz format, and stores it in the location configured in the storageLocation field.

Scheduled backups

Similar to Velero, rancher-backup allows scheduled backups.

OpenSearch backup

For OpenSearch, Verrazzano provides a custom hook that you can use along with Velero while invoking a backup. Due to the nature of transient data handled by OpenSearch, the hook invokes OpenSearch snapshot APIs to back up and restore data streams appropriately, thereby ensuring that there is no loss of data and avoids data corruption as well.

The following example shows a sample Velero Backup API object that you can invoke to make an OpenSearch backup.

kind: Backup
  name: verrazzano-opensearch-backup
  namespace: verrazzano-backup
    - verrazzano-system
      verrazzano-component: opensearch
  defaultVolumesToRestic: false
  storageLocation:  verrazzano-backup-location
      - name: opensearch-backup-test
          - verrazzano-system
          - exec:
              container: es-master
                - /usr/share/opensearch/bin/verrazzano-backup-hook
                - -operation
                - backup
                - -velero-backup-name
                - verrazzano-opensearch-backup
              onError: Fail
              timeout: 10m

The preceding example backs up the OpenSearch components:

  • In this case, you are not backing up the PersistentVolumes directly, rather executing a hook that invokes the OpenSearch APIs to take a snapshot of the data.
  • So that Velero ignores the associated PVC’s, defaultVolumesToRestic needs to be false.
  • In this case, the hook can be pre or post.
  • The command used in the hook requires an operation flag and the Velero backup name as an input.
  • The container on which the hook needs to be run is identified by the pod label selectors, followed by the container name. In this case, it’s vmi-system-es-master-0.

After the backup is processed, you can see the hook logs using the velero backup logs command. Additionally, the hook logs are stored under the /tmp folder in the pod.

OpenSearch backup logs
# To display the logs from the backup, run the following command
$ kubectl logs -n verrazzano-backup -l

# Fetch the log file name as shown
$ kubectl exec -it vmi-system-es-master-0 -n verrazzano-system -- ls -al /tmp | grep verrazzano-backup-hook | tail -n 1 | awk '{print $NF}'

# To examine the hook logs, exec into the pod as shown, and use the file name retrieved previously
$ kubectl exec -it vmi-system-es-master-0 -n verrazzano-system -- cat /tmp/<log-file-name>

Scheduled backups

Velero supports a Schedule API that is a repeatable request that is sent to the Velero server to perform a backup for a given cron notation. After the Schedule object is created, the Velero server will start the backup process. Then, it will wait for the next valid point in the given cron expression and run the backup process on a repeating basis.