Install OAT

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

Prerequisites

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

• Your operating system meets the conditions described in the following table:

  Server type	Operating system	Supported version
  x86_64 or ARM aarch64	Red Hat Enterprise Linux (RHEL) and its compatible operating systems such as Rocky Linux and CentOS	7.2 and later
  x86_64 or ARM aarch64	Anolis and its compatible operating systems such as Alibaba Cloud Linux, Kylin V10, Unity Operating System (UOS), BC-Linux of China Mobile, Linx OS, and NFSChina	8.4 and later
  x86_64 or ARM AArch64	Debian and its compatible operating systems such as Ubuntu	11 and later
  x86_64 or ARM AArch64	openSUSE	12SP3 and later
  x86_64 or ARM AArch64	openSUSE	12SP3 and later
  x86_64 or ARM AArch64	Linx	V6.0.99 and later

• If you use the OAT image package to install OAT, you must install and start Docker. Docker Community Edition 18.09.9 or later is recommended.

  Note

  If you use the oat-all-in-one installation package to deploy OAT, the install.sh script in the oat-all-in-one package automatically installs Docker. You do not need to install Docker separately.

• The default port 7000 of OAT is not occupied.

Use the oat-all-in-one installation package to install OAT

You can obtain the oat-all-in-one installation package of OAT from OceanBase Download Center > Enterprise Edition > OceanBase Admin Tool. If you cannot find the required installation package, contact technical support.

Perform the following steps to install OAT:

1. Decompress the oat-all-in-one installation package.

   Example:

   tar -xf oat-all-in-one-arm-430.tar
   

2. Run the installation script install.sh.

   Example:

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

   This command automatically installs Docker (if Docker is not installed in your environment), deploys OAT, and scans the images and tool packages contained in oat-all-in-one.

3. As prompted, confirm or specify the following information in sequence:

   1. Enter the root directory of Docker. We recommend that you specify a dedicated mount directory. The default directory is /docker. You do not need to manually create this directory. You can customize this directory. If Docker is already installed, this step is skipped.
   2. Enter the data directory of OAT. The default directory is /oat_data. You do not need to manually create this directory. You can customize this directory.
   3. Enter the HTTP listening port of OAT. The default port is 7000. You can customize this port.
   4. Enter the database port of OAT. The default port is 3306. You can customize this port.
   5. Enter the password of the OAT administrator account (the initial login password). You can customize this password.
   6. Use the returned URL to access OAT and verify the availability of OAT.

   Example:

   Note

   In this example, Docker has been installed on the server. Therefore, Docker is not installed again during this installation.

   7. Change the data directory of OAT to /data/oat_data, and then press Enter.

      Input the OAT data dir: /data/oat_data
      

   8. Use the default HTTP listening port of OAT and press Enter.

      Input the OAT HTTP listen port: 7000
      

   9. Use the default database port of OAT and press Enter.

      Input the OAT database port: 3306
      

   10. Change the password of the OAT administrator account admin (the initial login password) and press Enter.

   Input the OAT admin user password(login password): ******
   

   11. Use the returned URL to access OAT and verify the availability of OAT.

   The following output is returned:

   Start prepare docker
   Docker is already exists, start check...
   Already installed docker check healthy, skip install docker
   Start prepare OAT
   Loaded image: xxx/oceanbase/oat:4.3.0_20241025_arm
   45fd5a9b31b0af6aeb07b3e485503ad4c64629170b91d1d3c9e8128e8e532125
   check OAT url http://127.0.0.1:7000/hc
   OAT API not ready, please wait, sleep 5s retry...
   OAT API not ready, please wait, sleep 5s retry...
   OAT API not ready, please wait, sleep 5s retry...
   OAT API not ready, please wait, sleep 5s retry...
   OAT API not ready, please wait, sleep 5s retry...
   OAT API not ready, please wait, sleep 5s retry...
   OAT API ready
   Copy images and binary_packages to OAT data dir
   Trigger OAT scan api to find images and binary_packages
   Trigger scan task success, please visit OAT web site and wait for scan task finished
   OAT is ready for visit
   url is: http://<current_ip>:7000
   user/password is: admin/******
   

Use the OAT Docker image to install OAT

1. Obtain the installation package of OAT.

   Note

   Contact OAT technical support to obtain the installation package.

2. Run the scp command to upload the OAT installation package to the server.

   Here, oat_server specifies the IP address of the server on which OAT is deployed.

   scp oat.tgz <oat_server_user>@<oat_server_ip>:~/
   

   Example:

   scp oat_4.3.0_20241025_arm.tgz root@xxx.xxx.xxx.xxx:/home/admin/oat_rpm
   

3. Mount the OAT directory.

   Create a directory named /data_dir on the server (you can customize the path; /data_dir is used as an example in this topic) to store persistent data of OAT.

   After /data_dir is mounted to the OAT container, OAT automatically creates the /data_dir/logs, /data_dir/images, and /data_dir/db directories for storing OAT system logs, Docker images of components and products, and database files of OAT.

   mkdir -p /data_dir
   

4. Load the OAT installation package as an image.

   docker load -i oat_xxx_xxxxxxxx_xxx.tgz
   

   Here, oat_xxx_xxxxxxxx_xxx.tgz is the name of the installation package.

   Example:

   docker load -i oat_4.3.0_20241025_arm.tgz
   

   The following result is returned:

   Loaded image: xxx/oceanbase/oat:4.3.0_20241025_arm
   

5. Run the docker images command to obtain the tag of the OAT image.

   Note

   If only one OAT installation package is loaded, you can run the sample command. If multiple installation packages are loaded, run the docker images command to view the displayed content and connect the first two columns with a colon (:).

   oat_image=`docker images | grep oat | awk '{printf $1":"$2"\n"}'`
   

6. Run the docker run command to start OAT.

   Here, $oat_image specifies the tag of the OAT image.

   docker run -d --net host --name oat  -v /data_dir:/data -e OAT_INITIAL_ADMIN_PASSWORD=xxx --restart on-failure:5 $oat_image
   

   Note

   • The default HTTP listening port of OAT is 7000. You can specify the -e HTTP_PORT=7001 parameter to modify the port.

   • 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.

   Example:

   docker run -d --net host --name oat -v /data_dir:/data -e OAT_INITIAL_ADMIN_PASSWORD=****** --restart on-failure:5 $oat_image
   

   The following result is returned:

   490344724bfcb2801da271196ebc38b5c15547b796178dc7660553ae62b668c2
   

   You can enable HTTPS when you install OAT by using the OAT Docker image. The command is as follows:

   docker run -itd --name oat --net host -e ENABLE_HTTPS=true -e HTTP_PORT=7000 -e OAT_INITIAL_ADMIN_PASSWORD=****** -v /data_dir:/data -v <replace with the path of the .crt file of the host certificate>:/data/cert/oat.crt -v <replace with the path of the .key file of the host certificate>:/data/cert/oat.key --restart on-failure:5 $oat_image
   

   Parameter description:

   Note

   OAT internally uses MariaDB as the data storage. It listens on port 3306 by default. You can specify the -e DB_PORT=3307 parameter to change the port.

   Parameter	Description
   -itd	Specifies to create a container that runs in the background but retains interactive terminal capabilities. This is a combination of three parameters, as follows: -i (interactive): Keeps the standard input open, allowing interaction with the container. -t (tty): Allocates a pseudo-terminal, making the interaction more user-friendly. -d (detach): Runs the container in the background (daemon mode).
   --name oat	Specifies the container name as oat, making it easier to manage the container by name rather than by its random ID.
   --net host	Specifies to use the Host network mode. The container will directly use the host's network stack, sharing the host's IP address and ports. This means that services listening on port 7000 inside the container can be accessed directly via Host IP:7000 on the host without additional port mapping. Note We recommend using the --net host parameter, as containers started in bridge network mode may be affected by docker0 bridge issues or the operating system parameter ip_forward.
   -e ENABLE_HTTPS=true	Specifies to enable the HTTPS protocol for the OAT application. The ENABLE_HTTPS parameter controls whether to enable HTTPS, with a default value of false. Notice When you use the ENABLE_HTTPS parameter to enable HTTPS, you must also mount the TLS certificate.
   -e HTTP_PORT=7000	Specifies the listening port for the HTTPS/HTTP service. The HTTP_PORT parameter sets the listening port for the HTTPS/HTTP service, with a default value of 7000.
   -e OAT_INITIAL_ADMIN_PASSWORD=******	Specifies the initial administrator password for the OAT system. The OAT_INITIAL_ADMIN_PASSWORD parameter sets the initial password for OAT.
   -v /data_dir:/data	Mounts a data volume, mapping the host's /data_dir directory to the container's /data directory. Data generated by OAT inside the container, such as configuration files and database files, will be persisted on the host to avoid data loss when the container is deleted.
   -v <Path to the .crt file of the TLS certificate on the host>:/data/cert/oat.crt	Mounts a data volume, mapping the host's .crt (public key) file of the TLS certificate to the specified path inside the container (/data/cert/oat.crt is the path for using the certificate in the OAT container).
   -v <Path to the .key file of the TLS certificate on the host>:/data/cert/oat.key	Mounts a data volume, mapping the host's .key (private key) file of the TLS certificate to the specified path inside the container (/data/cert/oat.key is the path for using the certificate in the OAT container).
   --restart on-failure:5	Specifies the container's restart policy. on-failure means the container will automatically restart only if it exits abnormally (i.e., with a non-zero exit code). :5 specifies that Docker will attempt to restart the container a maximum of 5 times. This is a common strategy to ensure service availability while avoiding infinite restart loops.
   $oat_image	Specifies the tag of the OAT image (assigned in step 5 above).

7. After OAT is started, enter http://<oat_server_ip>:7000 in the address bar of the browser.

   Here, <oat_server_ip> specifies the IP address of the server on which OAT is deployed.

   If the login page appears, OAT is installed and started.