Meet OceanBase AI Database, the unified database for operational data, real-time analytics, and AI. Explore ->

Meet OceanBase AI Database, the unified database for operational data, real-time analytics, and AI. Explore ->

OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

Product Overview
DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

Product Overview
DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Deployer

V4.3.0Community Edition

  • What is obd
  • Quick Start
    • Install obd
    • Quick deployment of OceanBase Database
    • Quickly deploy OCP
  • obd Command
    • Quick deployment commands
    • Cluster commands
    • Command groups
    • Image and repository commands
    • Test command groups
    • Tool commands
    • obdiag commands
    • Binlog service commands
    • Hardware commands
    • License commands
    • Password commands
    • Telemetry commands
  • User Guide
    • Usage overview
    • Deploy through GUI
      • Overview
      • Pattern configuration rules
      • Deploy an OceanBase cluster
      • Deploy OCP
      • Deploy OMS
      • Change components
      • Upgrade OCP
      • Upgrade OMS
    • Deploy through CLI
      • Configuration file
      • Component deployment
        • Deploy an OceanBase cluster
        • Deploy seekdb
        • Deploy obconfigserver
        • Deploy OMS
        • Deploy OCP
        • Deploy Alertmanager
        • Deploy obbinlog
        • Deploy oblogproxy
      • Cluster management
        • Physical Standby Database
          • Create a standby tenant
          • Role switching and decoupling
          • Switch the synchronization mode between primary and standby tenants
        • seekdb primary/standby instance
          • Create a standby instance
          • Role switching and decoupling
        • Scale out and component changes
        • Performance test
        • Diagnose a cluster
        • Backup and restore
        • Add a GUI monitoring system to an existing cluster
      • Cluster management
        • Use OCP to take over an OceanBase cluster deployed by obd
        • Take over an OceanBase cluster
      • Component upgrade
        • Upgrade OceanBase Database
        • Upgrade ODP
        • Upgrade OMS
  • Upgrade obd
  • FAQ
  • Error codes
  • Release Notes
    • Version rules
    • V4.3
      • OceanBase Deploy V4.3.0
    • V4.2
      • OceanBase Deployment Tool V4.2.0
    • V4.1
      • OceanBase Deployer V4.1.0
    • V4.0
      • OceanBase Deployer V4.0.0
    • V3.6
      • OceanBase Deployer V3.6.0
    • V3.5
      • OceanBase Deployer V3.5.0
    • V3.4
      • OceanBase Deployer V3.4.0
    • V3.3
      • OceanBase Deployer V3.3.0
    • V3.2
      • OceanBase Deployer V3.2.2
      • OceanBase Deployer V3.2.1
      • OceanBase Deployer V3.2.0
    • V3.1
      • OceanBase Deployer V3.1.2
      • OceanBase Deployer V3.1.1
      • OceanBase Deployer V3.1.0
    • V3.0
      • OceanBase Deployer V3.0.1
      • OceanBase Deployer V3.0.0
    • V2.10
      • OceanBase Deployer V2.10.1
      • OceanBase Deployer V2.10.0
    • V2.9
      • OceanBase Deployer V2.9.2
      • OceanBase Deployer V2.9.1
      • OceanBase Deployer V2.9.0
    • V2.8
      • OceanBase Deployment Tool V2.8.0
    • V2.7
      • OceanBase Deployment Tool V2.7.0
    • V2.6
      • OceanBase Deployment Tool V2.6.2
      • OceanBase Deployment Tool V2.6.1
      • OceanBase Deployment Tool V2.6.0
    • V2.5
      • OceanBase Deployer V2.5.0
    • V2.4
      • OceanBase Deployer V2.4.0
    • V2.3
      • OceanBase Deployment Tool V2.3.1
      • OceanBase Deployer V2.3.0
    • V2.2
      • OceanBase Deployment Tool V2.2.0
    • V2.1
      • OceanBase Deployer V2.1.1
      • OceanBase Deployment Tool V2.1.0
    • V2.0
      • OceanBase Deployment Tool V2.0.1
      • OceanBase Deployment Tool V2.0.0
    • V1.6
      • OceanBase Deployer V1.6.2
      • OceanBase Deployer V1.6.1
      • OceanBase Deployer V1.6.0
    • V1.5
      • OceanBase Deployer V1.5.0
    • V1.4
      • OceanBase Deployer V1.4.0
    • V1.3
      • OceanBase Deployer V1.3.3
      • OceanBase Deployer V1.3.2
      • OceanBase Deployer V1.3.0
    • V1.2
      • OceanBase Deployer V1.2.1
      • OceanBase Deployer V1.2.0
  • Interactive deployment of OceanBase Database Community Edition
  • Deploy a Community Edition cluster using the obd graphical interface
  • Deploy a Community Edition cluster by using an obd configuration file

Download PDF

What is obdInstall obdQuick deployment of OceanBase DatabaseQuickly deploy OCPQuick deployment commandsCluster commandsCommand groupsImage and repository commandsTest command groupsTool commandsobdiag commandsBinlog service commandsHardware commandsLicense commandsPassword commandsTelemetry commandsUsage overviewOverviewPattern configuration rulesDeploy an OceanBase clusterDeploy OCPDeploy OMSChange componentsUpgrade OCPUpgrade OMSConfiguration fileUpgrade obdFAQError codesVersion rulesOceanBase Deploy V4.3.0OceanBase Deployment Tool V4.2.0OceanBase Deployer V4.1.0OceanBase Deployer V4.0.0OceanBase Deployer V3.6.0OceanBase Deployer V3.5.0OceanBase Deployer V3.4.0OceanBase Deployer V3.3.0OceanBase Deployer V3.2.2OceanBase Deployer V3.2.1OceanBase Deployer V3.2.0OceanBase Deployer V3.1.2OceanBase Deployer V3.1.1OceanBase Deployer V3.1.0OceanBase Deployer V3.0.1OceanBase Deployer V3.0.0OceanBase Deployer V2.10.1OceanBase Deployer V2.10.0OceanBase Deployer V2.9.2OceanBase Deployer V2.9.1OceanBase Deployer V2.9.0OceanBase Deployment Tool V2.8.0OceanBase Deployment Tool V2.7.0OceanBase Deployment Tool V2.6.2OceanBase Deployment Tool V2.6.1OceanBase Deployment Tool V2.6.0OceanBase Deployer V2.5.0OceanBase Deployer V2.4.0OceanBase Deployment Tool V2.3.1OceanBase Deployer V2.3.0OceanBase Deployment Tool V2.2.0OceanBase Deployer V2.1.1OceanBase Deployment Tool V2.1.0OceanBase Deployment Tool V2.0.1OceanBase Deployment Tool V2.0.0OceanBase Deployer V1.6.2OceanBase Deployer V1.6.1OceanBase Deployer V1.6.0OceanBase Deployer V1.5.0OceanBase Deployer V1.4.0OceanBase Deployer V1.3.3OceanBase Deployer V1.3.2OceanBase Deployer V1.3.0OceanBase Deployer V1.2.1OceanBase Deployer V1.2.0Interactive deployment of OceanBase Database Community EditionDeploy a Community Edition cluster using the obd graphical interfaceDeploy a Community Edition cluster by using an obd configuration file
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogWhite PaperLive DemosTraining & CertificationTicket
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Deployer
  3. V4.3.0
iconOceanBase Deployer
V 4.3.0Community Edition
Databases
  • OceanBase Database
  • OceanBase Cloud
  • OceanBase Tugraph
  • Interactive Tutorials
  • OceanBase Best Practices
Tools
  • OceanBase Cloud Platform
  • OceanBase Migration Service
  • OceanBase Developer Center
  • OceanBase Migration Assessment
  • OceanBase Admin Tool
  • OceanBase Loader and Dumper
  • OceanBase Deployer
  • Kubernetes operator for OceanBase
  • OceanBase Diagnostic Tool
  • OceanBase Binlog Service
Connectors and Middleware
  • OceanBase Database Proxy
  • Embedded SQL in C for OceanBase
  • OceanBase Call Interface
  • OceanBase Connector/C
  • OceanBase Connector/J
  • OceanBase Connector/ODBC
  • OceanBase Connector/NET
Community Edition
  • V 4.3.0
  • V 3.2.1
  • V 3.2.0
  • V 3.1.0
  • V 3.0.0
  • V 2.10.1
  • V 2.10.0
  • V 2.9.0
  • V 2.8.0
  • V 2.7.0
  • V 2.6.0
  • V 2.5.0
  • V 2.4.0
  • V 2.3.1
  • V 2.3.0
  • V 2.2.0
  • V 2.1.0
  • V 2.0.0
  • V 1.6.1

FAQ

Last Updated:2026-06-30 14:40:58  Updated
Share
What is on this page
How do I specify the version of the component to use?
How do I specify a specific version of the component?
What should I do if I modify the code of OceanBase-CE and need to modify the startup process?
How do I update the local image of obd in offline mode?
How do I resolve the issue where ODP service cannot be started after obd upgrade?
How do I configure the Java environment?
Online installation
Offline installation
How do I manage the original metadb cluster after upgrading OCP using obd?
What should I do if I cannot use obd properly after installing it on a machine that already has OceanBase All in One installed?

folded

Share

How do I specify the version of the component to use?

You can use a version declaration in the deployment configuration file. For example, if you are using OceanBase-CE 3.1.0, you can specify the following configuration:

oceanbase-ce:
  version: 3.1.3  # Specify the version

You can use the following commands to obtain the component version based on your deployment method (offline or online).

  • For online deployment, use the following command to obtain the component version. The version in the output is the version number.

    obd mirror list oceanbase.community.stable
    
  • For offline deployment, use the following command to obtain the component version. The version in the output is the version number.

    obd mirror list local
    

How do I specify a specific version of the component?

You can use package_hash or tag in the deployment configuration file. If you have set a tag for your self-compiled OceanBase-CE, you can use tag to specify it. For example:

oceanbase-ce:
  tag: my-oceanbase

You can also use package_hash to specify a specific version.

oceanbase-ce:
  package_hash: 589c4f8ed2662835148a95d5c1b46a07e36c2d346804791364a757aef4f7b60d

You can use the following commands to obtain the component package hash based on your deployment method (offline or online).

  • For online deployment, use the following command to obtain the component package hash. The md5 value in the output is the package_hash.

    obd mirror list oceanbase.community.stable
    
  • For offline deployment, use the following command to obtain the component package hash. The md5 value in the output is the package_hash.

    obd mirror list local
    

What should I do if I modify the code of OceanBase-CE and need to modify the startup process?

You can modify the startup-related plugins in the ~/.obd/plugins/oceanbase-ce/ directory. For example, if you add a new startup configuration for OceanBase-CE 3.1.0, you can modify the ~/.obd/plugins/oceanbase-ce/3.1.0/start.py file.

How do I update the local image of obd in offline mode?

If the machine where you installed obd cannot connect to the public internet, but you need to update obd or other components, you can follow these steps:

  1. Download the required RPM package on a machine that can connect to the public internet.

  2. Copy the RPM package to the machine where obd is installed.

  3. Use the obd mirror clone command to add the new RPM package to the local mirror.

Here is an example of updating the local image of obd:

# First, download the latest RPM package of obd on a machine that can connect to the public internet.
# The latest RPM package link can be found in the release notes of the corresponding component's Git repository or on the OceanBase Open Source website (https://open.oceanbase.com/softwareCenter/community).
wget https://github.com/oceanbase/obdeploy/releases/download/vx.x.x/ob-deploy-x.x.x-xxx.rpm
# Copy the downloaded RPM package to the machine where obd is installed (obd_server).
sh ob-deploy-x.x.x-xxx.rpm obd_server:~
# Add the downloaded image to the local mirror.
obd mirror clone ob-deploy-x.x.x-xxx.rpm
# Disable the remote mirror source.
obd mirror disable remote

How do I resolve the issue where ODP service cannot be started after obd upgrade?

After obd is upgraded, the password of ODP is initialized. If you have set obproxy_sys_password, you need to execute the following command to connect to proxysys:

obclient -h<obproxy_ip> -uroot@proxysys -P<obproxy_port> -p<obproxy_pwd>

Note

If you cannot connect to proxysys using the command you set, try connecting with an empty password or proxysys.

Then, use the command alter proxyconfig set obproxy_sys_password = '' to set the proxysys password to an empty string, or make it consistent with the password in the configuration file's obproxy_sys_password.

How do I configure the Java environment?

Log in to the machine where you want to configure the Java environment and install the Java environment based on the machine's network connectivity.

Online installation

On CentOS or RedHat systems, execute the following commands:

sudo yum install java-1.8.0-openjdk 

On Ubuntu or Debian systems, execute the following commands:

sudo apt-get update
sudo apt-get install openjdk-8-jre

Offline installation

  1. Click the x86_64 architecture and arm architecture links to download the required installation package.

  2. Upload the downloaded installation package to the corresponding machine and execute the following commands in the directory where the installation package is located to decompress and install it.

    # Decompress the resource package
    tar -zxvf Alibaba_Dragonwell_Extended_8*.tar.gz
    # Enter the decompressed directory
    cd dragonwell*
    # Create a symbolic link
    ln -s `pwd`/bin/java /usr/bin/java
    

How do I manage the original metadb cluster after upgrading OCP using obd?

After upgrading OCP using obd, if you want to use obd to manage the original OCP's metadb cluster, you can copy the information of the original metadb cluster to the obd directory. The command is as follows:

cp -rf ~/.ocp-installer/cluster/<metadb_cluster_name> ~/.obd/cluster/

Here, metadb_cluster_name represents the name of the original metadb cluster, which you need to replace based on your actual situation.

What should I do if I cannot use obd properly after installing it on a machine that already has OceanBase All in One installed?

If you encounter the following prompt when installing obd using the obd RPM package on a machine that already has OceanBase All in One installed:

Detected residual environment variables of oceanbase-all-in-one in the system. Please execute `rm -rf ~/.obd/version && rm -rf ~/.oceanbase-all-in-one/obd && obd env set OBD_INSTALL_PRE / ` under the user who installed all-in-one and rerun.

To ensure the normal use of obd, it is recommended to execute the command in the current user environment to modify the OBD_INSTALL_PRE value:

rm -rf ~/.obd/version && rm -rf ~/.oceanbase-all-in-one/obd && obd env set OBD_INSTALL_PRE /

Note

It is not recommended to install the obd RPM package after installing OceanBase All in One. If you need to use other versions of obd, it is recommended to install the corresponding version of OceanBase All in One. For more information about how to install OceanBase All in One, see Install obd for Install obd by using OceanBase All in One.

Previous topic

Upgrade obd
Last

Next topic

Error codes
Next
What is on this page
How do I specify the version of the component to use?
How do I specify a specific version of the component?
What should I do if I modify the code of OceanBase-CE and need to modify the startup process?
How do I update the local image of obd in offline mode?
How do I resolve the issue where ODP service cannot be started after obd upgrade?
How do I configure the Java environment?
Online installation
Offline installation
How do I manage the original metadb cluster after upgrading OCP using obd?
What should I do if I cannot use obd properly after installing it on a machine that already has OceanBase All in One installed?