On the details page of a specific tenant, you can perform operations such as deleting the tenant, adding replicas, changing the password, locking the tenant, and copying the tenant. You can also view the basic information of the current tenant, as well as view replica details, modify zone priorities, and manage allowlists.
OCP supports creating primary and standby tenants associated with each other across different clusters. When a tenant has a primary-standby relationship, note the following:
- When you modify tenant configurations, the changes may affect the synchronization efficiency between the primary and standby tenants and the performance of the tenants. It is recommended to keep the configurations of the primary and standby tenants consistent.
- When the synchronization mode between the primary and standby tenants is set to Network Synchronization and log archiving is not enabled for the primary tenant, there is a risk that redo logs of the primary tenant may not be synchronized to the standby database in time and may be overwritten. It is recommended to enable log archiving for the primary tenant.
Prerequisites
Ensure the current OCP user has the following permissions:
- Cluster Read-Only or Tenant Read-Only resource permission.
- Permission to access the Overview menu.
View basic information
View tenant basic information, including Tenant Name, Tenant ID, Cluster, OceanBase Version Number, Compatibility Mode, Character Set, Collation, Load Type, Tenant Connection String, Binlog Service, Lock, Created At, Limitations, Remarks, Arbitration Service, and Tag.
Click the cluster name next to Cluster to go to the cluster overview page. For details, see Overview of the cluster details page.
Click the copy button next to Tenant Name to copy the tenant name.
Click View next to Tenant Connection String to manage the connection string in a pop-up window.
Copy connection string: After an OBProxy is associated with the tenant's cluster, click the copy button on the right side of the connection string to use it for connection.
Add/delete custom connection strings: Click Add at the bottom of the connection string list to customize tenant connection string information, facilitating unified management of tenant addresses. The content of Access Address and Connection String can be customized. OCP does not validate their validity. When a custom connection string is no longer applicable, click Delete in the Actions column to remove it.
Associate OBProxy cluster: Click Associate OBProxy Cluster to go to the overview page of the tenant's cluster and associate an OBProxy cluster with it. For more cluster-related information, see View cluster details.
Click Add Service Name to directly add a service name. The service name must start with a letter, can contain English letters, numbers, and underscores, and be 2 to 64 characters long. You can also edit or delete added service names through the Actions drop-down menu. Additionally, for primary and standby tenants, the system supports Sync Service Names of Primary and Standby Tenants.
Note
- To configure a service name for a tenant, both versions must meet the following requirements:
- OceanBase: [V4.2.1.9, V4.2.2.0), [V4.2.4.0, V4.3.0.0), [V4.3.3.0, +∞).
- OBProxy: [V4.3.1.0, +∞).
- If a tenant has a primary/standby relationship, it is recommended to keep the service names of the primary and standby tenants consistent and associate them with the same OBProxy cluster. This allows your application to achieve automatic routing after a primary/standby switch for the tenant.
- For more information about service names, see Manage service names.
- To configure a service name for a tenant, both versions must meet the following requirements:
Supports enabling the Binlog service for a tenant. For details, see Manage tenant Binlog service.
Supports viewing the current tenant's locked state and quickly locking the tenant. Locking a tenant prevents users from accessing it and affects tenant management. Proceed with caution. For details, see Lock a tenant.
Click View next to Usage Limits to view the resource usage limits for the tenant under the current specifications. When the current value approaches the theoretical upper limit, be sure to upgrade the tenant's specifications to avoid database anomalies.
Note
Resource usage limits are viewable only if the tenant's cluster meets the following conditions:
- V4.2.x requires version no earlier than V4.2.4.
- V4.3.x requires version no earlier than V4.3.1.
Click the icon next to Remarks to modify the remarks.
Click the icon next to Arbitration Service to enable or disable the arbitration service for the tenant.
Note
- The arbitration service cannot be configured when the tenant's cluster is OceanBase Database Enterprise Edition Centralized.
- Before enabling the arbitration service, confirm the following information:
- The arbitration service has been added to the tenant's cluster and is in the RUNNING state.
- The tenant's Locality is 2F (F: full-featured replicas) or 4F.
- The remaining resources of the host where the arbitration service resides meet the resource requirements. These requirements can be modified according to actual conditions in the system parameters. The parameters to modify are as follows. For operation details, see Modify system parameters.
ocp.arbitration.min.remain.disk.size: The minimum remaining size of the CLOG disk for the arbitration service host when tenant arbitration is enabled, in MB. The data format (a,b) indicates the values when tenant replicas are 2F and 4F respectively. Default is [12,24].ocp.arbitration.max.cpu.used.percentage: The maximum CPU usage of the arbitration service host when tenant arbitration is enabled, in %. Default value is 90.ocp.arbitration.max.memory.used.percentage: The maximum available memory usage of the arbitration service host when tenant arbitration is enabled, in %. Default value is 90.
Hover the pointer over a tenant tag to view all tag information for that tenant. You can click the edit icon to manage tags. For more information, see Manage tags.
Note
- If a tenant has a primary-standby relationship, it is recommended that you keep the service names of the primary and standby tenants consistent and associate them with the same OBProxy cluster. This enables your applications to automatically route requests after a primary-standby switchover.
- If a tenant's cluster was added to OCP by using the takeover cluster method, the tenants in that cluster cannot view their original load type information.
View replica details
View the zone name, replica type, unit specification, number of units, and OBServer host of a replica. You can also modify or delete the replica or its units. For more information, see Modify a replica, Delete a replica, and Delete a unit.
Note
View primary-standby tenant relationship
View the details of the primary-standby relationship of a tenant, including information such as Primary Tenant, Standby Tenant, Status, Synchronization Method, Primary-Standby Protection Mode, Protection Level, and Log Latency.
The Status of primary-standby synchronization is divided into the following five categories:
- Normal Synchronization: Primary-standby synchronization is running normally, and data is continuously synchronized from the primary tenant.
- Synchronization Error: Abnormal conditions such as the OceanBase version of the primary tenant being later than that of the standby tenant, the primary tenant being deleted, the log source being inaccessible, or the log source being unreachable.
- Log Conflict: Conflicts occur between restored logs and those in the standby tenant. The logs in the standby tenant and at the log source are inconsistent at the same LSN.
- Synchronization Suspended: Primary-standby synchronization is actively paused.
- Logs are missing.: Logs at the log source are missing.
Click Change Primary-Standby Protection Mode in the upper-right corner to change the primary-standby protection mode. For more information, see Change the primary-standby protection mode.
Click View Latency in the Actions column to view the historical log synchronization latency. By default, the system displays the latency data for the last hour. You can customize the time range to view by using the time filter.
Click Pause Synchronization/Resume Synchronization in the Actions column to pause or resume the synchronization between the primary and standby tenants.
Notice
The Primary-standby Tenant Relationship data is displayed only if the tenant has a primary-standby relationship and the cluster to which the tenant belongs is V4.2.0.0 or later. Some of this information or actions are displayed only when specific conditions are met, as follows:
View zone priority
View or modify the priority of the distribution of partition leader replicas in a tenant. For more information, see Modify zone priority.
View the allowlist
View or modify the list of addresses that can connect to the tenant. For more information, see Modify the allowlist.
Related operations
Manage tenants
You can perform routine management operations on tenants. For more information, see Delete a tenant, Add a replica, Change the password of the sys tenant, Rename a tenant, Lock a tenant, Copy a tenant, Clone a tenant, and Configure end-to-end tracing.
You can also perform other management operations on tenants by using the left-side navigation pane. For more information, see View the tenant topology diagram, 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 tenant major compactions, Manage tenant backup and recovery, View the parameter list, and Manage tenant parameter templates.
View AI analysis
When a tenant is in an abnormal state, you can click Analysis to obtain an intelligent interpretation of the error from the AI assistant. For more information about the AI assistant, see AI Assistant.