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.

For more information, see Install OAT.

Prerequisites

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

• Your operating system meets the following requirements:

  Server type	Operating system	Supported version
  x86_64/ARM aarch64	RHEL (RockyLinux, CentOS, and other compatible operating systems)	7.2 and later
  x86_64/ARM aarch64	Anolis (Alibaba Cloud Linux, Kylin V10, UnionTech UOS, China Mobile BC-Linux, NeoKylin OS, and other compatible operating systems)	8.4 and later
  x86_64/ARM aarch64	Debian (Ubuntu and other compatible operating systems)	11 and later
  x86_64/ARM aarch64	openSUSE	12SP3 and later
  x86_64/ARM aarch64	NeoKylin	V6.0.99 and later

• You have installed and started Docker. We recommend that you use Docker Community Edition 18.09.9 or later.

• The default port 7000 of OAT is not occupied.

Procedure

1. Download the OAT installation package.

   For more information, see Prepare an installation medium.

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

   In this example, oat_server is the IP address of the server on which you want to deploy OAT.

   scp <oat_directory> <oat_server_user>@:<oat_server_ip>
   

3. Mount the OAT directory.

   Create the /data_dir directory on the server to store the persistent data of OAT.

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

   mkdir -p /data_dir
   

4. Load the OAT installation package as an image. In this example, 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.

   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 use a colon (:) to connect the content of the first two columns.

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

6. Run the docker run command to start OAT. In this example, $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 to port 7000 by default. You can specify the -e HTTP_PORT=7001 parameter to change the listening port.
   • You can specify the -e OAT_INITIAL_ADMIN_PASSWORD=xxx parameter to change the password of OAT.
   • OAT is integrated with MariaDB as the data storage. The default listening port is 3306. You can specify the -e DB_PORT=3307 parameter to change the listening port.
   • We recommend that you use the --net host parameter to start OAT. This is because the containers started in bridge network mode may be affected by a failure of the docker0 bridge or the operating system parameter ip_forward.

7. After OAT is started, enter http://<oat_server_ip>:7000 in the address bar of a browser. In this example, <oat_server_ip> is the IP address of the server on which you want to deploy OAT.

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

   Note

   You can contact technical support for the default username and password of OAT. After you log in for the first time, you must change the default password.

References

Install OAT