Manage FoundationDB

Note

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

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

  • Which Kubernetes clusters have FoundationDB deployed?

  • What specifications are used by each FoundationDB component?

  • How are FoundationDB resources distributed across regions and clusters?

FoundationDB 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, Log, and Stateless.

To access the FoundationDB page, click FoundationDB 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)

  • FoundationDB instance level (for example, system-foundationdb)

By expanding each layer, you can explore where FoundationDB is deployed and view basic configuration details. Selecting a FoundationDB 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 FoundationDB instances directly from the infrastructure view. Each FoundationDB is associated with a specific Kubernetes cluster and must be configured with appropriate component specifications.

Create a FoundationDB instance

To deploy a new FoundationDB instance for a Kubernetes cluster:

  1. On the FoundationDB 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 FoundationDB dialog:

    • Enter a unique name for the FoundationDB.

    • Select a Bucket from the dropdown menu. This bucket will be used for automatic backups. Ensure you have created a bucket in the Buckets page first (refer to Manage Buckets).

    If the bucket information (name or credentials) is incorrect, the instance creation might fail.

    • Select a predefined resource specification and enter the count for each component,

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

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

Edit an existing FoundationDB instance

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

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

  2. Click the Edit icon.

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

    • Stateless

    • Log

    • Storage

  4. Click OK to save the changes.

Delete a FoundationDB instance

To remove a FoundationDB deployment:

  1. In the infrastructure tree, hover over the target FoundationDB 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 FoundationDB before deletion.

View FoundationDB details

You can view the basic information, profile specifications, and backup details of a FoundationDB instance in the FoundationDB Details tab.

  1. In the infrastructure tree, select the target FoundationDB instance.

  2. The FoundationDB Details tab is displayed by default.

In the Backup Details section of this tab, you can monitor the status of automatic backups, including the Backup Name, Status, and Snapshot Interval.

View FoundationDB metrics

You can view detailed monitoring metrics for a FoundationDB instance in the FoundationDB Metrics tab.

  1. In the infrastructure tree, select the target FoundationDB instance.

  2. Click the FoundationDB Metrics tab in the right panel.

The FoundationDB Metrics tab displays the following metric categories:

  • General: Overview of the database status, including availability, health, lock status, and read latency.

  • Data: Storage usage statistics, such as total disk used, KV size, moving data details, and partition sizes.

  • Workload: Metrics related to database workload, including operations, transactions, data movement, and transaction conflicts.

  • Processes: System resource usage for FoundationDB processes, such as CPU, network traffic (received/sent), and disk I/O.

  • QOS: Quality of Service metrics, including queue sizes and transaction rates.

  • Latency Probe: Latency measurements for various database operations.

  • GRV: GetReadVersion (GRV) latency and counts.

  • Backups: Status and metrics related to FoundationDB backups.