Deploy ODC in single-node mode|V4.4.1|OceanBase Developer Center|ODC docs|Distributed Database

Deploy ODC in single-node mode

Last Updated：2026-04-07 10:00:36 Updated

After you initialize the MetaDB of OceanBase Developer Center (ODC), you need to obtain and run the ODC image on each node to install ODC. The single-node deployment of ODC is completed after the image runs successfully.

Load the image

Notice

The images of ODC V4.2.0 and later versions have been published to Docker Hub. If your local device running ODC can access Docker Hub, you can directly start ODC Docker without downloading the image. For details, see the Running Image content below.
If Docker Hub cannot be accessed directly, you still need to download and load the image file.

To obtain the ODC image on the host, select the required image from the Maintenance Tools of the OceanBase Download Center.
After you obtain the image, run the following command in the command-line tool to load it:
```
gunzip -c obodc-{$version}.tar.gz | docker load
```

Run the image

Execute the following sample statement in the command-line tool to run the image:

#!/usr/bin/env bash
docker run -v /var/log/odc:/opt/odc/log -v /var/data/odc:/opt/odc/data \
-d -i --net host --cpu-period 100000 --cpu-quota 400000 --memory 8G --name "obodc" \
-e "DATABASE_HOST=xxx.xx.xx.xx" \
-e "DATABASE_PORT=60805" \
-e "DATABASE_USERNAME=db_user@tenant_name#cluster_name" \
-e "DATABASE_PASSWORD=******" \
-e "DATABASE_NAME=odc_metadb" \
-e "ODC_PROFILE_MODE=alipay" \
-e "ODC_ADMIN_INITIAL_PASSWORD=******" \
oceanbase/odc:4.2.2

Notice

In the shell environment, to ensure that special characters such as ! and $ in the string are not interpreted, you can use double quotes (for example: -e "DATABASE_PASSWORD=******") or enclose the variable value in single quotes (for example: -e DATABASE_PASSWORD='11111!').
The ODC_ADMIN_INITIAL_PASSWORD parameter specifies the initial password for the ODC administrator account (admin). The initial password must meet the following conditions:
- At least 2 digits.
- At least 2 uppercase letters.
- At least 2 lowercase letters.
- At least 2 special characters, which can be ._+@#$%.
- Does not contain spaces or other special characters, and the length is between 8 and 32.

The following table describes parameters used in the preceding sample statement.

Parameter	Description
-v	Maps the `/var/log/odc` directory of the host to the `/opt/odc/log` directory in the ODC container. If the `/var/log/odc` directory does not exist on the host, run the `mkdir -p /var/log/odc` command to create one. Mounts the `/var/data/odc` directory of the host to the `/opt/odc/data` directory in the ODC container. If the `/var/data/odc` directory does not exist on the host, run the `mkdir -p /var/data/odc` command to create one.
--net	The network configuration of the Docker container. If you set this parameter to `host`, the host network is directly used. You can also use the `--publish` (`-p`) parameter to configure port mapping. However, the Docker container may fail to start in some circumstances due to incorrect DNS resolution in the Docker container. In this case, run the `--net host` command to start the Docker container. Default value: 8989.
--cpu-period --cpu-quota	The `---cpu-period` parameter specifies the interval at which the CPU cores of the Docker container are reallocated. Unit: microseconds. The `---cpu-quota` parameter specifies the maximum time for running the current Docker container in this interval. Unit: microseconds. You can use these two parameters in combination to specify the number of CPU cores that the Docker container uses. The value is calculated by dividing `cpu-quota` by `cpu-period`. In the preceding sample statement, the values of cpu-quota and cpu-period are respectively 400000 and 100000, indicating that the Docker container can use at most four CPU cores.
--memory	The maximum memory size for the Docker container.
--name	The name of the container.
DATABASE_HOST	The IP address of the MetaDB.
DATABASE_PORT	The port number of the MetaDB. Default value: 8989.
DATABASE_USERNAME	The username of the MetaDB. In OceanBase Database, the username is given in the `db_user@tenant_name#cluster_name` format.
DATABASE_PASSWORD	The password for connecting to the database.
DATABASE_NAME	The name of the MetaDB.
ODC_PROFILE_MODE	The mode. Default value: `alipay`.
ODC_ADMIN_INITIAL_PASSWORD		ODC_ADMIN_INITIAL_PASSWORD	The initial password of the ODC administrator account (admin). Notice The initial password must meet the following requirements: At least two digits. At least two uppercase letters. At least two lowercase letters. At least two special characters, which can be .,_, +, @, #, $, or %. No spaces or other special characters, and the length must be between 8 and 32.

In addition to the preceding parameters, you can also use the following parameters when running the image.

Parameter	Description
ODC_LOG_DIR	The log directory. Default value: `/opt/odc/log`.
ODC_JVM_HEAP_OPTIONS	The JVM memory configuration. Default value: `-XX:MaxRAMPercentage=60.0 -XX:InitialRAMPercentage=60.0`, indicating that 60% of the memory is used, and the JVM memory can be customized by specifying the parameter `ODC_JVM_HEAP_OPTIONS`. Example: `-Xmx2048m -Xms2048m`, indicating that the heap memory is set to 2G.
ODC_JVM_GC_OPTIONS	The garbage collection (GC) strategy for JVM. Default value: `-XX:+UseG1GC -XX:+PrintAdaptiveSizePolicy -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+PrintGCDateStamps -Xloggc:/opt/odc/log/gc.log -XX:+UseGCLogFileRotation -XX:GCLogFileSize=50M -XX:NumberOfGCLogFiles=5`.
ODC_JVM_OOM_OPTIONS	The OutOfMemory strategy for JVM. Default value: `-XX:+ExitOnOutOfMemoryError`.
ODC_JVM_EXTRA_OPTIONS	Other JVM parameters. By default, no parameter is specified.
ODC_SERVER_PORT	The HTTP listening port for ODC-Server. Default value: 8989.
ODC_HOST	The IP address of ODC, which can be used as the destination IP address for remote procedure calls in high-availability deployment scenarios.
ODC_RPC_PORT	The port number of ODC, which can be used as the destination port number for remote procedure calls in high-availability deployment scenarios. Note This parameter is independent of the ODC_SERVER_PORT parameter. It is required only for initiating remote procedure calls.
ODC_APP_EXTRA_ARGS	Other App parameters need to be specified. Example, `--server.servlet.session.timeout=10m`, indicating that the Session period is 10 minutes. The default value is empty.

OceanBase

Customer Stories

Documentation

Deploy ODC in single-node mode

Load the image

Notice

Run the image

Notice

Notice

Note