Deploy OceanBase Database online

Terms

• Central control server

  The server that stores the installation package and cluster configuration information of OceanBase Database.

• Target server

  The server where you want to install OceanBase Database.

• OBD

  OceanBase Deployer (OBD) is a tool used to install and deploy open source software of OceanBase.

• ODP

  The abbreviation of OceanBase Database Proxy, a high-performance reverse proxy server designed for OceanBase Database.

Prerequisites

Before you connect to OceanBase Database, make sure that the following prerequisites are satisfied:

• Your servers meet the software and hardware requirements. For more information, see Software and hardware requirements.

• In the production environment, you have checked the environment and configurations. For more information, see Check the environment and configurations.

Deployment mode

This topic describes a three-replica deployment mode. You can choose an appropriate deployment mode as needed. We recommend that you use four servers for this deployment mode:

• Deploy ODP on one server.

• Deploy the OceanBase cluster by using the other three servers.

Note

• Deploy your applications on the ODP server to minimize the latency of access between the applications and ODP. You can deploy ODP on each application server. In this example, ODP is deployed only on a separate server for ease of use.

• Hardware requirements of the ODP server can be different from those of servers for the deployment of OceanBase Database. The server where ODP is to be deployed requires only one CPU core and 1 GB of memory.

Install OBD online

Note

• You need to install OBD only on the central control server as the root user.

• Install OBD of a version later than V1.4.0. The latest version is recommended.

If the server has access to the Internet and allows installation of third-party software from a YUM repository, you can run the following command to install OBD from the official software source of OceanBase:

yum install -y yum-utils
yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
yum install -y ob-deploy

Notice

This operation is supported only on Anolis, CentOS, and RedHat.

After you run the obd cluster deploy command, OBD checks the target server for the OceanBase Database installation package. If the package does not exist, OBD automatically obtains the package from the YUM repository.

Install OBClient online

You need to install the OBClient only on the central control server.

Notice

• You must install OBClient as the root user.

• You must first download LibOBClient, the dependencies package of the OBClient.

Run the following commands to install OBLibs online:

yum install -y libobclient
yum install -y obclient

Install OceanBase Database and ODP online

To ensure data security, we recommend that you switch to a non-root user before you install OceanBase Database and ODP.

1. Select a configuration file.

   Download the required configuration file from GitHub as needed.

   • If you use standalone deployment with only one server, download the configuration file for standalone deployment (/usr/obd/example/autodeploy/single-example.yaml).
   • If you use distributed deployment with multiple servers, download the configuration file for distributed deployment (/usr/obd/example/autodeploy/distributed-with-obproxy-example.yaml).

2. Modify the configuration file.

   Take the distributed deployment of OceanBase Database and ODP as an example. Perform the following steps to modify the configuration file:

   1. Change the username and password.

      ## Only need to configure when remote login is required
      # user:
      #   username: your username
      #   password: your password if need
      #   key_file: your ssh-key file path if need
      #   port: your ssh port, default 22
      #   timeout: ssh connection timeout (second), default 30
      

   2. Modify the IP address and the home_path, data_dir, and redo_dir parameters of each server.

      oceanbase-ce:
        servers:
          - name: z1
            # Please don't use hostname, only IP can be supported
            ip: 172.xx.xxx.200
          - name: z2
            ip: 172.xx.xxx.201
          - name: z3
            ip: 172.xx.xxx.202
        global:
          # Please set devname as the network adaptor's name whose ip is  in the setting of severs.
          # if set severs as "127.0.0.1", please set devname as "lo"
          # if current ip is 192.168.1.10, and the ip's network adaptor's name is "eth0", please use "eth0"
          devname: eth0
          # The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
          home_path: /home/admin/oceanbase/ob
          # The directory for data storage. The default value is $home_path/store.
          data_dir: /data/ob
          # The directory for clog, ilog, and slog. The default value is the same as the data_dir value.
          redo_dir: /redo/ob
      

      Note

      Note that you must modify the parameter values based on your actual configuration.

   3. Configure ODP and modify the IP address and the home_path parameter.

      obproxy-ce:
        servers:
          - 172.xx.xxx.203
        global:
          # The working directory for obproxy. Obproxy is started under this directory. This is a required field.
          home_path: /home/admin/obproxy
      

      You can use the online YAML Checker to validate your configuration files. For more information, see Online YAML Checker.

Deploy the OceanBase cluster

Perform the following steps to deploy the OceanBase cluster:

• Deploy the OceanBase cluster.

  obd cluster autodeploy obtest -c distributed-with-obproxy-example.yaml
  

• View the OceanBase cluster.

  obd cluster list
  

(Optional) Modify the cluster configuration

OceanBase Database has hundreds of parameters and some are coupled. We recommend that you do not modify parameters in the sample configuration file before you become familiar with OceanBase Database. The following example shows you how to modify a parameter and make it take effect.

# Run the `edit-config` command to enter the edit mode before you can edit the cluster configurations.
obd cluster edit-config obtest
# Change the value of the sys_bkgd_migration_retry_num parameter to 5.
# Note that the minimum value of the sys_bkgd_migration_retry_num parameter is 3.
# After you save the change and exit, OBD will inform you how to make it take effect.
# For this parameter, you only need to run the reload command to make it take effect.
obd cluster reload obtest

Connect to OceanBase Database:

Run the following command to connect to OceanBase Database by using the OBClient:

obclient -h<your_ip> -P<obproxy_port> -uroot

You need to replace the value of your_ip with the IP address of the server where your OceanBase Database instance is located. By default, ODP connects to the OBClient by using Port 2883. Use the actual port number if you have changed it.

Create a user tenant

You must create a user tenant before you use OceanBase Database. You can run your business data only in a user tenant.

You can create a user tenant by using the following method:

• Create a user tenant by using OBD.

  obd cluster tenant create ${cluster_name} -n ${tenant_name}