OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Admin Tool

V4.5.2
  • What's New
  • Product Introduction
    • What is OAT?
    • Architecture
    • Glossary
  • Quick Start
    • Install OAT
    • Get started with OAT
  • User Guide
    • Log in to OAT
    • Page layout of the OAT console
    • Servers
      • Add a server
      • Edit a server
      • Maintain a server
      • Remove servers
      • Manage credentials
    • Product services
      • Product service versions that support IPv6
      • Install, upgrade, roll back, and uninstall OCP
      • Install, upgrade, roll back, and uninstall ODC
      • Install, upgrade, and uninstall OMS in single-node mode
      • Install, upgrade, and uninstall OMS in separated mode
      • Install, upgrade, roll back, and uninstall OAS
      • Install, upgrade, roll back, modify, and uninstall OB Sharding
      • Install and uninstall DataPilot
      • Install, upgrade, modify resources, and uninstall OAgent
      • Install, upgrade, and uninstall MetaDB
      • Install and uninstall OBDNS
      • Install and uninstall InfluxDB
      • Install and uninstall NLB
      • Install and uninstall OpenSearch
      • Install and uninstall SQLAuditStore
      • Create, upgrade, and uninstall an arbitration service
      • Install and uninstall OBLB
      • Take over OCP
      • Take over ODC
      • Take over OB Sharding
      • Take over OMS in standalone mode
      • Take over the OMS in split mode
      • Take over MetaDB
      • Take over OBDNS
      • Take over InfluxDB
      • Take over NLB
      • Take over the Arbitration Service
      • Manage images
      • Change resources of services and components
      • Manage tools
      • Refresh data
      • Manage containers
    • Operation and maintenance
      • In-depth inspection
        • Overview
        • Configure inspection items
        • Initiate an in-depth inspection
          • Initiate an in-depth inspection for a single object
          • Initiate a global in-depth inspection
          • Initiate an in-depth inspection for multiple objects
        • View an inspection task
        • Manage an inspection report
          • View an inspection report
          • Download an inspection report
      • High availability testing
        • Create a high availability test
        • View the high availability test
    • System security
      • Use the task center
      • Manage packages
      • Manage users
      • Audit operations
      • System parameters
        • View and modify system parameters
        • OAT configuration parameters
  • oatcli
  • Upgrade Guide
  • Release Notes
    • OAT V4.5.2
    • OAT V4.5.1
    • OAT V4.5.0
    • OAT V4.4.1
    • OAT V4.4.0
    • OAT V4.3.2
    • OAT V4.3.1
    • OAT V4.3.0
  • FAQ

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Admin Tool
  3. V4.5.2

Install, upgrade, and uninstall OMS in separated mode

Last Updated:2026-09-03 09:50:34

Prerequisites
Considerations
Install OMS in separated mode
Upgrade OMS
Uninstall OMS
What to do next

This topic describes how to install, upgrade, and uninstall OMS in separated mode by using OAT.

Prerequisites

Before you install OMS in separated mode, 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 OMS. For more information, see Add a server.
  • Your server meets the requirements for installing OMS. For more information, see Resource configuration specifications of OMS.
  • You have created the MetaDB component for OMS. For more information, see Create MetaDB.

Considerations

  • In a multi-region deployment, each region must have a Management Container and a Component Container.
  • The console (8089) and CM (8088) services reside in the Management Container. When configuring load balancing, follow the deployment pattern of the Management Container, setting up one load balancing rule per region.
  • The Management Container supports setting a primary region: after setting a primary region, only the first management node in the primary region starts the console and CM services; other management container nodes only start the CM service.

Install OMS in separated mode

To install OMS in separated mode, perform the following steps:

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

  2. On the Product Management page, click Install Product in the upper-right corner and choose Install OMS.

  3. In the dialog box that appears, select Separated Mode.

  4. On the Install OMS page, configure the parameters for Console Configuration:

    Parameter
    Description
    OMS Console Image Select an OMS console image.
    Product Name Specify a product name that must be unique.
    Region Select the region to which the server belongs.
    Server Select the IP address of the server where OMS Console is to be installed.
    Is Primary Region Specify whether the region is the primary region. You can specify one or not specify any.
    CPU Set the number of CPU cores available to OMS Console on each server. Default: 8C.
    Memory Set the memory available to OMS Console on each server. Default: 32G.
    HTTP Port The port on which the product provides HTTP services. Default: 8089. This value cannot be modified.
    Data Directory The storage path for data generated during OMS Console runtime. Default: /home/admin/logs/oms_console.
  5. On the Install OMS page, configure the parameters for Component Configuration:

    Parameter
    Description
    OMS Component Image Select an OMS component image.
    Product Name Specify a product name that must be unique.
    Region Select the region to which the server belongs.
    Server Select the IP address of the server where OMS Component is to be installed.
    CPU Set the number of CPU cores available to OMS Component on each server. Default: 8C.
    Memory Set the memory available to OMS Component on each server. Default: 32G.
    Data Directory The storage path for data generated during OMS Component runtime. Default: /home/admin/logs/oms_component.
  6. On the Install OMS page, configure the parameters for MetaDB Configuration:

    Parameter
    Description
    MetaDB Type Select the type of database to store. Options:
    • Created MetaDB
    • Other OB_MySQL
    Select Created MetaDB Select an existing MetaDB for OMS.
    Tenant Name The name of the tenant. Default: oms_meta.
    Tenant Password The password of the tenant.
    Tenant CPU Set the number of CPU cores available to MetaDB on each server. Default: 2C.
    Memory Set the memory available to MetaDB on each server. Default: 5G.
  7. On the Install OMS page, configure the parameters for InfluxDB Configuration:

    Parameter
    Description
    Time Series Database Storage Select the type of InfluxDB. Options:
    • Created InfluxDB
    • Other InfluxDB
    Select Created InfluxDB Select an existing InfluxDB for OMS..
    Database Account The account for OMS InfluxDB. Default value: influxdb_user.
    Database Password The password for OMS InfluxDB.
  8. On the Install OMS page, configure the parameters for Load balancing configuration:

    The options of load balancing modes are as follows:

    • Created NLB: NLB automatically adds a load rule for the product's actual HTTP service address based on the VIP and VPORT you entered. Additionally, if you have selected "Created MetaDB", NLB will also automatically add a load rule for MetaDB.

      Parameter
      Description
      Select Created NLB Select an existing NLB.
      Console VIP The Console VIP is automatically filled in and cannot be edited.
      Console Service Port Specify the Console service port number.
      CM VIP The CM VIP is automatically filled in and cannot be edited.
      CM Service Port Specify the CM service port number.
    • OBDNS has been created.: OBDNS automatically adds a load rule for the product's actual HTTP service address based on the Domain Name and VPORT you entered. Additionally, if you have selected "Created MetaDB", OBDNS will also automatically handle domain name resolution for MetaDB-related servers.

      Parameter
      Description
      Select Created OBDNS Select an existing OBDNS.
      OMS Console HTTP Proxy Domain Name Specify the OMS console HTTP proxy domain name.
      OMS Console HTTP Proxy Port Specify the OMS console HTTP proxy port.
      OMS CM Component HTTP Proxy Domain Name Specify the OMS CM component HTTP proxy domain name.
      OMS CM Component HTTP Proxy Port Specify the OMS CM component HTTP proxy port. Default value: 8088.
    • Other load balancing:

      Parameter
      Description
      MetaDB TCP Proxy Address Specify the MetaDB TCP proxy address.
      MetaDB TCP Proxy Port Specify the MetaDB TCP proxy port. Default value: 3306.
      OMS Console HTTP Proxy IP Specify the OMS console HTTP proxy IP.
      OMS Console HTTP Proxy Port Specify the OMS console HTTP proxy port.
      OMS CM Component HTTP Proxy IP Specify the OMS CM component HTTP proxy IP.
      OMS CM Component HTTP Proxy Port Specify the OMS CM component HTTP proxy port.
    • Do Not Use: Choosing not to use load balancing will result in the loss of high availability. By default, the IP address of the first server is used as the connection information.

  9. After configuring OMS, click Submit.

    If your configuration is incorrect, click Reset to restore the default configuration with one click.

Upgrade OMS

To upgrade OMS, perform the following steps:

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

  2. Find the OMS service to be upgraded and click its name in the Name column to go to the details page.

    Note

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

  3. In the upper-right corner of the details page, click Upgrade.

  4. In the Upgrade dialog box, enter the required information.

    The following options are available for the upgrade method:

    • Service suspension for upgrades: Suitable for products without business continuity requirements. During the upgrade, the service of the old product version is stopped first and cannot provide external services.

      Parameter
      Description
      Console Upgrade Image File Select the image file for console upgrade.
      Component Upgrade Image File Select the image file for component upgrade.
    • Grayscale upgrade: Performs upgrades on new servers in rotation. After the upgrade is complete, you need to manually change the load balancing traffic.

      Parameter
      Description
      Console Upgrade Image File Select the image file for console upgrade.
      Upgrade Tool Image File Select the image file for the upgrade tool.
  5. After configuration, click OK.

Uninstall OMS

To uninstall OMS, perform the following steps:

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

  2. Find the OMS service to be uninstalled and click its name in the Name column to go to the details page.

    Note

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

  3. In the upper-right corner of the details page, click Uninstall.

  4. In the confirmation dialog box that appears, click Uninstall.

    OAT displays a message indicating that the uninstallation is in progress. OAT also creates an uninstallation task. You can click the task ID in the confirmation dialog box to view the execution progress of the current uninstallation task.

What to do next

After you install OMS, you can use it to migrate data. For more information, see OMS documentation.

Previous topic

Install, upgrade, and uninstall OMS in single-node mode
Last

Next topic

Install, upgrade, roll back, and uninstall OAS
Next
on this page
Prerequisites
Considerations
Install OMS in separated mode
Upgrade OMS
Uninstall OMS
What to do next