Tenant management

A tenant is a logical concept in OceanBase Database and is the unit for resource allocation. It is the basic unit for managing database objects and resources. After you log in to OB-Dashboard, click Tenant Management in the left-side navigation pane to go to the Tenant Management page, which displays a list of all tenants in the cluster. On this page, you can view the basic information about all tenants.

Tenant list

The Tenants list displays the Tenant Name, Tenant Mode, Connection String, whether the tenant is Read-only, whether the tenant is Locked, Status, and Created At of each tenant, as well as the Actions that you can perform.

• You can click the name of a tenant to go to the Overview page for that tenant, where you can manage the databases, users, and parameters in the tenant. For more information, see Database management, User management, and Parameter management.

• You can click the icon in the Connection String column to copy the connection string of the tenant for future use.

• You can click the icon next to Status to filter tenants by status.

• You can click the icon next to Created At to sort tenants in ascending or descending order, making it easier to view tenants in the cluster.

• You can click Lock in the Actions column to lock the corresponding tenant. Locking a tenant prevents users from accessing it. Proceed with caution.

Create a tenant

Click Create Tenant in the upper-right corner of the page to go to the Create Tenant page. When you create a tenant, you need to configure Basic Information, Zone Information, Security Settings, and Parameter Settings. This section describes each part.

1. Basic information

   The Basic Information section is used to set the tenant mode, name, password, and other information.

   Parameter	Description
   Tenant mode	You can select MySQL-compatible mode or Oracle-compatible mode from the drop-down list. Note At present, you can create only MySQL-compatible tenants by using OB-Dashboard.
   Tenant name	The name of the tenant to be created. The tenant name must meet the following requirements: 2 to 32 characters in length. Consists of uppercase and lowercase letters, digits, and underscores, and must start with a letter and end with a letter or digit.
   Administrator initial password	You can click Randomly Generate for OB-Dashboard to generate a random string, or set a custom password. If you set a custom password, the password must meet the following requirements: 8 to 32 characters in length. Contains at least two characters from each of the following four types: digits (0-9), uppercase letters (A-Z), lowercase letters (a-z), and special characters (~!@#%^&*_-+=|(){}[]:;,.?/). After you configure the password, you can click Copy Password to copy and save it for future use.
   Character set	The default value is utf8mb4. You can select another character set from the drop-down list.
   Collation (optional)	You can select a collation from the drop-down list.
   Remarks (optional)	A description of the tenant to help you manage tenants.

2. Zone information

   The Zone Information section is used to set the number of units in each zone, replica type, unit specification, and zone priority for each zone.

   Parameter	Description
   Number of units per zone	The minimum number of OBServer nodes in a zone determines the maximum number of units that you can set.
   Zone name	The default value is the zone name in the cluster and cannot be modified. You can select the check box before a zone to specify the zones in which units are created.
   Replica type	You can select a replica type from the drop-down list. Valid values: Full-featured Replica and Read-only Replica.
   Unit specification	The maximum CPU and memory specifications of the unit. The configurable range varies with cluster resources. Set values within the range shown below the corresponding input box.
   Number of units	The number of units in each zone.
   Zone priority	Specifies the priority for distributing leader replicas for the tenant. The zone with the highest priority is considered the primary zone, and only one primary zone is allowed. If you do not specify a priority, the first zone is used as the highest priority by default. To set the priority, perform the following steps: Select one or more zones from the list on the left. The list on the left shows all available zones in the current cluster. Click the > button in the middle. The selected zones are moved to the Priority list. Multiple zones selected at the same time have the same priority. Repeat steps 1 and 2 to add zones with lower priorities. To adjust the priority, drag zones in the Priority list. Priority decreases from top to bottom in the list. Click the delete button next to a zone, or click Reset Settings to move zones from the Priority list back to the list on the left.

3. Security settings

   The Security Settings section is used to configure an IP address allowlist. You can specify allowed client IP addresses or allow all IP addresses. If you choose custom configuration, you can specify the list of clients allowed to log in in the input box under Custom IP. After you enter an IP address, press Enter or enter a comma (,) to add multiple node IP addresses. When you move the pointer over View Configuration Instructions, you can view 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

   Note

   If you set %, all clients can connect, which poses a security risk. Proceed with caution.

4. Parameter settings

   Click the button next to Parameter Settings to configure tenant parameters. You can click + Add Tenant Parameter to configure multiple tenant parameters. You can manually enter or select a tenant parameter from the drop-down list under Parameter Name, and set the parameter value in the input box under Parameter Value. Click Delete in the Actions column to delete a configured parameter.

5. Submit

   After the configuration is complete, click Submit in the lower-right corner of the page to start the tenant creation task. You can choose Return to Tenant List or View Task Details.

Lock a tenant

Click Lock in the Actions column. In the window that appears, click OK to lock the corresponding tenant. Locking a tenant prevents users from accessing it. Proceed with caution.