All Products
Search
Document Center

ApsaraDB for OceanBase:Create a tenant

Last Updated:Sep 12, 2024

Tenants lay the foundation for database object management and resource management. They serve as containers for both database objects and resources such as CPU, memory, and I/O resources. You can create and manage tenants in the ApsaraDB for OceanBase console.

Prerequisites

You have created a cluster. For more information, see Purchase an instance.

Procedure

  1. Log on to the ApsaraDB for OceanBase console.

  2. In the left-side navigation pane, click Instances.

  3. On the Instances page, click the name of the target cluster instance to go to the Cluster Instance Workspace page.

  4. In the upper-right corner of the page that appears, click Create Tenant.

  5. Set the parameters for creating the tenant as needed.

    Parameter

    Description

    Tenant Name

    The tenant name.

    It must start with a letter or an underscore (_), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (_). It cannot be set to sys.

    Tenant Mode

    The tenant mode, which can be Oracle or MySQL.

    Note

    For Standard Edition (Key-Value) cluster instance, only tenants in MySQL mode can be created.

    Character Set

    The character set to be used in the database, which can be UTF8MB4 or GBK.

    Note

    For Standard Edition (Key-Value) cluster instance, only UTF8MB4 is supported for new tenants and currently modification is not supported.

    Resource Distribution Nodes

    The number of nodes for resource distribution. The reliability and availability increase with the number of nodes. However, more nodes also incur more overall distribution costs. Specify the number of nodes based on your business needs.

    Single-node Resources

    The CPU and memory capacities on a single node of the tenant.

    Note

    • The total CPU and memory capacities of all tenants cannot exceed the specifications of the cluster instance to which they belong.

    • Total available resources of a tenant = Single-node resources * Number of resource distribution nodes * Number of replicas

    • For cluster instances with the OceanBase database version of 3.x and 4.x, the creation of 1C4GB tenant is supported.

    Time Zone

    The time zone information.

    VPC

    The ID of the virtual private cloud (VPC) to which the Elastic Compute Service (ECS) instance belongs.

    If no suitable VPC is available, create a VPC as prompted. For more information, see What is a VPC?.

    Primary Zone

    Select the primary zone for the tenant.

    The zone where the primary address proxy deployed is the same as the primary zone by default. You can modify it in the topology section of the tenant details page after the tenant is created.

    vSwitch

    The ID of the vSwitch to which the ECS instance belongs.

    If no suitable vSwitch is available, create a vSwitch as prompted. For more information, see Create and manage a vSwitch.

    Tenant Whitelist

    Cluster instance whitelist groups are automatically synchronized to tenants. Modifications to cluster instance whitelists apply to all tenants. You can add other whitelist groups for the tenant later.

    Remarks (Optional)

    The length of remarks cannot exceed 30 characters.

  6. Click Create. You can view the progress of tenant creation on the Instances page.