A tenant can be seen as a container for database objects and resources such as CPU, memory, and I/O resources. You can create tenants in a cluster as needed.
in the following ways:
Create a tenant on the Tenant Overview page.
Create a tenant on the Tenant Management page of the specified cluster.
This topic describes how to create a tenant on the Tenant Management page of the specified cluster.
Prerequisites
The cluster where you want to create the tenant is the running primary cluster.
You are logged on with an account that has the permission to manage the cluster. For example, the user is the system administrator or the OceanBase Cloud Platform (OCP) tenant administrator.
(Optional) You have created a parameter template by referring to Manage tenant parameter templates.
When you need to create multiple tenants with the same parameter configuration, you can use a parameter template to avoid repeatedly configuring the same parameters.
Procedure
Log on to the OCP console.
In the left-side navigation pane, click Clusters.
In the Clusters list, find the target cluster and click its name.
In the left-side navigation pane of the page that appears, click Tenant Management.
In the upper-right corner of the page that appears, click Create Tenant.
Specify the parameters in the Basic Information section.
The cluster is specified to the current cluster by default.
Enter the tenant name in Tenant Name. The tenant name must be 2 to 64 characters in length and can contain letters, digits, and underscores (_).
Specify the parameters in the Zone Information section.
Configure the replica type, unit specification, and unit quantity for z1, z2, and z3.
After you select a cluster, the page provides a list of supported zones based on the zone information of the selected cluster. You can select zones for which the replica locality does not need to be specified and click the Delete button on the right to delete them.
Select a replica type from the drop-down list. Full-featured, read-only, and log replicas are supported.
You can use the built-in unit specifications or click Add Specification at the bottom of the drop-down list to add a custom specification.
Specify the number of units in the zone. Note that the number of units cannot exceed the number of servers in the zone.
Note
We recommend that you set the same specifications and number of units for full-featured replicas. Different specifications or numbers of units can affect performance or stability.
Specify the priorities of zones. If you drag multiple zones to the right-side pane at a time, these zones have the same priority.
Specify the parameters in the Basic Information section. The required fields and their descriptions are listed in the following table.
Parameter Description Cluster The cluster to which the tenant belongs. The default value is the current cluster. Note
When you create a tenant on the Tenant Overview page, you must specify the cluster of the tenant.Tenant Mode Valid values: MySQL and Oracle. Notice
The Oracle mode is supported only for OceanBase Database V2.1 and later.Tenant Name The tenant name must be 2 to 64 characters in length and can contain letters, digits, and underscores (_). Administrator Password The password of the tenant administrator account, which can be randomly generated. - The administrator account is root in MySQL mode.
- The administrator account is SYS in Oracle mode.
- The length is 8 to 32 characters.
- It contains at least three of the following character types: digits(0~9), uppercase letters(A~Z), lowercase letters(a~z), and special characters (ie:
~!@#%^&*_-+=|(){}[]:;,.?/).
Character Set and Encoding - In MySQL mode, the supported character sets are UTF8MB4, Binary, GBK, and GB18030. Default value: UTF8MB4.
- In Oracle mode, the supported character sets are UTF8MB4, GBK, and GB18030. Default value: UTF8MB4.
Collation The detailed collation corresponding to the specified character set. Remarks This field is optional and allows you to add additional information. 
Specify the parameters in the Replica Settings section.
If the version of the specified cluster is V4.0 or later, you can only set the same number of units for all zones, which is 1 by default.
If the version of the specified cluster is earlier than V4.0, you can set different numbers of units for different zones.
By default, the system displays configurable zones based on the zone information of the selected cluster. If you do not need to create a replica in a zone, click the Delete icon to delete the zone. The zone information fields that need to be configured and their descriptions are listed in the following table.
Parameter Description Replica Type The type of the replica. Valid values: - Full-featured replicas
- Read-only replicas
- Log-only replicas
Unit Specification OCP has a set of built-in unit specifications. You can select the specification that you need from the list of unit specifications or click Add Specification at the bottom of the list to add a custom specification. For more information, see OCP resource unit specifications. Units The number of units in the zone. The number of resource units cannot exceed the number of OBServers in the zone. Zone Priority Rankings The priorities of the zones. This priority order affects the priority order of the Primary Zone of the sys tenant. The left-side list shows all zones in the cluster. You can select one or more zones from the list box on the left to add them to the list box on the right. By default, the priority of a zone selected earlier is higher than that of a zone selected later, and the zones selected at one time have the same priority. After you move the zones to the box on the right side, you can also drag them upward or downward to adjust their priority order. A zone takes priority over those beneath it. Specify the parameters in the Security Settings section.
- Access from all IP addresses is supported: This tenant can be accessed by any IP address.
Notice
This mode causes access security risks. Proceed with caution.
- Custom: You can add allowed clients into the whitelist in the formats described in the following table. Example:
Format Examples The IP address. xxx.xxx.xxx.1,xxx.xxx.xxx.2 Subnet/Mask xxx.xxx.xxx.1/24 Fuzzy match xxx.xxx.xxx.% or xxx.xxx.xxx._ Mixed xxx.xxx.xxx.1,xxx.xxx.xxx.2,xxx.xxx.xxx.%,xxx.xxx.xxx._,xxx.xxx.xxx.1/24 % % indicates that all clients can connect to this tenant. Notice
You must add the IP addresses of the OCP and OBProxy servers to the whitelist. Otherwise, you cannot manage the tenant from OCP.
Turn on Parameter Configurations and configure the tenant parameters.
You can add startup parameters one by one and set values as shown in section ① of the following figure.
You can also click Select Parameter Template as shown in section ② of the following figure and select a parameter template. The system will automatically populate parameters in this section by using the template.
Note
- If you are creating a tenant in MySQL mode by using a parameter template that contains parameters that are valid only in Oracle mode, you must manually delete those parameters.
- If no tenant parameter template is available, you can click Create Tenant Parameter Template to create one. For more information, see Manage tenant parameter templates.
Click Submit.
The page that appears prompts you that the tenant creation task has been submitted and displays the summary information of the task.
* To view the task details, click **View Task Details**.
* To return to the Tenants list, click **Return to Tenants List**. In the Tenants list, you can view the status and task details of the new tenant, and delete the tenant if the tenant creation failed.
<main id="notice" type='explain'>
<h4>Note</h4>
<p>When the task status is <strong>Completed</strong>, you can check the status of the new tenant in the <strong>Tenants</strong> list on the <strong>Tenant Management</strong> page. The new tenant is created if its status is <strong>Running</strong>.</p>
</main>