Manage Regions, Object Storage, and Kubernetes Clusters

The DBaaS Admin Console provides a centralized interface for platform administrators to configure and manage the core infrastructure components required by SynxDB Cloud. This includes regions, object storage (OSS), and Kubernetes clusters. Properly configuring these resources is a foundational step for operating SynxDB Cloud.

This document provides a background on these concepts. The subsequent sections will provide detailed instructions on how to perform management tasks.

Manage regions

A region is a top-level logical grouping for your SynxDB Cloud deployment’s resources. It associates a specific geographic area or data center with the compute and storage resources it contains. Each region is linked to an object storage configuration and contains one Kubernetes cluster. The DBaaS Admin Console simplifies the process of creating, viewing, modifying, and deleting regions.

Note

Currently, the platform only supports a single region, and each region can only contain a single Kubernetes cluster. Attempting to create more will result in an error.

Access the region management page

  1. Log into the DBaaS Admin Console.

  2. In the left navigation pane, click Fundamental Config > Region.

View and search for existing regions

The Region page displays a list of all configured regions. For each region, the list provides details such as its Name, Vendor, Endpoint, associated OSS Region, and Created timestamp.

To find a specific region, use the filter fields at the top of the page:

  • Enter a region name in the Name field (supports fuzzy search).

  • Select a Vendor from the dropdown list.

After setting the filters, click Query to apply them. To clear the filters and view all regions, click Reset.

Create a region

Before creating a region, ensure that you have already configured an OSS Region to associate with it. If not, create one first. See Manage object storage.

  1. On the Region page, click + Create Region in the upper-right corner.

  2. In the Create Region dialog, fill in the required fields, such as the region name, vendor, and endpoint.

  3. Select an existing OSS Region to link with this region.

  4. Click Confirm to create the region.

Edit a region

You can modify the configuration of an existing region.

  1. In the region list, locate the region you want to edit.

  2. Click Edit in the Operation column.

  3. In the dialog, update the fields as needed.

  4. Click OK to save the changes.

Delete a region

Warning

This action is irreversible and will permanently remove the region configuration. Ensure that the region is no longer in use before deleting it.

  1. In the region list, locate the region you want to delete.

  2. Click Delete in the Operation column.

  3. Confirm the deletion in the pop-up dialog.

Manage object storage

SynxDB Cloud relies on object storage for persisting data. The DBaaS Admin Console allows you to manage the connection details for your object storage provider. This is done through two main configurations:

  • OSS region: Defines the basic connection information for an object storage endpoint, such as the vendor, endpoint URL, and region name.

  • OSS region configuration: Manages the authentication credentials (like access key ID and secret) required to access the object storage. These configurations can be shared across the platform or assigned to specific organizations to enforce security and isolation.

Tip

SynxDB Cloud supports two types of buckets for data storage:

  • Delegated bucket: The lifecycle of the bucket is fully managed by the DBaaS Admin Console. The platform handles the creation and deletion of these buckets.

  • Undelegated Bucket: The bucket is created and managed by the user outside of the DBaaS Admin Console (for example, directly through the cloud provider’s console). To use a undelegated bucket in SynxDB Cloud, you need to create a bucket with the same name in the DBaaS Admin Console’s Bucket management page. When creating an account or UnionStore, if you select a undelegated bucket, the system will use the existing bucket instead of creating a new one.

For details, see Manage buckets.

Manage OSS regions

Access the OSS region management page

  1. Log into the DBaaS Admin Console.

  2. In the left navigation pane, click Fundamental Config > OSS Region.

View and search for existing OSS regions

The OSS Region page displays a list of all configured OSS regions. For each entry, the list provides details such as its Name, Vendor, Public Region, Internal Region, Endpoint, and Created timestamp.

To find a specific OSS region, use the filter fields at the top of the page:

  • Enter a name in the Name field (supports fuzzy search).

  • Select a Vendor from the dropdown list.

After setting the filters, click Query to apply them. To clear the filters, click Reset.

Create an OSS region

After creating an OSS region, you must also create an associated OSS region configuration that contains the necessary authentication credentials. See Manage OSS region configurations.

  1. On the OSS Region page, click + Create OSS Region in the upper-right corner.

  2. In the Create OSS Region dialog, fill in the following fields:

    • Name: A unique name for the OSS region.

    • Vendor: Select the object storage provider (for example, AWS).

    • Internal Region: The internal region name for the object storage.

    • Public Region: (Optional) The public region name. For BYOC (Bring Your Own Cloud) and On-Premises deployments, this field should be left blank.

    • Signature Version: Select the appropriate signature version for authentication.

    • Endpoint: The connection endpoint URL for the object storage.

    • Virtual Host: Enable this toggle if you are using a virtual host-style endpoint.

  3. Click Confirm to create the OSS region.

Edit, delete, or test an OSS region

In the OSS region list, locate the entry you want to manage and perform one of the following actions in the Operation column:

  • Edit: Click Edit to open a dialog where you can modify the OSS region’s configuration details. Click Confirm to save the changes.

  • Delete: Click Delete and confirm the action in the pop-up dialog to permanently remove the OSS region.

  • Test: Click Test to verify the connectivity to the object storage endpoint. This requires an appropriate OSS region configuration to be in place.

Manage OSS region configurations

An OSS region configuration stores the authentication credentials (such as access key and secret) required to connect to an object storage service. Each configuration is associated with a specific OSS region.

Access the OSS region configuration management page

  1. Log into the DBaaS Admin Console.

  2. In the left navigation pane, click Fundamental Config > OSS Region Config.

View and search for existing OSS region configurations

The OSS Region Config page displays a list of all configured credentials. For each entry, the list provides details such as the associated OSS Region, Access Key ID, linked Organization (if any), and Created timestamp.

To find a specific configuration, use the filter fields at the top of the page:

  • Select an OSS Region from the dropdown list.

  • Select an Organization from the dropdown list.

After setting the filters, click Query to apply them. To clear the filters, click Reset.

Create an OSS region configuration

  1. On the OSS Region Config page, click + Create OSS Region Config in the upper-right corner.

  2. In the Create OSS Region Config dialog, fill in the following fields:

    • OSS Region: Select the OSS region to which these credentials belong.

    • Access Key ID: Enter the access key ID for your object storage account.

    • Access Key Secret: Enter the corresponding secret access key.

    • Organization: (Optional) If you want to dedicate these credentials to a specific organization, select it from the dropdown list. If left blank, these credentials will be shared.

  3. Click Confirm to save the configuration.

Edit, delete, or test an OSS region configuration

In the OSS region configuration list, locate the entry you want to manage and perform one of the following actions in the Operation column:

  • Edit: Click Edit to open a dialog where you can update the configuration details. Click Confirm to save the changes.

  • Delete: Click Delete and confirm the action in the pop-up dialog to permanently remove the configuration.

  • Test: Click Test to validate the credentials by attempting to connect to the object storage service.

Manage Kubernetes clusters

Kubernetes clusters provide the compute resources for running SynxDB Cloud services, such as UnionStore and FoundationDB. Within the DBaaS Admin Console, Kubernetes clusters are registered and managed under a specific region. This allows you to track where your compute resources are located and manage their lifecycle (creation, viewing, modification, and deletion).

Access the Kubernetes cluster management page

  1. Log into the DBaaS Admin Console.

  2. In the left navigation pane, click Fundamental Config > K8s Cluster.

View and search for existing Kubernetes clusters

The K8s Cluster page displays a list of all registered Kubernetes clusters. For each cluster, the list provides details such as its Cluster Name, associated Region, whether it is the Default Cluster, and its Created timestamp.

To find clusters in a specific region, select the Region from the dropdown list at the top of the page and click Query. To clear the filter, click Reset.

Create a Kubernetes cluster

Before creating a cluster, ensure that you have already configured a Region to associate it with. See Manage regions.

  1. On the K8s Cluster page, click + Create Cluster in the upper-right corner.

  2. In the Create Cluster dialog, fill in the following fields:

    • Name: A unique name for the Kubernetes cluster.

    • Region: Select the region where this cluster is located.

    • Enabled: Use the toggle to set the cluster as active or inactive upon creation.

  3. Click Confirm to register the cluster.

Delete a Kubernetes cluster

Warning

This action is irreversible and will permanently remove the cluster registration from the DBaaS Admin Console. It does not delete the actual Kubernetes cluster.

  1. In the cluster list, locate the cluster you want to remove.

  2. Click Delete in the Operation column.

  3. Confirm the deletion in the pop-up dialog.