Quickly deploy OceanBase Database

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

Prerequisites

Before you start, make sure that the following conditions are met:

• If the server uses the x86 architecture, it must support the AVX instruction set. You can check if AVX is supported by running the command lscpu | grep Flags | grep avx.

• 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 (except obbinlog) 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.

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.