OceanBase logo
  • Products
    OceanBase database

    Products

    High-quality database products to meet full lifecycle enterprise data management needs.

    OceanBase Dedicated
    A fully-managed cloud DBaaS for mission-critical workloads at any scale, effortlessly handles your most demanding workloads.
    OceanBase Database
    The ideal solution for running OceanBase on-premises or in your private and hybrid clouds, allowing you to manage the entire OceanBase lifecycle seamlessly.
  • Solutions
    OceanBase database

    Solutions

    Enterprise data management solutions for all scenarios

    View All
    Multi-Scenario General OLTP
    The next-generation native distributed architecture provides users with high scalability with low costs.
    Real-time Analytics
    Use one set of data for both OLTP and OLAP tasks, realizing real-time analytics while saving ETL process.
    Database Consolidation
    The distributed multi-tenant architecture realizes resource pooling while ensuring isolation and availability.
    Multi-cloud Architecture
    Navi Item Support multi-cloud, cross-cloud, or hybrid cloud deployment architecture.
    Cold Data Archiving
    The intelligent archive database solution helps users quickly archive cold data with reduced costs.
    Database Scaling
    Real-time high concurrency, multi-level elastic scaling with minimum cost implementation for massive online promotions.
    Database Active Geo-redundancy
    High availability architecture to support the core business scenarios with fast recovery, and zero data loss.
  • Customers
    OceanBase database

    Customers

    Check our successful cases to inspire your business

    View All
    Fintech
    GCash
    DANA
    Alipay
    Easypaisa
    Digital Economy
    Haidilao
    POP MART
    Kwai
    Ctrip
    Enterprise
    ICBC
    China Mobile Jiangsu
    Sinopec
  • Resources
    OceanBase database

    Resources

    Various types of resources about OceanBase and the database industry

    White Paper
    Find white papers about OceanBase and the distributed database technology.
    Blog
    Find the product features, best practices, customer cases and latest distributed database insights from the experts in OceanBase Blog.
    Training and Certification
    Learn about OceanBase's core technologies and distinctive features, get your skill certificate.
    GitHub
    View the source code of OceanBase, participate in co building open source projects.
  • Docs
    OceanBase database

    Docs

    Rich content to meet the content demands of using products and solving product usage problems

    View All
    Products
    OceanBase DatabaseOceanBase Cloud
    OceanBase DatabaseOceanBase Database
    Tools
    Connectors and Middleware
    Quick Start
    OceanBase Cloud
    OceanBase Database
    Architecture Overview
    Explore the architecture and technology of distributed database
OceanBase logo
编组
icon

OceanBase Deployer

V2.7.0Community Edition
 
箭头
  • What is OBD
  • Quick Start
    • Install and configure OBD
    • Quickly start OceanBase Database
    • Deploy an OceanBase cluster on the GUI
  • OBD Command
    • Quick deployment command
    • Cluster commands
    • Mirror and repository commands
    • Testing commands
    • Tool commands
    • obdiag commands
    • Telemetry commands
  • User Guide
    • Configuration files
    • Deploy through GUI
      • GUI operation overview
      • Deploy OCP through the GUI
    • Deploy through CLI
      • Deploy OceanBase Database on a single OBServer node
      • Deploy OCP Express by using commands
      • Deploy and use Config Server
      • Deploy OBLogProxy by using the CLI
      • Use OCP to take over a cluster deployed by OBD
      • Add GUI-based monitoring for an existing cluster
      • Upgrade OCP Express
      • Upgrade OceanBase Database
      • 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
  • FAQ
    • FAQ
    • How do I upgrade an OBProxy to obproxy-ce 3.2.3?
  • Mode configuration rules
  • Error codes
  • Release Notes
    • Version rules
    • 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

What is OBD Install and configure OBD Quickly start OceanBase Database Deploy an OceanBase cluster on the GUI Quick deployment command Cluster commands Mirror and repository commands Testing commands Tool commands obdiag commands Telemetry commands Configuration files GUI operation overview Deploy OCP through the GUI Deploy OceanBase Database on a single OBServer node Deploy OCP Express by using commands Deploy and use Config Server Deploy OBLogProxy by using the CLI Use OCP to take over a cluster deployed by OBD Add GUI-based monitoring for an existing cluster Upgrade OCP Express Upgrade OceanBase Database Scale out a cluster and change cluster components FAQ How do I upgrade an OBProxy to obproxy-ce 3.2.3? Mode configuration rules Error codes Version rules OceanBase Deployer V2.7.0 OceanBase Deployer V2.6.2 OceanBase Deployer V2.6.1 OceanBase Deployer V2.6.0 OceanBase Deployer V2.5.0 OceanBase Deployer V2.4.0 OceanBase Deployer V2.3.1 OceanBase Deployer V2.3.0 OceanBase Deployer V2.2.0 OceanBase Deployer V2.1.1 OceanBase Deployer V2.1.0 OceanBase Deployer V2.0.1 OceanBase Deployer V2.0.0 OceanBase Deployer V1.6.2 OceanBase Deployer V1.6.1 OceanBase Deployer V1.6.0 OceanBase Deployer V1.5.0 OceanBase Deployer V1.4.0 OceanBase Deployer V1.3.3 OceanBase Deployer V1.3.2 OceanBase Deployer V1.3.0 OceanBase Deployer V1.2.1 OceanBase Deployer V1.2.0
iconOceanBase Deployer
Select Version
  • V2.7.0 Community Edition
  • V2.6.0 Community Edition
  • V2.5.0 Community Edition
  • V2.4.0 Community Edition
  • V2.3.1 Community Edition
  • V2.3.0 Community Edition
  • V2.2.0 Community Edition
  • V2.1.0 Community Edition
  • V2.0.0 Community Edition
  • V1.6.1 Community Edition

Build a Business System

Deploy OceanBase Database in a Test Environment and a Production Environment

Use OBD Commands for Management

Use OBD to add GUI-based monitoring for existing clusters

  • 1
    Deploy OBD

    You can use the RPM package or source code to deploy OBD.

    For more information, see "Install OBD".

  • 2
    Use the obd demo command to 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 "Use OBD to deploy OceanBase Database" section in "Quick Experience".

  • 3
    Use Docker to deploy OceanBase Database in a test environment

    You can use the Docker image to deploy OceanBase Database in a test environment.

    For more information, see the "Use Docker to deploy OceanBase Database" section in "Quick Experience".

Your browser does not support the video tag, please update your browser.
  • 1
    Manage clusters

    OBD provides a series of commands for you to deploy, manage, and upgrade OceanBase clusters.

    For more information, see "Cluster commands".

  • 2
    Perform database tests

    OBD provides a series of commands for you to perform basic tests on OceanBase Database.

    For more information, see "Testing commands".

  • 3
    Use tool commands

    OBD provides a series of tool commands, including general commands that deliver a better experience for developers.

    For more information, see "Tool commands".

  • 1
    Add GUI-based monitoring

    OBD supports the deployment of Prometheus and Grafana since V1.6.0. You can add GUI-based monitoring for clusters deployed earlier.

    For more information, see "Add GUI-based monitoring for an existing cluster".

  • 2
    Modify the configurations of a monitored cluster

    After you add GUI-based monitoring for a cluster, you can modify the configurations of the monitored cluster as needed.

    For more information, see the "Modify the configurations of a monitored cluster" section in "Add GUI-based monitoring for an existing cluster".

Dive Deep into OBD

  • OBD FAQ

    Learn more about how to resolve issues encountered when you use OBD

    Documentsarrow

  • OBD Error Codes

    Learn more about the OBD error codes and solutions

    Documentsarrow