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 ServiceOceanBase DataPilot

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 ServiceOceanBase DataPilot
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Admin Tool

V4.2.1
  • What's New
  • Product introduction
    • What is OAT?
    • Architecture
    • Concepts
  • Quick start
    • Install OAT
    • Get started with OAT
  • oatcli
  • Upgrade guide
  • User guide
    • Log on to OAT
    • Page layout of the OAT console
    • Servers
      • Add a server
      • Edit a server
      • Perform O&M operations on a server
      • Remove a server
      • Manage credentials
    • Product services
      • Install, upgrade, and uninstall OCP
      • Install, upgrade, and uninstall ODC
      • Install, upgrade, and uninstall OMS
      • Install, Upgrade, Modify, and Uninstall OBSharding
      • Install and uninstall MetaDB
      • Install and uninstall OBDNS
      • Install and uninstall InfluxDB
      • Install and uninstall NLB
      • Install and uninstall OpenSearch
      • Install and uninstall SQLAuditStore
      • Install and uninstall OBLB
      • Take over OCP
      • Take over ODC
      • Take over OBSharding
      • Take over OMS
      • Take over MetaDB
      • Take over OBDNS
      • Take over InfluxDB
      • Take over NLB
      • Manage images
      • Modify the resources of products and components
      • Manage tools
      • Refresh data
      • Container operations
    • System security
      • Task center
      • Package management
      • User management
      • Operation audit
      • System parameter
        • View and modify system parameters
        • OAT configuration parameters
  • FAQ

Download PDF

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

Take over OBSharding

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

Prerequisites
Procedure
What to do next

This topic describes how to take over OBSharding in the OceanBase Admin Toolkit (OAT) console. Earlier versions of OAT cannot be smoothly upgraded to the current version because the new version has been restructured. Therefore, the current version of OAT must take over the products and components deployed by using earlier versions of OAT to monitor their status and manage their upgrades.

Prerequisites

Before you take over OBSharding, make sure that the following conditions are met:

  • You have added the image used by OBSharding.

  • You have taken over the components that OBSharding depends on.

  • You have added a server to take over OBSharding. For more information, see Add a server.

  • The server meets the requirements for taking over OBSharding.

Procedure

To take over OBSharding, perform the following steps:

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

  2. On the Product Management page, click Take Over Products in the upper-right corner, and choose Take Over OBSharding.

  3. On the Take Over OBSharding page, configure the parameters.

    The following table describes the basic parameters of OBSharding.

    Parameter
    Description
    OBSharding Console Image The Docker image of the OBSharding console.
    Product Name The name of the product, which must be unique.
    Server The IP address of the server to take over OBSharding.
    CPU The number of CPU cores on the server available for OBSharding. Default value: 8C.
    Memory The memory on the server available for OBSharding. Default value: 20G.

    The following table describes the parameters of the OBSharding server.

    Parameter
    Description
    OBSharding Server Image The Docker image of the OBSharding server.
    Server The IP address of the server where the OBSharding server is to be installed.
    Service Port The port number of the OBSharding server.
    CPU The number of CPU cores on the server available for OBSharding. Default value: 8C.
    Memory The memory on the server available for OBSharding. Default value: 16G.

    The following table describes the MetaDB parameters of OBSharding.

    Parameter
    Description
    MetaDB Type Select the type of MetaDB.
    Select Created MetaDB Select an existing MetaDB.

    The following table describes the load balancing parameters, which are optional.

    Parameter
    Description
    Load Balancing Mode Select the load balancing mode.
    MetaDB TCP Proxy IP The proxy IP address or domain name used by the OBSharding console to connect to MetaDB.
    MetaDB TCP Proxy Port The proxy port used by the OBSharding console to connect to MetaDB. Default value: 3306.
    OBSharding Console HTTP Proxy IP The IP address for accessing the OBSharding console.
    OBSharding Console HTTP Proxy Port The port for accessing the OBSharding console. Default value: 80.
  4. After you set the parameters, click Submit. You can also click Reset to restore to the default configurations.

What to do next

After you take over OBSharding, you can upgrade it. For more information, see Upgrade OBSharding.

Previous topic

Take over ODC
Last

Next topic

Take over OMS
Next
on this page
Prerequisites
Procedure
What to do next