Manage UnionStore

Note

The UnionStore page is only available when enable-union-store is set to true in the deployment configuration. For details, see Deploy SynxDB Cloud.

Platform administrators use the UnionStore page in the DBaaS Admin Console to view and manage the deployment and configuration of UnionStore clusters across cloud environments. This page helps users answer questions such as:

• Which Kubernetes clusters have UnionStore deployed?

• What specifications are used by each UnionStore component?

• How are UnionStore resources distributed across regions and clusters?

UnionStore is the storage engine in SynxDB Cloud that supports decoupled compute and storage, based on a log-structured, multi-versioned page access architecture. It enables high-performance storage with strong consistency by coordinating three types of components: Storage Broker, Safe Keeper, and Page Server.

To access the Union Store page, click Union Store in the left navigation menu of the DBaaS Admin Console. On this page, the center panel displays a tree-structured view of the current SynxDB Cloud infrastructure. This hierarchy includes:

• Cloud level (for example, op)

• Region level (for example, default)

• Kubernetes cluster level (for example, alauda-1)

• UnionStore instance level (for example, system-unionstore)

By expanding each layer, you can explore where UnionStore is deployed and view basic configuration details. Selecting a UnionStore node shows the resource specifications (CPU, memory) of its internal components directly below, helping you quickly assess current deployment configurations.

As a platform administrator, you can create, reconfigure, or delete UnionStore instances directly from the infrastructure view. Each UnionStore is associated with a specific Kubernetes cluster and must be configured with appropriate component specifications.

Create a UnionStore instance

To deploy a new UnionStore instance for a Kubernetes cluster:

1. On the Union Store page, locate the infrastructure tree in the center pane.

2. Hover over the desired Kubernetes cluster node.

3. Click the + icon that appears next to the cluster name.

4. In the Create Union Store dialog:

   • Enter a unique name for the UnionStore.

   • Select a Bucket to associate with this UnionStore.

     • To use a Delegated Bucket (created by the DBaaS Admin Console), ensure the Undelegated Bucket toggle is turned off.

     • To use an Undelegated Bucket (pre-registered by you), turn on the Undelegated Bucket toggle and select the bucket from the dropdown list.

   • Select a predefined resource specification for each component:

     • Storage Broker

     • Safe Keeper

     • Page Server

   These specifications must be defined beforehand in the Profile > Union Store section.

5. Click OK to confirm and begin provisioning the UnionStore instance.

Edit an existing UnionStore instance

You can update the resource configurations of a deployed UnionStore by selecting different component specifications.

1. In the infrastructure tree, hover over the target UnionStore instance.

2. Click the Edit icon.

3. In the Edit Union Store dialog, choose updated specifications for:

   • Storage Broker

   • Safe Keeper

   • Page Server

4. Click OK to save the changes.

Delete a UnionStore instance

To remove a UnionStore deployment:

1. In the infrastructure tree, hover over the target UnionStore instance.

2. Click the Delete icon that appears.

3. Confirm the deletion in the dialog.

Warning

This operation is irreversible. Ensure no active workloads depend on the UnionStore before deletion.