Add a server

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

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

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

3. In the Add Server dialog box, specify the server information.

   (1) Specify the basic information of the server, including the public IP address, SSHD port number, IDC, credentials, and description. The following table describes the parameters.

    |   Parameter    |          Description          |
    |---------|----------------------|
    | Server IP  | The public IP address of the server.    |
    | SSH Port      | The SSHD port number of the server.        |
    | IDC  | The IDC in which the server resides. You can select **Add machine room** 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  | The description of the server, which facilitates server management and maintenance. This parameter is optional.   |
   

   (2) 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.
   
        |   Parameter    |          Description          |
        |----------|----------------------|
        | Server Usage | The purpose of the server. |
        | OceanBase OS User | The operating system user that installs and runs OBServer and OceanBase services. A custom user is supported. |  
        | 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. |
        | Automatically Synchronize 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. |
   
        <main id="notice" type='explain'>
            <h4>Note</h4>
            <ul>
                <li> The default operating system user is admin. A custom user is also supported. </li>
                <li> By default, the password is left empty. You can specify a custom password or click <strong>Random password</strong> to generate a random password. </li>
                <li>Take note of the following items when you specify the username and password of the operating system user:
                <ul>
                <li>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 <code>su - username</code> command to switch to the created user. </li>
                <li>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. </li>
                <li>If the operating system user exists and the password is left empty, the system does not change the password of the user. </li>
                <li>If the operating system user exists and the password is specified, the system changes the password of the user. </li>
                </ul>
            </ul>
        </main>
   

   a. 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.

        |   Parameter    |          Description          |
        |----------|----------------------|
        | minpoll | 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. |
   

   b. If you enable Automatically Synchronize to OCP, OAT automatically calls an API of OCP to synchronize the server information that you specified in initialization settings to 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.

        <main id="notice" type='explain'>
            <h4>Note</h4>
            <p>The installed OCP instances are available on the page that appears after you choose <strong>Product</strong> <strong>Service</strong> > Products > <strong>OCP</strong> in the OAT console. For more information about how to install OCP, see <a href="../400.product-services/100.install-ocp.md">Install, upgrade, and uninstall OCP</a>. </p>
        </main>
   

   c. 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 **OceanBase services** as the server usage, you must provide a **software installation path**. By default, the software installation path is `/home/admin`.
    If you select **OBServer** or **OBServer and OceanBase 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`.
   

   (3) Configure the Disk Initialization option. 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`, and `auto`. 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.
   
    <main id="notice" type='explain'>
      <h4>Note</h4>
      <p><ul><li>If both the **Custom Installation Path** and **Disk Initialization** options are enabled, the path settings of the two options are consistent with each other. </li><li>You can specify a file system type for each VG. </li></ul></p>
    </main>
   

4. 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.

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.