OceanBase Deployer (OBD) is an installation and deployment tool for open-source OceanBase software. It is also a package manager for managing all open-source OceanBase software. This topic describes how to install OBD, how to use OBD, and OBD commands.
You can install OBD by using these methods:
sudo yum install -y yum-utils
sudo yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
sudo yum install -y ob-deploy
source /etc/profile.d/obd.sh
Before you install OBD by using the source code, make sure that you have installed these dependencies:
- gcc
- wget
- python-devel
- openssl-devel
- xz-devel
- mysql-devel
To install OBD on Python3.8, run these commands:
pip install -r requirements3.txt
sh build.sh build_obd
source /etc/profile.d/obd.sh
After you deploy OceanBase Deployer (OBD), you can run the obd demo
command to deploy and start OceanBase Database on a single local server. Make sure the following prerequisites are met:
-
Ports
2881
and2882
are not occupied. -
At least 6 GB of memory is available on the server.
-
At least two CPU cores are available on the server.
-
At least 54 GB of disk space is available on the server.
Note
If the foregoing prerequisites are not met, see Use OBD to start an OceanBase cluster.
# Deploy and start OceanBase Database.
obd demo
# Run the following command to connect to OceanBase Database by using the OBClient:
obclient -h127.0.0.1 -uroot -P2881
If you want to know how to use OBD to start an OceanBase cluster, please see Use OBD to start an OceanBase cluster.
OBD provides multiple-level commands. You can use the-h/--help
option to view the help information of sub-commands.
A: You can add the version declaration to the deployment configuration file. For example, you can specify the version of OceanBase-CE V3.1.0 in the deployment configuration file in the following format:
oceanbase-ce:
version: 3.1.0
A: You can add the package_hash or tag declaration to the deployment configuration file. For example, if you have tagged your compiled OceanBase-CE, you can specify it by tag. For example:
oceanbase-ce:
tag: my-oceanbase
You can also use package_hash to specify a specific version. When you run an obd mirror
command, OBD will return an MD5 value of the component. The MD5 value is the value of package_hash.
oceanbase-ce:
package_hash: 929df53459404d9b0c1f945e7e23ea4b89972069
A: You can modify the startup plug-ins in the ~/.obd/plugins/oceanbase-ce/
directory. For example, after you add a new startup configuration item for OceanBase-CE V3.1.0, you can modify the start.py
file in the ~/.obd/plugins/oceanbase-ce/3.1.0
directory.
A:You can use the obd update
command to update OBD. When you are done with the update, use the obd --version
command to confirm the version of OBD.
OBD complies with GPL-3.0.