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

Install and uninstall OBDNS

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

Prerequisites
Install OBDNS
Uninstall OBDNS
What to do next

This topic describes how to install and uninstall OBDNS in the OceanBase Admin Toolkit (OAT) console.

Prerequisites

Before you install OBDNS, make sure that the following conditions are met:

  • You have installed OAT and logged on as either a super administrator or an O&M engineer. For more information, see Install OAT.
  • You have added a server where OBDNS is to be installed. For more information, see Add a server.
  • You have added an OBDNS image file.
  • The server meets the requirements for installing OBDNS.

Install OBDNS

To install OBDNS, perform the following steps:

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

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

  3. On the Create OBDNS page, configure the parameters.

    The following table describes the basic parameters of OBDNS.

    Parameter
    Description
    OBDNS Image The Docker image of OBDNS.
    Component Name The name of the component, which must be unique. Default value: obdns.
    Server The IP address of the server where OBDNS is to be installed.
    CPU The number of CPU cores on the server available for OBDNS. Default value: 4C.
    Memory The memory on the server available for OBDNS. Default value: 128G.
    Basic Domain Name The base domain name of OBDNS.
    Log Directory The data persistence directory of OBDNS. Default value: /home/admin/logs/obdns.

    The following table describes the data storage parameters of OBDNS.

    Parameter
    Description
    Peer Port The peer port of the internal ETCD. Default value: 2380.
    Client Port The port used by the internal ETCD to receive client requests. Default value: 2379.
  4. After you set the parameters, click Submit.

    You can also click Reset to restore to the default configurations.

Uninstall OBDNS

To uninstall OBDNS, perform the following steps:

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

  2. Find the target OBDNS service and click Uninstall in the Actions column.

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

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

    OAT displays a message indicating that the service is being uninstalled. OAT also creates an uninstallation task. In the confirmation dialog box that appears, you can click the task ID to view the task progress.

    Notice

    If OBDNS is associated with another product, the uninstallation will fail.

What to do next

After you install OBDNS, you can install other products in the OceanBase ecosystem on multiple nodes.

Previous topic

Install and uninstall MetaDB
Last

Next topic

Install and uninstall InfluxDB
Next
on this page
Prerequisites
Install OBDNS
Uninstall OBDNS
What to do next