Creating Backups on S3 Compatible Services

This section describes how to back up a9s Search to Amazon AWS S3 or any other S3-compatible service.

Prerequisites

• URL to the S3 endpoint (AWS, Minio, Wasabi...)
• access_key
• secret_key

Configuring the Backup Service

To configure the S3 endpoint as a backup destination, edit the opensearch-backup property in the anynines-backup-manager section of the corresponding a9s Data Service deployment manifest. The configuration should look like this:

...
opensearch-backup:
  aws_access_key_id: <some_access_key>
  aws_secret_access_key: <some_secret_key>
  container: <your_container>
  endpoint: <some.endpoint.s3.domain>
  name:
    backup: opensearch-backup
    restore: opensearch-restore
  provider: AWS
...

In general, only the above values need to be replaced with the keys and values of the S3 service. However, if difficulties are encountered with the default configuration, see the next section.

virtual hosted_style vs. path_style_access

It might be that the container is only available via the path_style_access (Amazon AWS Documentation). If so, this line must be added to the opensearch-backup: configuration:

...
path_style: true
...

info

Please note that for all a9s Search Service Instances, backup sizes are displayed as 0 B in the backup metadata. This is expected behavior due to the nature of the snapshot process and does not indicate a backup failure or data loss.

Deprecation Warning

The path_style setting is only viable for a9s Search 2. Additionally, note that path_style_access is deprecated (see the Amazon AWS Documentation), so reconfiguring S3 access is generally recommended for any deployment still using path_style_access.