View the topology of a tenant

OceanBase Cloud Platform (OCP) provides a topology diagram that allows you to view the distribution of tenant replicas in a cluster.

Prerequisites

• To view information about clusters, arbitration services, zones, and OBServer nodes in the topology, make sure that you have the following permissions:

  • Resource Permissions : Cluster Read-only or Tenant Read-only permission
  • Menu Permissions : Permission on the Topology menu of Tenants

• To modify the zone priorities, replica type, resource pool of a tenant, add a replica, or delete a replica, make sure that you have the following permissions:

  • Resource Permissions : Cluster Maintenance or Tenant Maintenance permission
  • Menu Permissions : Permission on the Topology menu of Tenants

Procedure

1. Log in to the OCP console.

2. Click Tenants in the left-side navigation pane. In the Tenants list, select the target tenant to go to its Overview page.

3. On the left side of the page, click the topology to go to the Tenant Topology tab.

   You can click the icons in the upper-right corner of the canvas to resize and refresh the topology.

   The topology consists of four layers:

   • The first layer indicates the cluster.

   • The second layer indicates the tenant arbitration service.

   • The third layer indicates the zones.

   • The fourth layer indicates the OBServer nodes.

   Note

   The tenant arbitration service layer is displayed only when the arbitration service is enabled for the tenant.

Cluster

The cluster icon displays the name and status of the cluster to which the tenant belongs.

Click the More icon on the right of the cluster icon to view supported operations.

• Click View Cluster to display the cluster topology on a new page.

• Click Modify Zone Priority of Tenant to modify the zone priorities in the dialog box that appears.

Tenant arbitration service

The endpoint and status of the tenant arbitration service are displayed next to the cluster arbitration service icon.

Hover the pointer over the tenant arbitration service icon to view the detailed endpoint of the service and whether the service is enabled for the tenant.

Zone

The name and status of the zone are displayed next to the zone icon.

If a zone contains a tenant replica, the zone icon is displayed in purple with the initial of the replica type next to the tenant name. Otherwise, the zone icon is in gray.

• Zones with replicas

  • When you hover the pointer over a zone icon, a tooltip appears and displays the type of the replica and the number of units in the zone.

    

  • Click the More icon on the right of the zone icon to view supported operations.

    

    • Click Change Replica Type and change the replica type in the dialog box that appears.

      Note

      • You cannot change the Read-only Columnstore Replica type to other types.
      • You cannot change the Full-featured Replica or Read-only Replica type to the Read-only Columnstore Replica type.
      • For more information about replica types, see Create a tenant.

    • Click Modify Resource Pool and modify the resource pool of the zone in the dialog box that appears.

      Note

      For more information about the unit specifications and number of units, see Create a tenant.

      

    • Click Delete Replica . In the dialog box that appears, click Delete to delete the replica.

      Note

      The data of a deleted replica cannot be restored. Proceed with caution.

      

• Zones without a replica

  1. Click the More icon on the right of the zone icon to view supported operations.

  2. Click Create Replica and add a new replica in the dialog box that appears. For more information about the parameters, see Add a replica.

OBServer node

The IP address and current status of an OBServer node are displayed next to the node icon.

If an OBServer node hosts a resource unit of the tenant, the node icon is displayed in green. Otherwise, the node icon is in gray.