Overview

Click Tenant Management in the left-side navigation pane to go to the Tenant Management page. Click the name of a tenant in Tenants to go to the Overview page of the tenant. This topic describes the information and the operations that you can perform on the Overview page.

Basic information

The Basic Information section displays the tenant mode, character set, lock status, creation time, connection string, and OceanBase Database version number of the cluster where the tenant resides.

You can click next to Connection String to copy the connection string for future reference; click the icon next to Lock to modify the tenant's lock status. Select the desired lock status and click OK. Locking a tenant prevents users from accessing that tenant, so use this feature with caution.

Replica details

The Replica Details page displays the Zone Name, Replica Type, Unit Specifications, and Units of the replica. You can modify the unit specification and delete the replica.

• Modify unit specification

  Click Edit in the Actions column to modify the unit specification of the corresponding replica. The configurable range is displayed under the corresponding unit configuration. Set values within the range, click OK in the Actions column, and confirm the change to modify the current unit specification.

  You can also click Modify Unit in the upper-right corner of the Replica Details section to modify the number and specification of units in all zones. After the modification, click OK. OB-Dashboard generates a task to modify units in batches. You can click View Tasks to view the task execution details.

• Delete a replica

  Click Delete in the Actions column. In the window that appears, click Delete. OB-Dashboard generates a task to delete the replica. You can click View Tasks to view the task execution details.

  You can also select the check boxes before different zones to delete multiple replicas in batches. Click Batch Delete, and then click Delete in the window that appears. OB-Dashboard generates a task to delete replicas in batches. You can click View Tasks to view the task execution details. After you select replicas, you can click Clear Selection to deselect all replicas.

  Notice

  Deleted replica data cannot be recovered. Proceed with caution.

Zone priority

The Primary Zone section displays the priority of distributing the leader replicas for the tenant. You can click Modify on the right side of the section to modify the zone priority for the tenant.

The zone with the highest priority is considered the primary zone, and only one primary zone is allowed. If no priority is specified, the first zone is assigned the highest priority by default. The priority is determined as follows:

1. Select one or more zones from the left-side list. The left-side list shows all available zones in the current cluster.

2. Click the > button in the middle. The selected zones are then moved to the Priority list. If multiple zones are selected at the same time, they are assigned the same priority.

3. Perform steps 1 and 2 again to add zones with lower priorities.

4. You can drag zones in the Priority list to change their order. The priority decreases from top to bottom in the list.

5. Click the delete button next to a zone or click Reset Settings to move the zone from the Priority list back to the left-side list.

After you modify the zone priority, click OK. OB-Dashboard generates a task for the priority modification, and you can click View Tasks to view the task progress.

Allowlist

The Whitelist section displays the list of addresses that can connect to the tenant. You can click Modify on the right side of the section to modify the allowlist.

You can specify allowed client IP addresses or allow all IP addresses. When you customize the allowlist, you can enter client IP addresses in the input box next to Custom IP Address. You can press the Enter key or enter a comma (,) to add more IP addresses. When you move the pointer over View Configuration Instructions, you can view the instructions for configuring IP addresses. The following formats are supported:

• IP address. Example: 127.0.0.10,127.0.0.11

• Subnet/mask. Example: 127.0.0.0/24

• Fuzzy match. Example: 127.0.0.% or 127.0.0._

• Mixed formats. Example: 127.0.0.10,127.0.0.11,127.0.0.%,127.0.0._,127.0.0.0/24

Major compaction management

The Major Compaction Management section displays the tenant's Status, start time of the last major compaction, and end time of the last major compaction. Click Initiate Major Compaction next to Status. In the window that appears, click OK to initiate a major compaction.

Add a replica

Click the Create Replica button in the upper-right corner of the Overview page. In the window that appears, configure the replica information. After the configuration is complete, click OK. OB-Dashboard generates a task for creating the replica. You can click View Tasks to view the task details.

Delete a tenant

Click the Delete Tenant button in the upper-right corner of the Overview page. In the window that appears, enter delete and click Delete. OB-Dashboard generates a task for deleting the tenant. You can click View Tasks to view the task details.