Deploy OceanBase Database in a container environment

Notice

The operations described here are designed for learning or testing purposes only and should not be applied to a production environment.

Prerequisites

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

• You have installed Docker and started the Docker service. For more information, see Docker documentation.

  Note

  On a Mac with an x86 CPU architecture, you can deploy OceanBase Database only with Docker V4.9.0 or earlier. You can click here to download Docker.

• Your server meets the hardware and software requirements. For more information, see Hardware and software requirements.

Deploy OceanBase Database

(Optional) Step 1: Pull the image of OceanBase Database

Run the following commands to pull the image needed for OceanBase Database.

• Search for images related to OceanBase Database.

  [admin@test001 ~]$ sudo docker search oceanbase
  

• Pull the latest image of OceanBase Database.

  [admin@test001 ~]$ sudo docker pull oceanbase/oceanbase-ce
  

  Note

  • If the Docker image fails to be pulled, you can also pull the image from the quay.io or ghcr.io repository. To do so, replace oceanbase/oceanbase-ce in the above pull command with quay.io/oceanbase/oceanbase-ce or ghcr.io/oceanbase/oceanbase-ce.

  • After you change the repository address in the commands of this step, you must also change the repository address in the commands of the next step. The two commands use the same repository address.

  • By default, the above command pulls the latest version of image. You can select a desired image from dockerhub, quay.io, or ghcr.io according to your needs.

Step 2: Start an OceanBase Database instance

Run the following command to start an OceanBase Database instance.

[admin@test001 ~]$ sudo docker run -p 2881:2881 -v $PWD/ob:/root/ob -v $PWD/obd/cluster:/root/.obd/cluster --name obstandalone -e MODE=NORMAL -e OB_TENANT_PASSWORD=***** -d oceanbase/oceanbase-ce

[admin@test001 ~]$ sudo docker run -p 2881:2881 -v $PWD/ob:/root/ob -v $PWD/obd/cluster:/root/.obd/cluster --name obstandalone -e MODE=MINI -e OB_TENANT_PASSWORD=***** -d oceanbase/oceanbase-ce

[admin@test001 ~]$ sudo docker run -p 2881:2881 -v $PWD/ob:/root/ob -v $PWD/obd/cluster:/root/.obd/cluster --name obstandalone -e MODE=SLIM -d oceanbase/oceanbase-ce

In the example, the options are described as follows:

• -p is used to map a port of the container to a port on the host. In the example, port 2881 of the container is mapped to port 2881 on the host.

• -v is used to share files or directories between the container and the host for data persistence or configuration sharing. By default, the system deploys OceanBase Database in the /root/ob directory of the container and saves the configuration in the /root/.obd/cluster directory. You can use the -v option to persist data on the host.

  You can also use the -v option to mount an SQL script for execution. Remember to modify {init_sql_folder_path} in the following example to the actual path of the initialization SQL script.

  [admin@test001 ~]$ sudo docker run -p 2881:2881 -v {init_sql_folder_path}:/root/boot/init.d --name obstandalone -e MODE=SLIM -d oceanbase/oceanbase-ce
  

• --name is used to set the name of the Docker container, for example, obstandalone in the above example.

• -e is used to set environment variables. In the example, MODE specifies the startup mode of OceanBase Database, and OB_TENANT_PASSWORD sets the password of the root@test user in OceanBase Database. For more information about environment variables, see Supported environment variables.

The startup is expected to take 2 to 5 minutes. Run the following command, and if it returns boot success!, the startup was successful.

[admin@test001 ~]$ sudo docker logs obstandalone | tail -1
boot success!

Step 3: Connect to the OceanBase Database instance

The oceanbase-ce image includes OceanBase Deployer (obd) and OceanBase Client (OBClient), which is a command-line client. You can either enter the container and use the obd commands and OBClient to manage and connect to the instance, or you can connect to the OceanBase Database instance from your host machine using a local OBClient or a MySQL client.

Connect to the instance after you enter the container

1. Enter the Docker container.

   [admin@test001 ~]$ sudo docker exec -it obstandalone bash
   

2. View the details of the cluster.

   # View the list of clusters
   obd cluster list
   # View the details of the obcluster cluster
   obd cluster display obcluster
   

3. Connect to the cluster.

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

Connect to the instance from your host machine

You can connect to the OceanBase Database instance from your host machine using a local OBClient or a MySQL client. Here is an example of connecting to the instance using a local OBClient:

[admin@test001 ~]$ obclient -uroot@sys -h127.0.0.1 -P2881 -p

After the connection is established, your terminal will display the following message:

Welcome to the OceanBase.  Commands end with ; or \g.
Your OceanBase connection id is 3221711319
Server version: OceanBase_CE 4.3.0.1 (r100000242024032211-0193a343bc60b4699ec47792c3fc4ce166a182f9) (Built Mar 22 2024 13:19:48)

Copyright (c) 2000, 2018, OceanBase and/or its affiliates. All rights reserved.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

obclient [(none)]>

Supported environment variables