Install OAT

You can deploy OceanBase Cloud Platform (OCP) on the GUI of OceanBase Admin Toolkit (OAT), a tool used to automatically deploy products in the OceanBase ecosystem. Before you deploy OCP, install OAT first.

Prerequisites

Before you deploy OAT, make sure that:

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

  Server type	Operating system	Supported versions
  x86_64/ARM aarch64	RHEL (and compatible RockyLinux, CentOS, etc.)	7.2 and later
  x86_64/ARM aarch64	Anolis (and compatible Alibaba Cloud Linux, Kylin V10, Unity Operating System (UOS), China Mobile BC-Linux, Linx OS, Zhongke Fangde OS, and others)	8.4 and later
  x86_64/ARM aarch64	Debian (and compatible Ubuntu, etc.)	11 and later
  x86_64/ARM aarch64	openSUSE	12SP3 and later
  x86_64/ARM aarch64	Linx OS	V6.0.99 and later

• You have installed and started Docker. Docker Community Edition 18.09.9 or later is recommended.

• The default port 7000 for OAT is not occupied.

Procedure

1. Download the installation package of OAT.

   For more information, see Prepare installation media.

2. 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_directory> <oat_server_user>@:<oat_server_ip>
   

3. 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 respectively for storing OAT system logs, component and product Docker images in OAT, as well as database files of OAT.

   mkdir -p /data_dir
   

4. Load the OAT installation package as an image. oat_xxx_xxxxxxxx_xxx.tgz is the name of the installation package.

   docker load -i oat_xxx_xxxxxxxx_xxx.tgz
   

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

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

6. Run the docker run command to start OAT. $oat_image is 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 HTTP service of OAT listens on port 7000 by default. You can specify the -e HTTP_PORT=7001 parameter to change it to another port.
   • You can specify the -e OAT_INITIAL_ADMIN_PASSWORD=xxx parameter to change the password of OAT.
   • OAT uses MariaDB as its built-in data store, which listens on port 3306 by default. You can specify the -e DB_PORT=3307 parameter to change it to another port.
   • We recommend that you use the --net host parameter to start OAT, because a container started in bridge network mode may be affected by Docker0 bridge failures or the operating system parameter ip_forward.

7. After OAT is started, enter http://<<oat_server_ip>:7000 in the address bar of the browser. <oat_server_ip> must be replaced with the IP address of the server where OAT is deployed.

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

Reference

Install OAT