Start on Cloud

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

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 Cloud

OceanBase Database

Tools Connectors and Middleware

QUICK START

OceanBase Cloud OceanBase 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

OceanBase Deployer

OceanBase Deployer (obd) is a tool for installing and deploying open source OceanBase software. It is also a package manager for managing all open source OceanBase software.

Download

Build a Business System

Quickly start

obd Commands

Use obd to add GUI-based monitoring for existing clusters

1
Deploy obd
You can use the OceanBase All in One package, RPM package or source code to deploy obd.
For more information, see "Install obd".
2
Quickly deploy OCP (OceanBase Cloud Platform )
You can run the obd web command and visit the generated URL to access the obd GUI. Then, quickly deploy the OceanBase Cloud Platform (OCP) to gain experience.
For more information, see the "Quickly deploy OCP".
3
Deploy OceanBase Database in a test environment
You can use the obd demo command to directly deploy and start specified components on your local server without the need to load configuration files.
For more information, see the "Quickly deploy OceanBase Database".

Dive Deep into OBD

obd FAQ
Learn more about how to resolve issues encountered when you use obd
Documents
obd Error Codes
Learn more about the obd error codes and solutions
Documents

OceanBase Deployer

V3.2.1Community Edition

What is obd
Quick Start
- Install obd
- Quickly deploy OceanBase Database
- Quickly deploy OCP
obd Command
- Quick deployment command
- Cluster commands
- Mirror and repository commands
- Testing commands
- Tool commands
- obdiag commands
- Binlog commands
- Host commands
- License commands
- Password commands
- Telemetry commands
User Guide
- Overview
- Deploy through GUI
  - GUI operation overview
  - Mode configuration rules
  - Deploy an OceanBase cluster on the GUI
  - Deploy OCP through the GUI
  - Modify components on the GUI
  - Upgrade OCP on the GUI
- Deploy through CLI
  - Configuration files
  - Deploy Component
    - Deploy OceanBase Database on a single OBServer node
    - Deploy OCP Express by using commands
    - Deploy and use obconfigserver
    - Deploy the obbinlog
    - Deploy oblogproxy by using the CLI
    - Deploy OCP by using commands
  - Manage Cluster
    - Physical Standby Database
      - Deploy primary and standby tenants by using obd
      - Switch the roles of tenants and decouple a standby tenant from the primary tenant
    - Scale out a cluster and change cluster components
    - Performance test
    - Cluster diagnotistics
    - Add GUI-based monitoring for an existing cluster
  - Takeover Cluster
    - Use OCP to take over a cluster deployed by obd
    - Use obd to take over a cluster
  - Upgrade Component
    - Upgrade OceanBase Database
    - Upgrade ODP
    - Upgrade OCP Express
  - Backup and restore
Upgrade obd
FAQ
Error codes
Release Notes
- Version rules
- 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 Deployer V2.8.0
- V2.7
  - OceanBase Deployer V2.7.0
- V2.6
  - OceanBase Deployer V2.6.2
  - OceanBase Deployer V2.6.1
  - OceanBase Deployer V2.6.0
- V2.5
  - OceanBase Deployer V2.5.0
- V2.4
  - OceanBase Deployer V2.4.0
- V2.3
  - OceanBase Deployer V2.3.1
  - OceanBase Deployer V2.3.0
- V2.2
  - OceanBase Deployer V2.2.0
- V2.1
  - OceanBase Deployer V2.1.1
  - OceanBase Deployer V2.1.0
- V2.0
  - OceanBase Deployer V2.0.1
  - OceanBase Deployer 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

Download PDF

OceanBase Deployer

OceanBase Deployer (obd) is a tool for installing and deploying open source OceanBase software. It is also a package manager for managing all open source OceanBase software.

Download

Build a Business System

Quickly start

obd Commands

Use obd to add GUI-based monitoring for existing clusters

1
Deploy obd
You can use the OceanBase All in One package, RPM package or source code to deploy obd.
For more information, see "Install obd".
2
Quickly deploy OCP (OceanBase Cloud Platform )
You can run the obd web command and visit the generated URL to access the obd GUI. Then, quickly deploy the OceanBase Cloud Platform (OCP) to gain experience.
For more information, see the "Quickly deploy OCP".
3
Deploy OceanBase Database in a test environment
You can use the obd demo command to directly deploy and start specified components on your local server without the need to load configuration files.
For more information, see the "Quickly deploy OceanBase Database".

Dive Deep into OBD

obd FAQ
Learn more about how to resolve issues encountered when you use obd
Documents
obd Error Codes
Learn more about the obd error codes and solutions
Documents