ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

You're viewing documentation for a previous version of Scylla Manager. Switch to the latest stable version.

Scylla Manager Backup Setup S3 compatible storage

Setup S3 compatible storage¶

  • Create a bucket

  • Grant access

    • Policy

    • Config file

  • Troubleshoot connectivity

There are multiple S3 API compatible providers that can be used with Scylla Manager. Due to minor differences between them we require that exact provider is specified in the config file for full compatibility. The available providers are Alibaba, AWS, Ceph, DigitalOcean, IBMCOS, Minio, Wasabi, Dreamhost, Netease.

Create a bucket¶

You need to create a bucket in your storage system of choice.

Grant access¶

This procedure is required so that Scylla Manager can access your bucket. You need to configure bucket access policy in your storage system and set credentials in the Scylla Manager Agent config file.

Policy¶

The user must have list, read, write and delete privileges to the bucket, for specifics consult the sample AWS IAM policy.

MinIO Example¶

With MinIO you can use the the same policy files as with AWS.

Procedure

Given myminio is an alias for your MinIO deployment.

  1. Create a user by providing access and secret keys.

    mc admin user add myminio "${MINIO_USER_ACCESS_KEY}" "${MINIO_USER_SECRET_KEY}"
    
  2. Copy the sample AWS IAM policy as user-policy.json.

  3. Replace scylla-manager-backup in user-policy.json with your bucket name.

  4. Create a user policy.

    mc admin policy add myminio sm-user-policy user-policy.json
    
  5. Attach the policy to the user.

    mc admin policy set myminio sm-user-policy user="${MINIO_USER_ACCESS_KEY}"
    

Config file¶

Note that this procedure needs to be repeated for each Scylla node.

Procedure

Edit the /etc/scylla-manager-agent/scylla-manager-agent.yaml

  1. Uncomment the s3: line, for parameters note the two spaces in front, it’s a yaml file.

  2. Uncomment and set access_key_id and secret_access_key.

  3. Uncomment and set provider to one of the supported providers.

  4. Uncomment and set endpoint to the base URL of your storage.

  5. Validate that the manager has access to the backup location. If there is no response, the S3 bucket is accessible. If not, you will see an error.

    scylla-manager-agent check-location --location s3:<your S3 bucket name>
    

MinIO Example¶

s3:
  access_key_id: AKIAIOSFODNN7EXAMPLE
  secret_access_key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
  provider: Minio
  endpoint: http://192.168.121.99:9000

Troubleshoot connectivity¶

To troubleshoot Node to bucket connectivity issues you can run:

scylla-manager-agent check-location --debug --location s3:<your S3 bucket name>
PREVIOUS
Setup AWS S3
NEXT
Setup Google Cloud Storage
  • 2.5
    • master
    • 3.0
    • 2.6
    • 2.5
    • 2.4
    • 2.3
    • 2.2
  • Docker
  • Install Scylla Manager
  • Install Scylla Manager Agent
  • Add a Cluster
  • Backup
    • Setup AWS S3
    • Setup S3 compatible storage
    • Setup Google Cloud Storage
    • Setup Azure Blob Storage
    • Examples
    • Specification
  • Restore
    • Download files command
  • Repair
    • Repair faster
    • Repair slower
    • Examples
  • Health Check
  • CLI sctool
    • Global flags and variables
    • Cluster
    • Backup
    • Repair
    • Status
    • Suspend & Resume
    • Task
    • Version
  • Configuration Files
    • Scylla Manager Config
    • Scylla Manager Agent Config
  • Swagger File
  • Scylla Monitoring
  • Troubleshooting
  • Older Versions
  • Slack
  • Create an issue
  • Edit this page

On this page

  • Setup S3 compatible storage
    • Create a bucket
    • Grant access
      • Policy
        • MinIO Example
      • Config file
        • MinIO Example
    • Troubleshoot connectivity
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 15 February 2023.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.3.4