Add a server

Before deploying OceanBase Cloud Platform (OCP), OceanBase Developer Center (ODC), or OceanBase Migration Service (OMS), you must add servers to OceanBase Admin Toolkit (OAT).

Prerequisites

Before adding a server, make sure that you have installed and logged in to OAT using a super admin account or an operation and maintenance (O&M) account. For more information, see Install OAT.

Procedure

1. In the left-side navigation pane, choose Server > Server Management.

2. In the upper-right corner of the page, click Add Server.

3. On the Add Server page that appears, enter the following server information:

   1. Basic information, including Server IP, SSH Port, IDC, Credentials, and Description. The following table describes these fields.

      Field	Description
      Server IP	The public IP address of the server to be added.
      SSH Port	The SSHD port of the server to be added.
      IDC	The machine room where the server is located. You can add a machine room by selecting Add machine room from the drop-down list.
      Credentials	The access credentials for the server to be added. Currently, two types of credentials are supported: (1) username + password; (2) key.
      Description (optional)	The description of the server, which can facilitate server management and maintenance.

   2. Initialization configuration.

      • If you want to take over a component or product, that is, if a service is already running on the server, you can disable the initialization option to skip initialization.

      • If it is a new server, initialization is a must. Otherwise, OceanBase services may not be deployed on the server.

        The following table describes the initialization-related fields.

        Field	Description
        Server Usage	The purpose of the server to be added.
        OceanBase OS User	The operating system user who installs and runs OBServer and OceanBase product services. This user can be customized.
        User Password	The password of the OS user.
        UID:GID	The UID and GID of the OS user.
        Docker Root Directory	The data directory of the Docker container.
        Clock Synchronization	Specifies whether to enable clock synchronization.
        Automatically Synchronize to OCP	Specifies whether to synchronize server information to OCP for management.

        Note

        • The default OceanBase OS User is admin. This user can be customized.
        • The User Password is empty by default. You can specify a password or click Random password to generate a random one.
        • Pay attention to the following when you specify OceanBase OS User and User Password:
          • If the OS user does not exist and the password is empty, it means to create the user without a password. In this case, the user cannot log in through SSH. To log in, you need to use the root user and then switch to the corresponding user through the su - username command.
          • If the OS user does not exist and the password is not empty, it means to create a user and set the user password.
          • If the OS user exists and the password is empty, it means not to change the password of the OS user.
          • If the OS user exists and the password is not empty, it means to change the password of the OS user.

      1. Clock synchronization is disabled by default. To enable clock synchronization, you must set the clock source IP address, minpoll, maxpoll, maxslewrate, and specify whether to use this server as a secondary clock source (optional). The following table describes these fields.

         Field	Description
         minpoll	The minimum time interval, in seconds, for a chrony client to send time synchronization requests to the clock source.
         maxpoll	The maximum time interval, in seconds, for a chrony client to send time synchronization requests to the clock source.
         maxslewrate	The maximum adjustment rate for the chrony client clock, measured in parts per million (PPM).
         Use this server as a secondary clock source	If this field is set to Yes, only requests from clients in the allowlist will be allowed, while requests from clients in the blocklist will be denied. In this case, the server can provide external services as the clock source.

      2. If you enable Automatically Synchronize to OCP, after completing the initialization configuration for the server in OAT, the OAT automatically calls an API of OCP to add the server to the specified OCP for subsequent use. This option is disabled by default. After you enable this option, you must select an installed OCP. If no OCP is available, this option is disabled by default.

         Note

         The installed OCPs refer to those available on the page that appears after you choose Product Services > Products > OCP in the OAT console. For more information about how to install OCP, see Install, upgrade, and uninstall OCP.

   3. Disk initialization settings. To ensure the stability of OceanBase Database and related product services, we recommend that you configure the directories of the services on independent disks or partitions. If you enable Disk Initialization, OAT automatically creates the corresponding volume group (VG) through 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 mount.
      • Mounting Purpose: Select a mounting purpose. Valid values: Software Installation Path, Data Disk Path, and Log Disk Path.
      • Mounting point: Select the mounting path according to the actual situation.
      • Space (/GB): Specify the space size according to the actual situation, in GB.

4. Click Submit.

   • If Disk Initialization was enabled, a dialog box with check items will appear after you click Submit. If all check items pass, click OK to add the server.

   • If Disk Initialization was not enabled, the configurations are submitted directly. The system starts server initialization after you click Submit.

After the server is successfully submitted, the newly added server can be seen in the server list. At this time, 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. If there are too many servers, you can search by IP at the top of the page.

If a sub-task encounters an error without affecting business, you can manually set the sub-task to Successful after viewing the log information.