Overview

On the specific tenant overview page, you can delete a tenant, add a replica, change the password, lock a tenant, and copy a tenant. You can also view the basic information of the tenant and details of replicas, and modify the zone priorities and allowlist of the tenant.

OCP allows you to create associated primary and standby tenants in different clusters. When a tenant has a primary-standby relationship, note the following items:

• When you change the configurations of a tenant, the changes may affect the synchronization efficiency between the primary and standby tenants and the tenant performance. We recommend that you keep the configurations of the primary and standby tenants consistent.
• When the primary-standby synchronization method is network synchronization and the primary tenant does not enable log archiving, the risk of the primary tenant's redo logs not being promptly synchronized to the standby database and being overwritten exists. We recommend that you enable log archiving for the primary tenant.

Prerequisites

Make sure that the user who is logged in to the OCP console has the following permissions:

• Cluster Read-Only or Tenant Read-Only permissions.
• The Overview menu permissions.

View basic information

You can view the basic information about a tenant, including Tenant Name, Tenant ID, Cluster, OceanBase Version, OBProxy/Connection String, Binlog Service, Tag, Created At, Limitations, Remarks, Arbitration Service, Character Set, Collation, Load Type, Deployment Distribution, and Lock.

• Click the name of the cluster to which the tenant belongs to go to the cluster overview page. For more information, see Overview of the cluster details page.

• Click the copy icon next to the Tenant Name field to copy the tenant name.

• Click View next to OBProxy/Connection String. After the tenant's cluster is associated with the OBProxy, you can copy the connection string for connection.

• Click Add Service Name to add a service name. The service name must start with an English letter and can contain English letters, numbers, and underscores. It must be 2 to 64 characters long. You can also edit or delete the service name from the Actions drop-down list. For primary and standby tenants, you can also use Sync Service Names of Primary and Standby Tenants.

  Note

  • To configure a service name for the tenant, the OceanBase and OBProxy versions must meet the following requirements:
    • OceanBase: V4.2.1.9, [V4.2.4.0, V4.3.0.0), [V4.3.3.0, +∞)
    • OBProxy: [V4.3.1.0, +∞)
  • If the tenant has a primary/standby relationship, we recommend that you keep the service names of the primary and standby tenants consistent and associate the OceanBase clusters of the primary and standby tenants with the same OBProxy cluster. This way, your applications can automatically route traffic after the primary/standby tenant switches.
  • For more information about service names, see Manage service names.

• You can enable the Binlog service for the tenant. For more information, see Manage the Binlog service of a tenant.

• Hover the pointer over the tenant tag to view all the tags of the tenant. You can click the edit icon to manage the tags. For more information, see Manage tags.

• Click View next to the Limit field to view the resource usage limit of the tenant under the current specification. When the current value approaches the theoretical maximum, you must upgrade the tenant specification to avoid abnormal database behavior.

  Note

  The tenant's cluster must meet the following conditions to view the resource usage limit:

  • For V4.2.x, the version must be V4.2.4 or later.
  • For V4.3.x, the version must be V4.3.1 or later.

• Click the icon next to Remarks to modify the remarks.

• Click the icon next to the arbitration service to enable or disable the arbitration service.

  Note

  • When the tenant's cluster is a standalone edition of OceanBase Database, the arbitration service cannot be configured.
  • Before you enable the arbitration service, make sure that the following conditions are met:
    • The arbitration service is added to the tenant's cluster and is in the RUNNING state.
    • The tenant's locality is 2F (F: full feature replica) or 4F.
    • The remaining resources on the host where the arbitration service is located meet the resource requirements. You can modify the resource requirements in the system parameters. For more information, see Modify a system parameter.
      • ocp.arbitration.min.remain.disk.size: the minimum remaining CLOG disk space on the arbitration service host when the tenant arbitration service is enabled. Unit: MB. The data format (a,b) indicates the values for 2F and 4F tenant replicas respectively. Default value: [12,24].
      • ocp.arbitration.max.cpu.used.percentage: the maximum CPU usage on the arbitration service host when the tenant arbitration service is enabled. Unit: %. Default value: 90.
      • ocp.arbitration.max.memory.used.percentage: the maximum memory usage on the arbitration service host when the tenant arbitration service is enabled. Unit: %. Default value: 90.

For more information about other management operations on the tenant, see Delete a tenant, Create a replica, Change the password of the sys tenant, Rename a tenant, Lock a tenant, Replicate a tenant, Clone a tenant, and Configure end-to-end tracing.

View details of a replica

View the name of the zone, the type of the replica, the unit specification, and the unit quantity, and edit or delete the replica. For more information, see Edit a tenant replica in a private zone and Delete a tenant replica in a private zone.

View zone priorities

View or modify the priorities of the zones where the tenant's primary replicas are distributed. For more information, see Modify zone priorities.

View the allowlist

View or modify the list of addresses that can connect to the tenant. For more information, see Modify the allowlist.

Tenant management operations

You can perform daily management operations on tenants in the left-side navigation pane. For more information, see View the tenant topology, Manage tenant databases, Manage MySQL tenant users, Manage Oracle tenant users, View performance and SQL monitoring data, View transaction performance monitoring data, View storage and cache monitoring data, View OBKV_Table monitoring data, View OBKV_HBase monitoring data, Manage tenant resources, View SQL diagnostics, View transaction diagnostics, Manage major compactions of tenants, Manage tenant backup and restore, View the parameter list, and Manage tenant parameter templates.