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

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

Select Version

OceanBase Deployer

OceanBase Deployer (obd) is an installation and deployment tool for OceanBase. It also provides common O&M capabilities such as package management, benchmarking, and cluster management.

Download

Build a Business System

Quick Start

obd Commands

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
Deploy a test environment for OceanBase Database
You can use the obd demo command to deploy and start specified components directly on the local machine without providing a configuration file.
For more information, see the "Quick deployment of OceanBase Database".
3
Quickly deploy OCP
You can use the obd web command to launch the obd graphical interface, where you can quickly deploy and try out OceanBase Cloud Platform (OCP).
For more information, see the "Quickly deploy OCP".

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

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

OceanBase Deployer

Select Version

OceanBase Deployer

OceanBase Deployer (obd) is an installation and deployment tool for OceanBase. It also provides common O&M capabilities such as package management, benchmarking, and cluster management.

Download

Build a Business System

Quick Start

obd Commands

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
Deploy a test environment for OceanBase Database
You can use the obd demo command to deploy and start specified components directly on the local machine without providing a configuration file.
For more information, see the "Quick deployment of OceanBase Database".
3
Quickly deploy OCP
You can use the obd web command to launch the obd graphical interface, where you can quickly deploy and try out OceanBase Cloud Platform (OCP).
For more information, see the "Quickly deploy OCP".

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