update example (#35)

* update example

* update example

example/autodeploy/distributed-example.yaml

@@ -15,33 +15,45 @@ oceanbase-ce:
     - name: z3
       ip: 172.19.33.4
   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
-    # if current hardware's memory capacity is smaller than 50G, please use the setting of "mini-single-example.yaml" and do a small adjustment.
-    memory_limit: 64G
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_wf: false
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
-    cluster_id: 1
-    # root_password: # root user password
-  # In this example , support multiple ob process in single node, so different process use different ports.
-  # If deploy ob cluster in multiple nodes, the port and path setting can be same. 
-  z1:
-    mysql_port: 2881
-    rpc_port: 2882
+    # The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
+    # External port for OceanBase Database. The default value is 2881.
+    # mysql_port: 2881
+    # Internal port for OceanBase Database. The default value is 2882.
+    # rpc_port: 2882
+    # Defines the zone for an observer. The default value is zone1.
+    # zone: zone1
+    # The maximum running memory for an observer. When ignored, autodeploy calculates this value based on the current server available resource.
+    # memory_limit: 58G
+    # The percentage of the maximum available memory to the total memory. This value takes effect only when memory_limit is 0. The default value is 80.
+    # memory_limit_percentage: 80 
+    # The reserved system memory. system_memory is reserved for general tenants. The default value is 30G. Autodeploy calculates this value based on the current server available resource.
+    # system_memory: 22G
+    # The size of a data file. When ignored, autodeploy calculates this value based on the current server available resource.
+    # datafile_size: 200G
+    # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    # datafile_disk_percentage: 90
+    # System log level. The default value is INFO.
+    # syslog_level: INFO
+    # Print system logs whose levels are higher than WARNING to a separate log file. The default value is true. The default value for autodeploy mode is false.
+    # enable_syslog_wf: false
+    # Enable auto system log recycling or not. The default value is false. The default value for autodeploy mode is on.
+    # enable_syslog_recycle: true
+    # The maximum number of reserved log files before enabling auto recycling. When set to 0, no logs are deleted. The default value for autodeploy mode is 4.
+    # max_syslog_file_count: 4
+    # 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: obcluster
+    # Password for root. The default value is empty.
+    # root_password:
+    # Password for proxyro. proxyro_password must be the same as observer_sys_password. The default value is empty.
+    # proxyro_password:
+  z1:
     zone: zone1
   z2:
-    mysql_port: 2881
-    rpc_port: 2882
-    home_path: /root/observer
     zone: zone2
   z3:
-    mysql_port: 2881
-    rpc_port: 2882
-    home_path: /root/observer
     zone: zone3

example/distributed-example.yaml

@@ -20,27 +20,44 @@ oceanbase-ce:
     # if current ip is 192.168.1.10, and the ip's network adaptor's name is "eth0", please use "eth0"
     devname: eth0
     # if current hardware's memory capacity is smaller than 50G, please use the setting of "mini-single-example.yaml" and do a small adjustment.
-    memory_limit: 64G
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
-    cluster_id: 1
+    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_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    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.
     # root_password: # root user password
   # In this example , support multiple ob process in single node, so different process use different ports.
   # If deploy ob cluster in multiple nodes, the port and path setting can be same. 
   z1:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    # The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
   z2:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
   z3:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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

example/distributed-with-obproxy-example.yaml

@@ -20,45 +20,62 @@ oceanbase-ce:
     # if current ip is 192.168.1.10, and the ip's network adaptor's name is "eth0", please use "eth0"
     devname: eth0
     # if current hardware's memory capacity is smaller than 50G, please use the setting of "mini-single-example.yaml" and do a small adjustment.
-    memory_limit: 64G
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
-    cluster_id: 1
+    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_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    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: ob_cluster
+    appname: obcluster
     # root_password: # root user password, can be empty
     # proxyro_password: # proxyro user pasword, consistent with obproxy's observer_sys_password, can be empty
   # In this example , support multiple ob process in single node, so different process use different ports.
   # If deploy ob cluster in multiple nodes, the port and path setting can be same. 
   z1:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
   z2:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
   z3:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
 obproxy:
   servers:
     - 192.168.1.5
   global:
-    listen_port: 2883
-    prometheus_listen_port: 2884
+    listen_port: 2883 # External port. The default value is 2883.
+    prometheus_listen_port: 2884 # The Prometheus port. The default value is 2884.
     home_path: /root/obproxy
     # oceanbase root server list
     # format: ip:mysql_port,ip:mysql_port
     rs_list: 192.168.1.2:2881;192.168.1.3:2881;192.168.1.4:2881
     enable_cluster_checkout: false
     # observer cluster name, consistent with oceanbase-ce's appname
-    cluster_name: ob_cluster
+    cluster_name: obcluster
     # obproxy_sys_password: # obproxy sys user password, can be empty
     # observer_sys_password: # proxyro user pasword, consistent with oceanbase-ce's proxyro_password, can be empty

example/local-example.yaml

@@ -3,19 +3,26 @@ oceanbase-ce:
     # Please don't use hostname, only IP can be supported
     - 127.0.0.1
   global:
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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: lo
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
     zone: zone1
     # if current hardware's memory capacity is smaller than 50G, please use the setting of "mini-single-example.yaml" and do a small adjustment.
-    memory_limit: 64G
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
-    cluster_id: 1
+    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_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    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.
     # root_password: # root user password, can be empty
\ No newline at end of file

example/mini-distributed-example.yaml

@@ -21,8 +21,8 @@ oceanbase-ce:
     devname: eth0
     cluster_id: 1
     # please set memory limit to a suitable value which is matching resource. 
-    memory_limit: 8G
-    system_memory: 4G
+    memory_limit: 8G # The maximum running memory for an observer
+    system_memory: 4G # The reserved system memory. system_memory is reserved for general tenants. The default value is 30G.
     stack_size: 512K
     cpu_count: 16
     cache_wash_threshold: 1G
@@ -35,23 +35,39 @@ oceanbase-ce:
     minor_freeze_times: 10
     enable_separate_sys_clog: 0
     enable_merge_by_turn: FALSE
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
+    datafile_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    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.
     # root_password: # root user password, can be empty
   z1:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
   z2:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
   z3:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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

example/mini-distributed-with-obproxy-example.yaml

@@ -21,8 +21,8 @@ oceanbase-ce:
     devname: eth0
     cluster_id: 1
     # please set memory limit to a suitable value which is matching resource. 
-    memory_limit: 8G
-    system_memory: 4G
+    memory_limit: 8G # The maximum running memory for an observer
+    system_memory: 4G # The reserved system memory. system_memory is reserved for general tenants. The default value is 30G.
     stack_size: 512K
     cpu_count: 16
     cache_wash_threshold: 1G
@@ -35,41 +35,57 @@ oceanbase-ce:
     minor_freeze_times: 10
     enable_separate_sys_clog: 0
     enable_merge_by_turn: FALSE
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
+    datafile_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    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: ob_cluster
+    appname: obcluster
     # root_password: # root user password, can be empty
     # proxyro_password: # proxyro user pasword, consistent with obproxy's observer_sys_password, can be empty
   z1:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
   z2:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
   z3:
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
 obproxy:
   servers:
     - 192.168.1.5
   global:
-    listen_port: 2883
-    prometheus_listen_port: 2884
+    listen_port: 2883 # External port. The default value is 2883.
+    prometheus_listen_port: 2884 # The Prometheus port. The default value is 2884.
     home_path: /root/obproxy
     # oceanbase root server list
     # format: ip:mysql_port,ip:mysql_port
     rs_list: 192.168.1.2:2881;192.168.1.3:2881;192.168.1.4:2881
     enable_cluster_checkout: false
     # observer cluster name, consistent with oceanbase-ce's appname
-    cluster_name: ob_cluster
+    cluster_name: obcluster
     # obproxy_sys_password: # obproxy sys user password, can be empty
     # observer_sys_password: # proxyro user pasword, consistent with oceanbase-ce's proxyro_password, can be empty

example/mini-local-example.yaml

@@ -3,18 +3,23 @@ oceanbase-ce:
     # Please don't use hostname, only IP can be supported
     - 127.0.0.1
   global:
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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: lo
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
     zone: zone1
     cluster_id: 1
     # please set memory limit to a suitable value which is matching resource. 
-    memory_limit: 8G
-    system_memory: 4G
+    memory_limit: 8G # The maximum running memory for an observer
+    system_memory: 4G # The reserved system memory. system_memory is reserved for general tenants. The default value is 30G.
     stack_size: 512K
     cpu_count: 16
     cache_wash_threshold: 1G
@@ -27,8 +32,9 @@ oceanbase-ce:
     minor_freeze_times: 10
     enable_separate_sys_clog: 0
     enable_merge_by_turn: FALSE
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
+    datafile_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    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.
     # root_password: # root user password, can be empty

example/mini-single-example.yaml

@@ -10,18 +10,23 @@ oceanbase-ce:
     # Please don't use hostname, only IP can be supported
     - 192.168.1.3
   global:
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
     zone: zone1
     cluster_id: 1
     # please set memory limit to a suitable value which is matching resource. 
-    memory_limit: 8G
-    system_memory: 4G
+    memory_limit: 8G # The maximum running memory for an observer
+    system_memory: 4G # The reserved system memory. system_memory is reserved for general tenants. The default value is 30G.
     stack_size: 512K
     cpu_count: 16
     cache_wash_threshold: 1G
@@ -34,8 +39,9 @@ oceanbase-ce:
     minor_freeze_times: 10
     enable_separate_sys_clog: 0
     enable_merge_by_turn: FALSE
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
+    datafile_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    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.
     # root_password: # root user password, can be empty

example/mini-single-with-obproxy-example.yaml

@@ -10,18 +10,23 @@ oceanbase-ce:
     # Please don't use hostname, only IP can be supported
     - 192.168.1.3
   global:
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
     zone: zone1
     cluster_id: 1
     # please set memory limit to a suitable value which is matching resource. 
-    memory_limit: 8G
-    system_memory: 4G
+    memory_limit: 8G # The maximum running memory for an observer
+    system_memory: 4G # The reserved system memory. system_memory is reserved for general tenants. The default value is 30G.
     stack_size: 512K
     cpu_count: 16
     cache_wash_threshold: 1G
@@ -34,26 +39,27 @@ oceanbase-ce:
     minor_freeze_times: 10
     enable_separate_sys_clog: 0
     enable_merge_by_turn: FALSE
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
+    datafile_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    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: ob_cluster
+    appname: obcluster
     # root_password: # root user password, can be empty
     # proxyro_password: # proxyro user pasword, consistent with obproxy's observer_sys_password, can be empty
 obproxy:
   servers:
     - 192.168.1.2
   global:
-    listen_port: 2883
-    prometheus_listen_port: 2884
+    listen_port: 2883 # External port. The default value is 2883.
+    prometheus_listen_port: 2884 # The Prometheus port. The default value is 2884.
     home_path: /root/obproxy
     # oceanbase root server list
     # format: ip:mysql_port,ip:mysql_port
     rs_list: 192.168.1.3:2881
     enable_cluster_checkout: false
     # observer cluster name, consistent with oceanbase-ce's appname
-    cluster_name: ob_cluster
+    cluster_name: obcluster
     # obproxy_sys_password: # obproxy sys user password, can be empty
     # observer_sys_password: # proxyro user pasword, consistent with oceanbase-ce's proxyro_password, can be empty

example/single-example.yaml

@@ -10,19 +10,26 @@ oceanbase-ce:
     # Please don't use hostname, only IP can be supported
     - 192.168.1.3
   global:
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
     zone: zone1
     # if current hardware's memory capacity is smaller than 50G, please use the setting of "mini-single-example.yaml" and do a small adjustment.
-    memory_limit: 64G
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
-    cluster_id: 1
+    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_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    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.
     # root_password: # root user password, can be empty
\ No newline at end of file

example/single-with-obproxy-example.yaml

@@ -10,37 +10,44 @@ oceanbase-ce:
     # Please don't use hostname, only IP can be supported
     - 192.168.1.3
   global:
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
     home_path: /root/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
-    mysql_port: 2881
-    rpc_port: 2882
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
     zone: zone1
     # if current hardware's memory capacity is smaller than 50G, please use the setting of "mini-single-example.yaml" and do a small adjustment.
-    memory_limit: 64G
-    datafile_disk_percentage: 20
-    syslog_level: INFO
-    enable_syslog_recycle: true
-    max_syslog_file_count: 4
-    cluster_id: 1
+    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_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    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: ob_cluster
+    appname: obcluster
     # root_password: # root user password, can be empty
     # proxyro_password: # proxyro user pasword, consistent with obproxy's observer_sys_password, can be empty
 obproxy:
   servers:
     - 192.168.1.2
   global:
-    listen_port: 2883
-    prometheus_listen_port: 2884
+    listen_port: 2883 # External port. The default value is 2883.
+    prometheus_listen_port: 2884 # The Prometheus port. The default value is 2884.
     home_path: /root/obproxy
     # oceanbase root server list
     # format: ip:mysql_port,ip:mysql_port
     rs_list: 192.168.1.3:2881
     enable_cluster_checkout: false
     # observer cluster name, consistent with oceanbase-ce's appname
-    cluster_name: ob_cluster
+    cluster_name: obcluster
     # obproxy_sys_password: # obproxy sys user password, can be empty
     # observer_sys_password: # proxyro user pasword, consistent with oceanbase-ce's proxyro_password, can be empty