Install OAT

This topic describes how to deploy OAT using Docker.

Prerequisites

Before you deploy OAT, confirm the following:

• Your operating system meets the following requirements:

  Server type	Operating system	Supported version
  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, NeoKylin OS, Zhongke Fangde OS, etc.)	8.4 and later
  x86_64/ARM aarch64	Debian (and compatible Ubuntu, etc.)	11 and later
  x86_64/ARM aarch64	openSUSE	12 SP3 and later
  x86_64/ARM aarch64	openSUSE	12 SP3 and later
  x86_64/ARM aarch64	NeoKylin	V6.0.99 and later

• You have installed and started Docker. Docker Community Edition 17.03 or later is recommended. If you install OAT using the all-in-one package, the install.sh script in the package automatically installs Docker.

• The default OAT port 7000 is not occupied.

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

To install OAT, perform the following steps:

1. Contact technical support to obtain the oat-all-in-one package for OAT.

2. Extract the oat-all-in-one package.

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

3. Run the installation script install.sh.

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

   Running this command automatically installs Docker (if Docker is not present in your environment), deploys OAT, and scans for existing images and tool software packages.

4. As prompted, enter settings such as the Docker root directory, OAT data directory (these directories do not need to be manually created), OAT HTTP listening port (default 7000), OAT database port (default 3306), and the initial OAT password.

5. Access OAT at the returned URL to verify the availability of the OAT service.

Install using the OAT installation package

1. Download the OAT installation package.

   You need to contact OceanBase technical personnel to download the installation package.

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

   Here, oat_server is the IP address of the server where OAT is deployed.

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

3. Mount the OAT directory.

   Create a /data_dir directory on the server to store persistent data for 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 OAT system logs, Docker images for components and products, and OAT database files, respectively.

   mkdir -p /data_dir
   

4. Load the OAT installation package as a Docker image.

   docker load -i oat.tar
   

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

   Note

   If only one OAT installation package is loaded, use the example command. If multiple installation packages are loaded, run the docker images command to view the output, and concatenate the contents of 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.

   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 starts successfully, enter http://<<oat_server_ip>:7000 in the browser address bar.

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