Before you deploy OceanBase Cloud Platform (OCP), OceanBase Developer Center (ODC), or OceanBase Migration Service (OMS) on a server, you must add the server to OceanBase Admin Toolkit (OAT).
Prerequisites
Before you add a server, make sure that you have installed and logged in to OAT as a super administrator or an O&M engineer. For more information, see Install OAT.
Procedure
In the left-side navigation pane, choose Server > Server.
In the upper-right corner of the page that appears, click Add Server.
On the Add Server page, specify the basic information of the server.
The following table describes the basic information parameters.
ParameterDescriptionServer IP The public IP address of the server. SSH Port The SSH port number of the server. IDC The IDC in which the server resides. You can select Add IDC from the drop-down list to add an IDC. Credentials The access credentials of the server. The following two types of credentials are supported: the combination of username and password, and key. Description (optional) The description of the server, which facilitates server management and maintenance. This parameter is optional. (Optional) On the Add Server page, configure the initialization settings.
If you want to take over a component or service, which means that a service is already running on the server, you can disable the initialization option to skip the initialization process.
A new server must be initialized. Otherwise, you cannot deploy OceanBase services on the server.
The following table describes the initialization parameters.
ParameterDescriptionServer Usage The purpose of the server. Valid values: - OB Server: This option is selected when you want to deploy an OB cluster and an OBProxy cluster. In this case, disk-related checks are performed, and an OB startup script is set to automatically start the related processes after the system restarts.
- OB Services: This option is selected when you want to deploy OMS, OBSharding, and other containerized products and their dependencies (excluding MetaDB) on the server. In this case, Docker is installed.
- Arbitration Service: This option is selected when you want to deploy an arbitration service. In this case, the server resources are not required to be high, and Docker is installed.
- OB Server + OB Services: This option is selected when you want to deploy MetaDB or deploy MetaDB together with other services (such as OCP) on the server. In this case, disk checks are performed, and Docker is installed. However, the OB startup script is not set because MetaDB uses the Docker daemon to start automatically. Therefore, this option is not suitable for deploying business OB clusters.
Note
The Arbitration Service option cannot be selected together with other options. You can select only the Arbitration Service option.
OceanBase OS User The operating system user that installs and runs OBServer and OceanBase services. A custom user is supported. User Password The password of the operating system user. UID:GID The user identifier (UID) and group identifier (GID) of the operating system user. Docker Root Directory The data directory of Docker. Clock Synchronization Specifies whether to enable clock synchronization. Automatic Synchronization to OCP Specifies whether to synchronize server information to OCP for management. Custom Installation Path Specifies whether to use a custom software installation path, data disk path, and log disk path. The following table describes the parameters. - If you select OB Server or OB Server + OB Services as the server usage, you can specify a custom software installation path (default value:
/home/admin), data disk path (default value:/data/1), and log disk path (default value:/data/log1). - If you select OB Services or Arbitration Service as the server usage, you can specify a custom software installation path (default value:
/home/admin).
Note
- The default operating system user is admin. A custom user is also supported.
- By default, the password is left empty. You can specify a custom password or click Random password to generate a random password.
- Take note of the following items when you specify the username and password of the operating system user:
- If the operating system user does not exist and the password is left empty, the system creates a user without setting the password. In this case, you cannot log in as this user in SSH mode. Instead, you must log in as the root user and run the
su - usernamecommand to switch to the created user. - If the operating system user does not exist and the password is specified, the system creates a user and sets the specified password for the user.
- If the operating system user exists and the password is left empty, the system does not change the password of the user.
- If the operating system user exists and the password is specified, the system changes the password of the user.
- If the operating system user does not exist and the password is left empty, the system creates a user without setting the password. In this case, you cannot log in as this user in SSH mode. Instead, you must log in as the root user and run the
The following requirements apply to the preceding parameters:
By default, clock synchronization is disabled. To enable clock synchronization, you must specify the IP address of the clock source and configure the minpoll, maxpoll, maxslewrate, and Use this server as a secondary clock source parameters. The following table describes the parameters.
ParameterDescriptionminpoll The minimum interval between time synchronization requests sent from the chrony client to the clock source, in seconds. maxpoll The maximum interval between time synchronization requests sent from the chrony client to the clock source, in seconds. maxslewrate The maximum slew rate for the clock of the chrony client, in parts per million (ppm). Use this server as a secondary clock source Specifies whether to use the server as a secondary clock source. After this option is selected, the server can provide services as the clock source before requests from clients on the allowlist are allowed and requests from clients on the blocklist are blocked. This parameter is optional. Automatically Synchronize to OCP: After you complete the initialization settings in OAT, OAT automatically calls an API of OCP to synchronize the server information to the specified OCP for subsequent use. By default, this option is disabled. After you enable this option, you must select an installed OCP instance. If no OCP instance is available, this option is disabled.
Note
The installed OCP instances are available on the page that appears after you choose Product Service > Products > OCP in the OAT console. For more information about how to install OCP, see Install, upgrade, and uninstall OCP.
By default, the Custom Installation Path option is disabled. After you enable this option, you can specify a custom installation path.
- If you select only OB Services as the server usage, you must provide a software installation path. By default, the software installation path is
/home/admin. - If you select OB Server or OB Server + OB Services as the server usage, you must provide a software installation path, data disk path, and log disk path. By default, the software installation path is
/home/admin, the data disk path is/data/1, and the log disk path is/data/log1.
- If you select only OB Services as the server usage, you must provide a software installation path. By default, the software installation path is
Disk Initialization: To ensure the stability of OceanBase Database and other OceanBase services, we recommend that you configure the directories of the services on independent disks or partitions. If the Disk Initialization option is enabled, OAT automatically creates the corresponding volume group (VG) by using a logical volume manager (LVM), and mounts the logical volumes (LVs) of the corresponding size to the specified mounting directories.
- Select a disk or partition: The system automatically identifies unmounted disks. You can select one or more disks to be mounted.
- Specify the file system type: Specify the file system type. Valid values:
xfs,ext4, andauto. Default value:auto. - Mounting Purpose: Select a mounting purpose. Valid values: Software Installation Path, Data Disk Path, and Log Disk Path.
- Mounting Point: Select the mounting path based on the actual situation.
- Space (GB): Specify the space size based on the actual situation, in GB.
Note
- If both the Custom Installation Path and Disk Initialization options are enabled, the path settings of the two options are consistent with each other.
- You can specify a file system type for each VG.
Click Submit.
- If the Disk Initialization option is enabled, a dialog box that displays the check items appears after you click Submit. If all check items pass, click OK to add the server.
- If the Disk Initialization option is disabled, the configurations are directly submitted and the system starts server initialization after you click Submit.
What to do next
After the server is added, you can view the server in the server list. The server is in the Initializing state. On the Server Management page, you can find the new server and click View Tasks in the Actions column to view the initialization progress. At the top of the page, you can search for a server by IP address.
If an error is returned for a subtask that does not affect business, you can view the logs and manually mark the subtask as successful.