Manage object storage configurations

OceanBase Cloud allows you to centrally create and manage object storage configurations at the project level. Features that deliver logs to your object storage can reference existing configurations. This topic describes how to manage object storage configurations for a project.

Background

Several OceanBase Cloud features deliver logs to your own object storage. If you enter a bucket and access credentials separately for each feature, you must maintain the same credentials multiple times within a project and update each feature separately when you rotate the credentials.

OceanBase Cloud therefore provides centralized object storage configuration management at the project level. You can create a configuration once and reference it from any feature that uses object storage, without entering the bucket and access credentials again. When you rotate credentials, you need to update only the configuration. All features that reference the configuration automatically use the new credentials.

Limitations

• An object storage configuration is a project-level resource. It is visible and can be referenced only within its project. You must create separate configurations for different projects in the same organization.

• Only Project Admins and users with project configuration permissions can create, modify, and delete object storage configurations.

• OceanBase Cloud currently supports Alibaba Cloud OSS, AWS S3, and Azure Blob Storage.

• After you create a configuration, you cannot modify its Storage service provider, Region, or Bucket name. To change any of these settings, create a new configuration.

• You cannot delete a configuration that is referenced by a feature.

• Individual features may impose additional requirements on the configurations that they can reference. For example, SQL Audit can reference only a valid configuration whose cloud provider and region match those of the cluster.

Add an object storage configuration

1. Log in to the OceanBase Cloud console.

2. In the organization drop-down list in the upper-left corner, click the name of the target organization.

3. Locate the target project in the project list. In the Actions column, click Configure project.

4. On the Project settings page, click the Data delivery destinations tab.

5. On the Object storage tab, click Add object storage configuration.

6. Configure the following parameters in the dialog box:

   Parameter	Description
   Name	Enter a name that identifies the configuration to other features. The name must be 2 to 64 characters in length and can contain only Chinese characters, digits, English letters, underscores, and hyphens. The name must be unique within the project. You can modify it after you create the configuration.
   Storage service provider	Select the cloud provider of the object storage. Valid values are Alibaba Cloud OSS, AWS S3, and Azure Blob Storage. You cannot modify the provider after you create the configuration.
   Region	Enter the region where the object storage resides, such as cn-hangzhou. You cannot modify the region after you create the configuration.
   Endpoint	The system automatically generates the endpoint based on the selected storage service provider and the specified region. You do not need to enter it.
   Bucket name	Enter the name of the bucket used to store data. For Azure Blob Storage, enter the container name. You cannot modify the name after you create the configuration. Add the OceanBase Cloud CIDR block 100.64.0.0/10 to the allowlist of the bucket. Otherwise, log delivery fails because of insufficient permissions.
   Access Key ID	Enter a valid Access Key ID. To learn how to obtain one, click How to get it to the right of the field, or see Manage AccessKeys.
   Access Key Secret	Enter the secret that corresponds to the Access Key ID.

7. Click Test connection to verify the configuration.

   The connection test verifies that all required fields are complete, the configuration name is unique, the bucket exists, the bucket is in the specified region, and the access credentials are valid. It also writes a probe object to the bucket to verify write permissions.

   Common causes of failure include invalid credentials, a nonexistent bucket, a region mismatch, insufficient write permissions, and an unreachable network.

   While the connection test is in progress, all configuration fields are disabled. After the test succeeds, the button indicates success and starts a five-second countdown. When the countdown ends, the button returns to Test connection. If the test fails, an error message immediately appears at the bottom of the form.

8. Click Save to create the configuration.

   Note

   When you save the configuration, OceanBase Cloud runs the connection validation again. You cannot save the configuration if the validation fails.

View object storage configurations

On the Data delivery destinations tab, click the Object storage tab to view and manage the configurations in the current project. The list displays the name, storage service provider, region, additional information, number of references, connection status, and update time of each configuration.

You can search for configurations by name, region, or bucket name, and filter them by storage service provider and status.

Modify an object storage configuration

In the Actions column of the target configuration, click Edit. You can modify its Name and access credentials.

• Modifying only the configuration name does not affect log delivery. Features that reference the configuration display the new name.

• To modify the access credentials, enter both a new Access Key ID and a new Access Key Secret, and then pass the connection test again. After you save the configuration, features that reference it use the new credentials.

• You cannot modify the Storage service provider, Region, or Bucket name.

Delete an object storage configuration

In the Actions column of the target configuration, click Delete to delete the configuration.

• You cannot delete a configuration that is being referenced. The page displays the number of references and the features that reference the configuration. You must remove the references in those features before deleting the configuration. For example, change the storage destination for SQL Audit to another storage service or configuration.

• Deleting a configuration does not delete historical files from object storage. Manage file retention, archiving, and cleanup in the object storage service.

• After you delete a configuration, you can reuse its name.