Install OAT|V4.1.2| docs|Distributed Database

This topic describes how to deploy OceanBase Admin Toolkit (OAT) in a Docker container.

Prerequisites

Before you deploy OAT, make sure the following:

Your operating system meets the conditions listed in the following table.

Architecture	Operating system	Supported version
x86_64	Red Hat Enterprise Linux (RHEL)	7.2 or later
x86_64	CentOS	7.2 or later
x86_64	AliOS	7.2 or later
x86_64	openSUSE	12SP3 or later
ARM AArch64	AliOS	7.2 or later
ARM AArch64	NeoKylin	7.6
ARM AArch64	Huawei EulerOS	2.0 SP8

You have installed and started Docker. Docker Community Edition 17.03 or later is recommended. If you use the all-in-one package to install OAT, the install.sh script in the package automatically installs Docker.
The default port 7000 for OAT is not occupied.

Install OAT by using the oat-all-in-one package

Note

We recommend that you install OAT by using the oat-all-in-one package.

The oat-all-in-one package contains the software packages of Docker 18.09.9, OAT V4.1.0, MetaDB V2.2.77, NLB V3.5.1, and some commonly used tools. Perform the following steps to install OAT:

Decompress the oat-all-in-one package.

tar -xf oat-all-in-one-x86.tar

Run the install.sh script.

sh oat-all-in-one-x86/install.sh

This command automatically installs Docker (if Docker is not installed), deploys OAT, and scans existing images and tool packages.

Select the root directory of Docker and the data directory of OAT, and then specify the HTTP listening port (7000 by default), database port (3306 by default), and initial password (aaAA11__ by default) of OAT.
Access OAT by using the returned URL to verify the availability of OAT.

Note

The default logon username and password of OAT are admin and aaAA11__, respectively. You must change the password upon initial logon.
By default, the install.sh script starts the OAT container by using --net host (host network mode). To configure another network mode for the OAT container, you must manually start the OAT container.
By default, oat-all-in-one for x86 contains only the OAT image and software packages for the x86_64 and Noarch architectures, and `oat-all-in-one` for AArch64 contains only the OAT image and software packages for AArch64 and Noarch. If you have only `oat-all-in-one` for x86 or AArch64 and you want to use the OAT image and software packages for the AArch64 or x86_64 architecture, download and copy the required OAT image and software packages to the directory to which the OAT container is mounted, and then initiate a scan task to add the packages.

Install OAT by using the OAT installation package

Contact OceanBase Technical Support to download the installation package of OAT.
Run the scp command to upload the OAT installation package to the server.

In the following command, oat_server indicates the IP address of the server where OAT is to be deployed.
```
scp oat.tgz <oat_server_user>@<oat_server_ip>:~/
```
Mount the OAT directory.

Create a directory named /data_dir on the server to save persistent data of OAT.

After the /data_dir directory is mounted to the OAT container, OAT will automatically create the /data_dir/logs, /data_dir/images, and /data_dir/db directories to store OAT system logs, OAT component and product Docker images, and OAT database files, respectively.
```
mkdir -p /data_dir
```
Load the OAT installation package as an image.
```
docker load -i oat.tar
```
Run the docker images command to obtain the tag of the OAT image.

Note

If only one OAT installation package is loaded, just run the following command. If multiple installation packages are loaded, run the docker images command to view the loaded images and then concatenate the first two columns with a colon (:) in the command output.
```
oat_image=`docker images | grep oat | awk '{printf $1":"$2"\n"}'`
```
Run the docker run command to start OAT.
```
 docker run -d --net host --name oat -v /data_dir:/data --restart on-failure:5 $oat_image
```
Note
- By default, the HTTP server of OAT listens on port 7000. You can specify the -e HTTP_PORT=7001 parameter to modify the port.
- The default password of OAT is aaAA11__. You can specify the -e OAT_INITIAL_ADMIN_PASSWORD=xxx parameter to change the password of OAT.
- By default, the built-in MariaDB of OAT listens on port 3306. You can specify the -e DB_PORT=3307 parameter to modify the port.
- We recommend that you start OAT by specifying the --net host parameter, because a container started in bridge mode can be affected by docker0 bridge failures or the ip_forward parameter of the operating system.
After OAT is started, enter http://<<oat_server_ip>:7000 in the address bar of the browser.

If the logon page appears, OAT has been successfully installed and started.

Note

If you configured the environment variable `docker run -e OAT_INITIAL_ADMIN_PASSWORD=xxx` when starting OAT, the password of OAT is the one you specified. If you did not, the default username and password of OAT are admin and aaAA11__, respectively. You must change the password upon initial logon.