OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history
×

Integrating with Amazon S3

You can integrate Red Hat Advanced Cluster Security for Kubernetes with Amazon S3 to enable data backups. You can use these backups for data restoration in the case of an infrastructure disaster or corrupt data. After you integrate with Amazon S3, you can schedule daily or weekly backups and do manual on-demand backups.

The backup includes the entire Red Hat Advanced Cluster Security for Kubernetes database, which includes all configurations, resources, events, and certificates. Make sure that backups are stored securely.

  • If you are using Red Hat Advanced Cluster Security for Kubernetes version 3.0.53 or older, the backup does not include certificates.

  • If your Amazon S3 is part of an air-gapped environment, you must add your AWS root CA as a trusted certificate authority in Red Hat Advanced Cluster Security for Kubernetes.

Configuring Amazon S3 integration in Red Hat Advanced Cluster Security for Kubernetes

To configure Amazon S3 backups, create a new integration in Red Hat Advanced Cluster Security for Kubernetes.

Prerequisites

  • An existing S3 Bucket. To create a new bucket with required permissions, see the Amazon documentation topic Creating a bucket.

  • Read, write, and delete permissions for the S3 bucket, the Access key ID, and the Secret access key.

  • If you are using KIAM, kube2iam or another proxy, then an IAM role that has the read, write, and delete permissions.

Procedure

  1. On the RHACS portal, navigate to Platform Configuration → Integrations.

  2. Scroll down to the External backups section and select Amazon S3.

  3. Click New Integration (add icon).

  4. Enter a name for Integration Name.

  5. Enter the number of backups to retain in the Backups To Retain box.

  6. For Schedule, select the backup frequency as daily or weekly and the time to run the backup process.

  7. Enter the Bucket name where you want to store the backup.

  8. Optionally, enter an Object Prefix if you want to save the backups in a specific folder structure. For more details, see the Amazon documentation topic Working with object metadata.

  9. Enter the Endpoint for the bucket if you are using a non-public S3 instance, otherwise leave it blank.

  10. Enter the Region for the bucket.

  11. Turn on the Use Container IAM Role toggle or enter the Access Key ID, and the Secret Access Key.

  12. Select Test (checkmark icon) to confirm that the integration with Amazon S3 is working.

  13. Select Create (save icon) to create the configuration.

Once configured, Red Hat Advanced Cluster Security for Kubernetes automatically backs up all data according to the specified schedule.

Performing on-demand backups on Amazon S3

Uses the RHACS portal to trigger manual backups of Red Hat Advanced Cluster Security for Kubernetes on Amazon S3.

Prerequisites

  • You must have already integrated Red Hat Advanced Cluster Security for Kubernetes with Amazon S3.

Procedure

  1. On the RHACS portal, navigate to Platform Configuration → Integrations.

  2. Under the External backups section, click Amazon S3.

  3. Select the integration name for the S3 bucket where you want to do a backup.

  4. Click Trigger Backup.

Currently, when you select the Trigger Backup option, there is no notification. However, Red Hat Advanced Cluster Security for Kubernetes begins the backup task in the background.

Additional resources