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 Deployer

V3.0.0Community Edition
  • What is obd
  • Quick Start
    • Install obd
    • Quickly deploy OceanBase Database
    • Quickly deploy OCP
    • 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
      • Modify components on the GUI
    • Deploy through CLI
      • Deploy OceanBase Database on a single server
      • Deploy OCP Express by using commands
      • Deploy and use obconfigserver
      • Deploy oblogproxy by using the CLI
      • Deploy OCP by using commands
      • Use OCP to take over a cluster deployed by obd
      • Use obd to take over a cluster
      • 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
      • Performance test
      • Cluster diagnotistics
  • FAQ
    • FAQ
    • How do I upgrade an OBProxy to obproxy-ce 3.2.3?
  • Mode configuration rules
  • Error codes
  • Release Notes
    • Version rules
    • 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

Document Feedback
  1. Documentation Center
  2. OceanBase Deployer
  3. V3.0.0

Quickly deploy OceanBase Database

Last Updated:2026-10-09 07:24:07

Prerequisites
Examples

After you install OceanBase Deployer (obd), you can run the obd demo command to quickly deploy OceanBase Database on a single local server.

Note

This topic describes how to quickly deploy OceanBase Database for experience. For information about how to deploy OceanBase Database in the production environment, see Deploy an OceanBase cluster on the GUI.

Prerequisites

Make sure that the following conditions are met:

  • You have installed obd (latest version recommended). For more information, see Install obd.

    Note

    We recommend that you download the OceanBase All in One package for deployment. The package provides all required components of the recommended versions, and the components have passed adaptation tests.

  • The default ports of the components to be deployed are not occupied. For more information, see [SOP series 20] Default ports of OceanBase server processes and tools.

  • At least 2 vCPUs, 6 GB of memory, and 20 GB of disk space are available for deploying OceanBase Database only.

  • At least 2 vCPUs, 6 GB of memory, and 25 GB of disk space are available for deploying the default components.

  • At least 4 vCPUs, 10 GB of memory, and 25 GB of disk space are available for deploying all components. We recommend that more than 16 GB of memory be available.

  • Your server can connect to the Internet, or the local image repository of obd contains the installation packages required for deployment.

    You can run the obd mirror list local command to query the installation packages in the local image repository. If obd is installed by using the OceanBase All in One package, the local image repository contains all installation packages required for deployment by default.

Note

  • If the preceding prerequisites are not met, you can deploy OceanBase Database by using a configuration file. For more information, see Deploy OceanBase Database on a single server.

  • For more information about the obd demo command, see Quick deployment command.

Examples

  • Deploy OceanBase Database only.

    obd demo -c oceanbase-ce
    
  • Deploy the default components.

    You can run the obd demo command to deploy OceanBase Database, OceanBase Database Proxy (ODP), OceanBase Agent (OBAgent), Prometheus, and Grafana of the latest versions in the image repository by default.

    obd demo
    
  • Deploy the default components, with the OceanBase Database version specified.

    obd demo --oceanbase-ce.version=4.3.3.0
    

After the deployment succeeds, you can copy the connection string in the returned result and use it to connect to OceanBase Database from the OceanBase Command-Line Client (OBClient). Here is an example:

obclient -h127.0.0.1 -P2881 -uroot@sys -p'*******'  -Doceanbase -A

For more information about the connection string, see Connect to an OceanBase tenant by using OBClient.

Previous topic

Install obd
Last

Next topic

Quickly deploy OCP
Next
on this page
Prerequisites
Examples