To upgrade OceanBase Developer Center (ODC) in single-node deployment mode, you need to load and run the ODC image again after updating the MetaDB and stopping the ODC container of the earlier version.
Load the image
To obtain the ODC image on the host, select the required image from the following list and click [Download] .
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 --volume /var/log/odc:/opt/odc/log
-d -i --net host --cpu-period 100000 --cpu-quota 400000 --memory 8G --name "obodc"
-e "DATABASE_HOST=100.00.00.00"
-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"
reg.docker.alibaba-inc.com/oceanbase/odc-server:{image_tag}
You can run the docker images command to view the {image_tag} parameter on the host after you load the image. The following table describes other parameters used in the preceding sample statement.
| Parameter | Description |
|---|---|
| --volume | 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, run the mkdir -p /var/log/odc command to create it. |
| --net | Specifies 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 domain name resolution (DNS) in the Docker container. In this case, run the --net host command to start the Docker container. |
| --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 | Specifies the maximum memory size for the Docker container. |
| --name | Specifies the name of the container. |
| DATABASE_HOST | Specifies the IP address of the MetaDB. |
| DATABASE_PORT | Specifies the port number of the MetaDB. |
| DATABASE_USERNAME | Specifies the username of the MetaDB. In OceanBase Database, the username is given in the db_user@tenant_name#cluster_name format. |
| DATABASE_PASSWORD | Specifies the username for connecting to the database. |
| DATABASE_NAME | Specifies the name of the MetaDB. |
| ODC_PROFILE_MODE | Specifies the mode, which is alipay by default. |
In addition to the preceding parameters, you can also use the following parameters as needed when you run the image.
| Parameter | Description |
|---|---|
| ODC_LOG_DIR | Specifies the log directory, which is /opt/odc/log by default. |
| OBCLIENT_WORK_DIR | Specifies the working directory of OBClient, which is /opt/odc/data by default. |
| ODC_JAR_FILE | Specifies the directory of JAR files, which is /opt/odc/lib/odc-web-starter-*.jar by default. |
| ODC_WORK_DIR | Specifies the working directory of ODC, which is /opt/odc/script by default. |
| ODC_JVM_HEAP_OPTIONS | Specifies the JVM stack memory. The default maximum value of the parameter -Xmx is 60% of the available physical memory size. The ODC startup script checks whether the available memory in the current environment reaches 2048 MB before it starts the image. Assume that this parameter is set to 60%, the available memory must be at least 3.4 GB to start the image. If the available memory of the host or Docker container is less than 3.4 GB, you can set the ODC_JVM_HEAP_OPTIONS parameter, for example, to "-Xmx2048m -Xms2048m" to skip memory check. |
| ODC_JVM_GC_OPTIONS | Specifies the garbage collection policy for JVM. Default policy: -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 | Specifies the OutOfMemory policy for JVM, which is -XX:+ExitOnOutOfMemoryError by default. |
| ODC_JVM_EXTRA_OPTIONS | Specifies other JVM configuration parameters, which are empty by default. |
| ODC_SERVER_PORT | Specifies the HTTP listening port for ODC-Server, which is 8989 by default. |