部署 obconfigserver

步骤一：修改配置文件

创建一个配置文件，此处以配置文件名为 config.yaml 为例，该配置文件中各个组件的配置及注意事项如下所示。

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 数据库

   oceanbase-ce:
     depends:
       - ob-configserver
     servers:
       - name: server1
         # Please don't use hostname, only IP can be supported
         ip: 10.10.10.2
       - name: server2
         ip: 10.10.10.3
       - name: server3
         ip: 10.10.10.4
     global:
       # 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
       # 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
       cluster_id: 1
       # please set memory limit to a suitable value which is matching resource.
       memory_limit: 6G # The maximum running memory for an observer
       system_memory: 1G # The reserved system memory. system_memory is reserved for general tenants. The default value is 30G.
       datafile_size: 20G # Size of the data file.
       log_disk_size: 15G # The size of disk space used by the clog files.
       cpu_count: 16
       scenario: htap
       enable_auto_start: true
       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.
       obshell_port: 2886
       production_mode: false
       enable_syslog_wf: false # Print system logs whose levels are higher than WARNING to a separate log file. The default value is true.
       max_syslog_file_count: 4 # The maximum number of reserved log files before enabling auto recycling. The default value is 0.
       # Cluster name for OceanBase Database. The default value is obcluster. When you deploy OceanBase Database and obproxy, this value must be the same as the cluster_name for obproxy.
       appname: test
       root_password: ****** # root user password
       proxyro_password: ****** # proxyro user password, consistent with obproxy's observer_sys_password, can be empty
     server1:
       zone: zone1
     server2:
       zone: zone2
     server3:
       zone: zone3
   

   配置文件中各配置项含义可参见 配置文件说明 一文 配置项说明 部分。需要注意的配置项如下：

   • depends：您需配置 oceanbase-ce 组件依赖于 ob-configserver 组件，否则无法将该 OceanBase 数据库注册到 obconfigserver 中。

   • appname：用于配置集群的名字，不配置的情况下 OceanBase 数据库无法注册到 obconfigserver 中。

   • 若待部署的 OceanBase 数据库版本号不小于 V4.2.5，配置文件中未配置 scenario 时，obd 会提供交互式选项供用户选择负载类型。

   • 配置 enable_auto_start 为 true 即表示开启 observer 进程开机自启动功能，该功能需确保部署用户拥有 sudo 权限，且部署环境非容器环境。

3. ODP 组件

   obproxy-ce:
     # Set dependent components for the component.
     # When the associated configurations are not done, obd will automatically get the these configurations from the dependent components.
     depends:
       - oceanbase-ce
       - ob-configserver
     servers:
       - 10.10.10.5
     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
       # oceanbase root server list
       # format: ip:mysql_port;ip:mysql_port. When a depends exists, obd gets this value from the oceanbase-ce of the depends.
       # rs_list: 10.10.10.1:2881;10.10.10.2:2881;10.10.10.3:2881
       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.
   

   配置文件中各配置项含义可参见 配置文件说明 一文 配置项说明 部分。您需注意请勿配置 rs_list 配置项，否则 ODP 无法获取 obconfigserver 中注册的集群信息。

4. obconfigserver 组件

   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, support sqlite3 or mysql
         # sqlite3:
         # database_type: sqlite3
         # connection_url: "/home/admin/ob-configserver/.data.db?cache=shared&_fk=1"
   
         # mysql:
         # database_type: mysql
         # connection_url: "$user:$password@tcp($IP:$PORT)/$metadb?parseTime=true"
   

   配置文件中注释的配置项未打开时将使用默认值，您也可取消注释并配置为其他值。配置文件中需要注意的有如下几个配置项：

   • server_ip：ob-configserver 服务访问白名单，默认为 0.0.0.0，表示 ob-configserver 所在服务器的所有 IP 都可以访问。

   • vip_address 和 vip_port：vip_address 和 vip_port 为负载均衡访问地址配置项。若要在 servers 下配置多个节点，您需使用负载均衡，请在配置好负载均衡后，在配置文件中填写负载均衡地址 IP 与端口。

   • database_type：数据库类型，提供 sqlite3 与 mysql，默认为 sqlite3 类型，推荐使用 mysql 类型。

   • connection_url：数据库连接 URL。选择 sqlite3 类型时默认为 $home_path/.data.db?cache=shared&_fk=1；选择 mysql 类型时，connection_url 可以是 OceanBase 数据库，也可以是原生 MySQL。指定的数据库用户需要有 URL 里对应库 DDL 和 DML 的权限，需注意的是，使用 OceanBase 数据库时这里的库名请勿使用 oceanbase 库，否则会提示没有权限。

步骤二：启动 obconfigserver

1. 部署 obconfigserver

   [admin@obtest ~]$ obd cluster deploy test -c config.yaml
   

   此处以使用配置文件 config.yaml 部署 test 集群为例，您需根据实际情况修改部署集群名和配置文件名。

2. 启动 obconfigserver

   [admin@obtest ~]$ obd cluster start test
   

   输出如下，可以看到 obconfigserver 访问地址的打印信息。

   +-----------------------------------------------------------+
   |                      ob-configserver                      |
   +---------+------+---------------+----------+--------+------+
   | server  | port | vip_address   | vip_port | status | pid  |
   +---------+------+---------------+----------+--------+------+
   | 0.0.0.0 | 8080 | 10.10.10.1    | 8080     | active | 6270 |
   +---------+------+---------------+----------+--------+------+
   curl -s 'http://10.10.10.1:8080/services?Action=GetObProxyConfig'
   Wait for observer init ok
   +-------------------------------------------------+
   |                 oceanbase-ce                    |
   +---------------+---------+------+-------+--------+
   | ip            | version | port | zone  | status |
   +---------------+---------+------+-------+--------+
   | 10.10.10.2    | 4.3.5.0 | 2881 | zone1 | ACTIVE |
   +---------------+---------+------+-------+--------+
   | 10.10.10.3    | 4.3.5.0 | 2881 | zone2 | ACTIVE |
   +---------------+---------+------+-------+--------+
   | 10.10.10.4    | 4.3.5.0 | 2881 | zone3 | ACTIVE |
   +---------------+---------+------+-------+--------+
   obclient -h10.10.10.2 -P2881 -uroot -p'********' -Doceanbase -A
   
   +----------------------------------------------------------------+
   |                           obproxy-ce                           |
   +------------+------+-----------------+-----------------+--------+
   | ip         | port | prometheus_port | rpc_listen_port | status |
   +------------+------+-----------------+-----------------+--------+
   | 10.10.10.5 | 2883 | 2884            | 2885            | active |
   +------------+------+-----------------+-----------------+--------+
   obclient -h10.10.10.5 -P2883 -uroot@proxysys -p'********' -Doceanbase -A
   
   obshell program health check ok
   display ob-dashboard ok
   +-----------------------------------------------------------+
   |                        ob-dashboard                       |
   +---------------------------+------+---------------+--------+
   | url                       | user | password      | status |
   +---------------------------+------+---------------+--------+
   | http://10.10.10.2:2886    | root | '********'    | active |
   +---------------------------+------+---------------+--------+
   

注意

• 待注册的 OceanBase 集群配置文件需配置 appname 配置项，否则配置 obconfig_url 后重启会报错。

• 待注册的 OceanBase 集群需是已启动的集群，目前暂不支持配置待启动集群。

1. 您可执行 obd cluster edit-config 命令编辑已有集群的配置文件，将 obconfig_url 配置到 oceanbase-ce 组件的 global 模块下。

   配置项示例如下：

   obconfig_url: 'http://10.10.10.1:8080/services?Action=ObRootServiceInfo&ObCluster=test1'
   

   • 10.10.10.1:8080：obconfigserver 访问地址，此处仅为示例，您需根据实际情况修改。

   • test1：待注册的 OceanBase 集群的 appname 值，此处以 appname 值为 test1 为例，您需根据实际情况修改。

2. 执行 obd cluster reload 命令重启集群，此处以部署名为 test1 为例。

   obd cluster reload test1
   

3. 重启成功后可参照下文 查看 obconfigserver 中注册信息 内容验证该集群是否成功注册到 obconfigserver 中。

{
  "Code": 200,
  "Message": "successful",
  "Success": true,
  "Data": {
    "ObClusterId": 1,
    "ObRegionId": 1,
    "ObCluster": "test1",
    "ObRegion": "test1",
    "ReadonlyRsList": [],
    "RsList": [
      {
        "address": "10.10.10.4:4882",
        "role": "LEADER",
        "sql_port": 4881
      }
    ],
    "Type": "PRIMARY",
    "timestamp": 1692699586370950
  },
  "Trace": "362172a2d5de734c",
  "Server": "10.10.10.1",
  "Cost": 1
}