This topic describes the parameters in the configuration file for deploying OceanBase Database Proxy (ODP) by using OceanBase Deployer (OBD).
obproxy-ce:
version: 3.2.3
# Set dependent components for the component.
# When the associated configurations are not done, OBD will automatically get these configurations from the dependent components.
depends:
- oceanbase-ce
servers:
- 10.10.10.1
global:
listen_port: 2883
prometheus_listen_port: 2884
home_path: /root/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.2:2881;10.10.10.3:2881;10.10.10.4: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
| Parameter | Description |
|---|---|
| version | The version of ODP to be deployed. If this parameter is not specified, OBD deploys the latest version of ODP by default. |
| servers | The ODP node. Change the IP address to the planned IP address of the ODP node. For multiple ODP nodes, use the format in Examples. |
| listen_port | The access port that ODP uses to provide external services. Default value: 2883. |
| prometheus_listen_port | The port that ODP uses to connect to a Prometheus port. Default value: 2884. |
| home_path | The working directory of ODP, which includes sub-directories such as bin, lib, etc, and log. The directory must be created in advance. |
| rs_list | The list of RootServers of OceanBase Database, in the format of ip:mysql_port;ip:mysql_port. If a dependency exists, OBD obtains the list from the dependency oceanbase-ce. |
| enable_cluster_checkout | Specifies whether to check the cluster name. |
| enable_strict_kernel_release | Specifies whether to check the OS kernel. |
| cluster_name | The name of the OceanBase cluster that ODP can connect to. If a dependency exists, OBD obtains the cluster name from the dependency oceanbase-ce. |
| obproxy_sys_password | The password of the root@proxysys user. This parameter can be left empty. If a dependency exists, OBD obtains the password from the dependency oceanbase-ce. |
| observer_sys_password | The password of the proxyro@sys user. It must be the same as the value of proxyro_password of oceanbase-ce. This parameter can be left empty. If a dependency exists, OBD obtains the password from the dependency oceanbase-ce. |
Examples
obproxy-ce:
depends:
- oceanbase-ce
servers:
- name: proxy1
ip: 10.10.10.1
- name: proxy2
ip: 10.10.10.2
