通过命令行部署 OBLogProxy

此处以 distributed-with-obproxy-and-oblogproxy-example.yaml 配置文件为例，介绍如何部署 OBLogProxy。

1. 配置用户信息

   配置文件中，用户信息相关的配置如下：

   ## 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 为登录到目标机器的用户名，确保您的用户名有 home_path 的写权限。password 和 key_file 均用于验证用户，通常情况下只需要填写一个。

   注意

   在配置秘钥路径后，如果您的秘钥不需要口令，请注释或者删除 password，以免 password 被视为秘钥口令用于登录，导致校验失败。

2. 配置 oceanbase-ce 组件

   部署 OBLogProxy 时需要为 OBLogProxy 创建一个拥有只读权限的用户（cdcro@sys）。cdcro@sys 用户归属于 OceanBase 数据库，OBLogProxy 仅拥有该用户的使用权。

   注意

   OBD V2.6.x 仅支持部署 OceanBase 数据库 V4.2.2 及之前版本。

   配置文件中，oceanbase-ce 组件的配置信息如下：

   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
       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
   

   详细的配置项介绍可参见 配置文件说明 中 配置项说明 章节下 OceanBase 数据库 部分介绍。与单独部署 OceanBase 集群相比，配置文件中新增了配置项 cdcro_password，该配置项用于配置 cdcro@sys 用户密码，未配置的情况下，OBD 会自动生成随机字符串。

3. 配置 obproxy-ce 和 ob-configserver 组件

   若无需使用 OBLogProxy 的 Binlog Service 服务，可不部署 OBProxy 和 Config Server。配置文件中，obproxy-ce 和 ob-configserver 组件的配置信息如下：

   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.
       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.
   

   详细的配置项介绍可参见 配置文件说明 中 配置项说明 章节下 ODP 和 Config Server 部分介绍。

4. 配置 oblogproxy 组件

   配置文件中，oblogproxy 组件的配置信息如下：

   oblogproxy:
     version: 2.0.0
     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 依赖于 oceanbase-ce 和 obproxy-ce 组件，配置文件介绍如下：

   配置项	是否必选	默认值	说明
   version	可选	默认部署最新版本	指定待部署组件版本，通常情况下不需要指定。
   servers	必选	无	每台机器需要用 - name: 机器标识名 (换行)ip: 机器 IP 指定，也可以使用 - <ip> 的格式指定，此时 - <ip> 的格式相当于 - name: 机器标识名（换行）ip: 机器 IP。
   home_path	必选	无	OBLogProxy 的安装路径。
   service_port	必选	2983	OBLogProxy 服务监听端口。
   binlog_dir	可选	$home_path/run	Binlog 服务目录根路径，需配置为绝对路径。
   binlog_mode	可选	true	控制是否开启 Binlog 模式。

   其他 OBLogProxy 相关配置项可参见《OceanBase 日志代理服务》文档中 配置文件 一文，需要注意如下几点：

   • 使用 OBD 部署 OBLogProxy 时，OBD 中的 binlog_dir 配置项对应 OBLogProxy 原本的 binlog_log_bin_basename 配置项。

   • 使用 OBD 部署 OBLogProxy 时，binlog_mode 配置项的默认值为 true。

5. 部署集群

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

   联网情况下，在您执行了 obd cluster deploy 命令之后，OBD 将检查本地镜像库中是否有部署所需安装包。如果没有安装包，OBD 将自动从 YUM 源获取。

6. 启动集群

   [admin@test001 ~]$ obd cluster start obtest
   

7. 查看集群状态

   [admin@test001 ~]$ obd cluster display obtest