Deploy oblogproxy by using the CLI

Scenarios

If no OceanBase Database component is deployed in the current environment, you can deploy OceanBase Database Community Edition, ODP Community Edition, obconfigserver, and oblogproxy in a cluster by using obd.

Note

If you want to use the binlog service of oblogproxy, you must deploy ODP and obconfigserver.

Prerequisites

You have installed obd V2.5.0 or later (latest version recommended). For more information, see Install obd.

Procedure

This section describes how to deploy oblogproxy by using the distributed-with-obproxy-and-oblogproxy-example.yaml configuration file.

1. Configure user information.

   The following sample code shows user information parameters in the configuration file:

   ## Only need to configure when remote login is required
   user:
     username: admin
   #   password: your password if need
     key_file: /home/admin/.ssh/id_rsa
   #   port: your ssh port, default 22
   #   timeout: ssh connection timeout (second), default 30
   

   username specifies the username of the account used to log on to the target server. Make sure that this account has the write privilege on home_path. password and key_file are used for user verification. Generally, you need to specify only one of them.

   Notice

   After you specify the path of the key, comment out or delete the password parameter if your key does not require a password. Otherwise, the value of the password parameter will be taken as the password of the key and used for logon, leading to a logon verification failure.

2. Configure OceanBase Database Community Edition.

   Create a user named cdcro@sys and grant the read-only privilege on oblogproxy to the user. The cdcro@sys user belongs to OceanBase Database. oblogproxy only uses this user.

   The following sample code shows parameters of OceanBase Database Community Edition in the configuration file:

   oceanbase-ce:
     servers:
       - name: server1
         # Please don't use hostname, only IP can be supported
         ip: 10.10.10.1
       - name: server2
         ip: 10.10.10.2
       - name: server3
         ip: 10.10.10.3
     depends:
       - ob-configserver
     global:
       memory_limit: 64G # The maximum running memory for an observer
       # The reserved system memory. system_memory is reserved for general tenants. The default value is 30G.
       system_memory: 30G
       datafile_size: 192G # Size of the data file. 
       log_disk_size: 192G # The size of disk space used by the clog files.
       enable_syslog_wf: false # Print system logs whose levels are higher than WARNING to a separate log file. The default value is true.
       enable_syslog_recycle: true # Enable auto system log recycling or not. The default value is false.
       max_syslog_file_count: 4 # The maximum number of reserved log files before enabling auto recycling. The default value is 0.
       # observer cluster name, consistent with obproxy's cluster_name
       appname: obcluster
       scenario: htap
       root_password: ******** # root user password, can be empty
       proxyro_password: ******** # proxyro user password, consistent with obproxy's observer_sys_password, can be empty
       cdcro_password: ******** # cdcro user password, consistent with oblogproxy's observer_sys_password, can be empty
     server1:
       mysql_port: 2881 # External port for OceanBase Database. The default value is 2881. DO NOT change this value after the cluster is started.
       rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882. DO NOT change this value after the cluster is started.
       #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
       home_path: /home/admin/observer
       # The directory for data storage. The default value is $home_path/store.
       # data_dir: /data
       # The directory for clog, ilog, and slog. The default value is the same as the data_dir value.
       # redo_dir: /redo
       zone: zone1
     server2:
       mysql_port: 2881 # External port for OceanBase Database. The default value is 2881. DO NOT change this value after the cluster is started.
       rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882. DO NOT change this value after the cluster is started.
       #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
       home_path: /home/admin/observer
       # The directory for data storage. The default value is $home_path/store.
       # data_dir: /data
       # The directory for clog, ilog, and slog. The default value is the same as the data_dir value.
       # redo_dir: /redo
       zone: zone2
     server3:
       mysql_port: 2881 # External port for OceanBase Database. The default value is 2881. DO NOT change this value after the cluster is started.
       rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882. DO NOT change this value after the cluster is started.
       #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
       home_path: /home/admin/observer
       # The directory for data storage. The default value is $home_path/store.
       # data_dir: /data
       # The directory for clog, ilog, and slog. The default value is the same as the data_dir value.
       # redo_dir: /redo
       zone: zone3
   

   For more information about the parameters, see the OceanBase Database part of the Parameters section in Configuration file. Compared with the configuration file for deploying only an OceanBase cluster, this configuration file provides the cdcro_password parameter. You can use this parameter to specify the password of the cdcro@sys user. If you do not specify the user password, obd automatically generates a random password string.

3. Configure ODP Community Edition and obconfigserver.

   If you do not use the binlog service of oblogproxy, you do not need to deploy ODP Community Edition or obconfigserver.

   The following sample code shows parameters of ODP Community Edition and obconfigserver in the configuration file:

   obproxy-ce:
     depends:
       - oceanbase-ce
     servers:
       - 10.10.10.1
     global:
       listen_port: 2883 # External port. The default value is 2883.
       prometheus_listen_port: 2884 # The Prometheus port. The default value is 2884.
       rpc_listen_port: 2885
       home_path: /home/admin/obproxy
       enable_cluster_checkout: false
       # observer cluster name, consistent with oceanbase-ce's appname. When a depends exists, obd gets this value from the oceanbase-ce of the depends.
       # cluster_name: obcluster
       skip_proxy_sys_private_check: true
       enable_strict_kernel_release: false
       obproxy_sys_password: ******** # obproxy sys user password, can be empty. When a depends exists, obd gets this value from the oceanbase-ce of the depends.
       # observer_sys_password: # proxyro user password, consistent with oceanbase-ce's proxyro_password, can be empty. When a depends exists, obd gets this value from the oceanbase-ce of the depends.
   ob-configserver:
     servers:
       - 10.10.10.1
     global:
       listen_port: 8080 # The port of ob-configserver web
       # server_ip: 0.0.0.0 # Listen to the ob-configserver server IP. When you want to listen to the specified IP address,use it.
       home_path: /home/admin/ob-configserver  # The working directory for prometheus. ob-configserver is started under this directory. This is a required field.
       ## log config
       # log_level: info # Log printing level of ob-configserver. The default value is `info`
       # log_maxsize: 30 # The total size of manager ob-configserver.Log size is measured in Megabytes.The default value is 30
       # log_maxage: 7 # The days of manager expired ob-configserver.Log retention days. The default value is 7
       # log_maxbackups: 10  #The number of manager expired ob-configserver.Log. The default value is 10
       # log_localtime: true #  Switch of ob-configserver.Log naming with localtime. The default value is true
       # log_compress: true # Compress ob-configserver.Log switch. The default value is true
   
       ## vip config, configserver will generate url with vip_address and port and return it to the client
       ## do not use some random value that can't be connected
       # vip_address: "10.10.10.1"
       # vip_port: 8080
       ## storage config
       # storage:
       #   database_type: sqlite3 # sqlite3 or mysql. Default sqlite3
       #   connection_url: "" # When database_type is set to sqlite3, the connection_url parameter can be left empty. If it is empty, the default value $home_path/.data.db?cache=shared&_fk=1 will be used. When database_type is set to mysql, the connection_url parameter must be configured, with a sample value of user:password@tcp(10.10.10.1:2883)/test?parseTime=true.
   

   For more information about the parameters, see the ODP and obconfigserver parts of the Parameters section in Configuration file.

4. Configure oblogproxy.

   The following sample code shows parameters of oblogproxy in the configuration file:

   oblogproxy:
     depends:
       - oceanbase-ce
       - obproxy-ce
     servers:
       - 10.10.10.1
     global:
       home_path: /home/admin/oblogproxy
       service_port: 2983
       # binlog_dir: /home/admin/oblogproxy/run   # The directory for binlog file. The default value is $home_path/run.
       # binlog_mode: true   # enable binlog mode, default true
   

   oblogproxy depends on OceanBase Database Community Edition and ODP Community Edition. The following table describes parameters in the configuration file:

   Parameter	Required?	Default value	Description
   version	No	Latest version	The version of the component to deploy. Generally, you do not need to specify this parameter. The latest version is deployed by default.
   servers	Yes	N/A	The servers. Specify each server in the format of - name: server identifier(line break)ip: server IP address. You can also specify a server in the - <ip> format. In this case, - <ip> is equivalent to - name: server IP address (line break) ip: server IP address.
   home_path	Yes	N/A	The installation path of oblogproxy.
   service_port	Yes	2983	The listening port of oblogproxy.
   binlog_dir	No	$home_path/run	The absolute path of the binlog service.
   binlog_mode	No	true	Specifies whether to enable the binlog service.

   Take note of the following considerations:

   • When you deploy oblogproxy by using obd, the·binlog_dir parameter in the configuration file of obd is equivalent to the binlog_log_bin_basename parameter in the configuration file of oblogproxy.

   • When you deploy oblogproxy by using obd, the default value of the binlog_mode parameter is true.

5. Deploy a cluster.

   [admin@test001 ~]$ obd cluster deploy obtest -c distributed-with-obproxy-and-oblogproxy-example.yaml
   

   After you run the obd cluster deploy command, if your server is connected to the Internet, obd checks whether the desired installation package exists in the local image repository. If no, obd automatically obtains the installation package from the YUM repository.

6. Start the cluster.

   [admin@test001 ~]$ obd cluster start obtest
   

7. Query the cluster status.

   [admin@test001 ~]$ obd cluster display obtest