Create, upgrade, and uninstall an arbitration service

2026-02-10 09:37:01  Updated

This topic describes how to create, upgrade, and uninstall an arbitration service by using OAT.

Prerequisites

Before you create an Arbitration Service, make sure that the following conditions are met:

  • You have installed OAT and logged in as a super administrator or an O&M engineer. For more information, see Install OAT.

  • You have added a server to install the Arbitration Service. For more information, see Add a server.

  • You have added the Arbitration Service image file.

  • The server meets the requirements for installing the Arbitration Service.

    Note

    The components of the Arbitration Service can be deployed on servers whose purpose is set to Arbitration Service or OB Service.

Create an arbitration service

To create an Arbitration Service, perform the following steps:

  1. In the left-side navigation pane, choose Product Service > Components.

  2. On the Component Management page, click Create Component in the upper-right corner and choose Create Arbitration Service.

  3. On the Create Arbitration Service page, configure the parameters.

    The following table describes the basic parameters of the Arbitration Service.

    Parameter Explanation
    Arbitration Service Image The Docker image of the Arbitration Service.
    • If an image of the corresponding version is available, you can select it directly.
    • If no image of the corresponding version is available, you can click Manage image files to upload an image.
    Component Name The name of the component, which must be unique. Default value: arbitrationservice.
    Server The IP address of the server on which you want to install the Arbitration Service.

    Note

    You can select only one server.

    CPU The number of CPU cores available to the Arbitration Service on each server. The value can be shared with other containers on the same server. Default value: 2.
    Memory The size of memory available to the Arbitration Service container, which cannot be shared with other containers on the same server. Default value: 4 GB.
    Installation Directory The installation path of the Arbitration Service. Default value: /home/admin/oceanbase.
    Service Port The RPC port of the Arbitration Service. Default value: 2882.
    SSHD Port The SSHD port of the Arbitration Service. Default value: 2022.
    Password The password of the Arbitration Service. Default value: a random password.
  4. After you configure the parameters, click Submit.

    If you want to restore to the default settings, click Reset.

    After you submit the configuration, the Component Management page appears. On this page, you can find the Arbitration Service that you just created. In the Operation column of the corresponding row, click View Tasks to view the creation progress of the Arbitration Service. You can also click Arbitration Service in the upper-left corner to filter the components or use the search box in the upper-right corner to search for the component.

Upgrade an arbitration service

Note

When you upgrade the MetaDB associated with the Arbitration Service, if the Arbitration Service is managed by OAT, you must first upgrade the Arbitration Service through OAT, and then upgrade the MetaDB.

To upgrade an Arbitration Service, perform the following steps:

  1. In the left-side navigation pane, choose Product Service > Components.

  2. On the Component Management page, click the name of the Arbitration Service.

  3. Find the Arbitration Service that you want to upgrade and click its name in the Name column to go to the ArbitrationService Details page.

    Note

    You can also search for the component by name at the top of the page.

  4. On the ArbitrationService Details page, click Upgrade in the upper-right corner.

  5. In the Upgrade dialog box, specify the required information.

    The following table describes the related parameters.

    Parameter Description
    Upgrade Method Only stop-and-upgrade is supported.

    Note

    This method is applicable to products without business continuity. During the upgrade, the service of the previous version is stopped, and the product cannot provide services.

    Select the Image File for Upgrade Click the icon next to this parameter or select the Upgrade Target Image File.
    Automatically Synchronize to OCP If you enable this option, you can select an installed OCP.

    Note

    After you complete the initialization settings on a server in OAT, the system automatically calls the API of OCP to add the server to the specified OCP for subsequent use.

  6. After you configure the parameters, click Confirm in the lower-right corner.

Uninstall arbitration service

Notice

After you uninstall the arbitration service, it cannot be restored. Proceed with caution.

To uninstall Arbitration Service, perform the following steps:

  1. In the left-side navigation pane, choose Product Service > Components.

  2. Find the arbitration service that you want to uninstall and click the name in the Name column to go to the ArbitrationService Details page. The name of the arbitration service is displayed in the Name field on this page.

    Note

    You can search for the arbitration service by name at the top of the page.

  3. On the ArbitrationService Details page, click Uninstall in the upper-right corner.

  4. In the message that appears, click Confirm.

References

Contact Us