Cloud Providers

Cloud providers

ClusterControl supports integration with S3‐compatible storage solutions from multiple providers:

• Amazon Web Services (AWS)
• Google Cloud (via Google Cloud Storage)
• Microsoft Azure (via an S3‐compatible interface or directly via credentials)
• Other S3‐Compatible storage providers (e.g., MinIO, DigitalOcean Spaces, OpenStack, etc.)

Once configured, you can use S3 storage as an offsite storage for backups created by ClusterControl.

Prerequisites

1. Appropriate Access Credentials
   • AWS: Access key ID and secret access key.
   • Google Cloud: Service account JSON key file.
   • Microsoft Azure: Service principal credentials, or an S3‐compatible credential file (depending on your configuration).* Other S3 Providers: Typically an access key, secret key, region, and a custom endpoint.
2. Correct Region or Endpoint
   • AWS: Region selection (e.g., eu-west-2).
   • Google Cloud: Not strictly a region input—this is handled by the JSON credentials.
   • Azure: May require an endpoint or rely on the JSON credentials if you have an S3‐compatible gateway set up.
   • Other S3: Custom endpoint (e.g., https://nyc3.digitaloceanspaces.com), plus region if required.
3. Permissions in the Platform
   • Ensure you have privileges to create/edit integrations.

Creating a New S3 Integration

Access the Integrations Section

1. In ClusterControl, navigate to the Settings→Cloud storage credentials section. There is an option to Add cloud storage credentials.

2. Click Add cloud storage credentials. You will see a list of supported providers:

   • Amazon Web Services
   • Google Cloud
   • Microsoft Azure
   • S3 Compatible storage provider

3. Select the one you want to use.

Setting up Amazon Web Services S3

1. Select “Amazon Web Services”.
2. Enter Credentials in the Authentication step:
   • Name: A descriptive label, e.g. My AWS Integration.
   • AWS key ID: Your AWS access key ID.
   • AWS key secret: Your AWS secret access key.
   • Default region: Choose your primary region, e.g. [eu-west-2] EU (London).
   • Comment: Optional internal notes (e.g., AWS integration).
3. Click Continue to move to the Preview screen.
4. Review the details (key ID, region, etc.) and click Finish to create the integration.

Setting up Google Cloud

1. Select Google Cloud. 2. Enter Credentials in the Authentication step:

• Name: Enter a descriptive label, e.g. Google Cloud Integration.
• Comment: Optional internal description.
• Read from JSON file: Click the Click to Upload button to browse for and upload your Google Cloud service account JSON file.

This JSON file contains the keys and project info needed to authenticate with Google Cloud Storage. For details on creating this JSON file, see the Google Cloud documentation on service accounts.

1. Click Continue to view the Preview screen.
2. Verify the integration name and any other details you entered. If correct, Click Finish to save the integration.

Setting up Microsoft Azure

1. Select “Microsoft Azure” from the provider list.

2. Enter Credentials in the Authentication step:

   • Name: e.g. Azure Integration.
   • Comment: e.g. Azure integration for S3 storage.
   • Read from JSON file: Upload your Azure credential JSON.

   The contents and format of this file depend on your Azure setup. It may include your storage account, tenant ID, client ID, secret, etc.

3. Click Continue, then Preview the integration details.

4. Verify the integration name and any other details you entered. If correct, Click Finish to save the integration.

Tip

If you are using an S3‐compatible gateway for Azure (like Blob storage with S3 proxy), you might instead follow the Other S3 steps and provide the custom endpoint, access key, and secret that the gateway supplies.

Setting up Other S3‐Compatible Providers

Select “S3 Compatible storage provider” if your preferred provider is not explicitly listed. This covers services like MinIO, DigitalOcean Spaces, OpenStack etc.

1. Select "S3 Compatible storage provider" from the provider list. 2. Enter required data in the Authentication step: * Name: e.g. My MinIO Integration. * Endpoint: The HTTPS URL of your service (e.g. https://nyc3.digitaloceanspaces.com). * Access Key: The access key from your S3‐compatible account. * Secret Key: The secret key from your S3‐compatible account. * Region: If your provider requires a specific region name (e.g. us-east-1, us-central), enter it here. Not all providers strictly require it. * Comment: Optional notes about this integration. * Use SSL: On by default. If your provider uses SSL, keep it on. Otherwise, switch to “Off” or “Insecure SSL” if you must connect insecurely (not recommended). 3. Click Continue, then Preview the integration details. 4. Verify the integration name and any other details you entered. If correct, Click Finish to save the integration.

Modifying existing integrations

Once you’ve created an integration (AWS, Google Cloud, Azure, or Other S3), it will appear in your Integrations list.

If you encounter issues, check:

• Credentials: Are the keys and secrets correct (no typos)?
• Endpoint/Region: Did you select the correct region or endpoint for your service?
• Permissions: Does your IAM policy, its equivalent or service account allow read/write access?
• File Format: For Google Cloud and Azure, verify the JSON file you uploaded is the correct one for authentication.