Merge pull request #7 from frf12/doc

add log-related config to the example file and update the default val…

README-CN.md

@@ -72,7 +72,7 @@
 在此之前您需要确认以下信息：
 
 - 当前用户为 root。
-- `2882` 和 `2883` 端口没有被占用。
+- `2881` 和 `2882` 端口没有被占用。
 - 您的机器内存应该不低于 8G。
 - 您的机器 CPU 数目应该不低于 2。
 
@@ -82,7 +82,7 @@
 obd cluster deploy c1 -c ./example/mini-local-example.yaml
 obd cluster start c1
 # 使用 mysql 客户端链接到到 OceanBase 数据库。
-mysql -h127.1 -uroot -P2883
+mysql -h127.1 -uroot -P2881
 ```
 
 ## 使用 OBD 启动 OceanBase 数据库集群

README.md

@@ -72,7 +72,7 @@
 在此之前您需要确认以下信息：
 
 - 当前用户为 root。
-- `2882` 和 `2883` 端口没有被占用。
+- `2881` 和 `2882` 端口没有被占用。
 - 您的机器内存应该不低于 8G。
 - 您的机器 CPU 数目应该不低于 2。
 
@@ -82,7 +82,7 @@
 obd cluster deploy c1 -c ./example/mini-local-example.yaml
 obd cluster start c1
 # 使用 mysql 客户端链接到到 OceanBase 数据库。
-mysql -h127.1 -uroot -P2883
+mysql -h127.1 -uroot -P2881
 ```
 
 ## 使用 OBD 启动 OceanBase 数据库集群

example/distributed-example.yaml

@@ -3,6 +3,8 @@
 #   username: your username
 #   password: your password if need
 #   key_file: your ssh-key file path if need
+#   port: your ssh port, default 22
+#   timeout: ssh connection timeout (second), default 30
 oceanbase-ce:
   servers:
     - name: z1
@@ -20,21 +22,24 @@ oceanbase-ce:
     # 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
   # 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: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone1
   z2:
-    mysql_port: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone2
   z3:
-    mysql_port: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone3

example/distributed-with-obproxy-example.yaml

@@ -3,6 +3,8 @@
 #   username: your username
 #   password: your password if need
 #   key_file: your ssh-key file path if need
+#   port: your ssh port, default 22
+#   timeout: ssh connection timeout (second), default 30
 oceanbase-ce:
   servers:
     - name: z1
@@ -20,21 +22,26 @@ oceanbase-ce:
     # 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
+    # observer cluster name, consistent with obproxy's cluster_name
+    appname: observer_cluster_name
   # 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: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone1
   z2:
-    mysql_port: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone2
   z3:
-    mysql_port: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone3
@@ -46,5 +53,7 @@ obproxy:
     home_path: /root/obproxy
     # oceanbase root server list
     # format: ip:mysql_port,ip:mysql_port
-    rs_list: 192.168.1.2:2883;192.168.1.3:2883;192.168.1.4:2883
-    enable_cluster_checkout: false
\ No newline at end of file
+    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: observer_cluster_name
\ No newline at end of file

example/local-example.yaml

@@ -8,10 +8,13 @@ oceanbase-ce:
     # 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: 2883
+    mysql_port: 2881
     rpc_port: 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
\ No newline at end of file

example/mini-distributed-example.yaml

@@ -3,6 +3,8 @@
 #   username: your username
 #   password: your password if need
 #   key_file: your ssh-key file path if need
+#   port: your ssh port, default 22
+#   timeout: ssh connection timeout (second), default 30
 oceanbase-ce:
   servers:
     - name: z1
@@ -18,7 +20,6 @@ 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
     cluster_id: 1
-    datafile_size: 8G
     # please set memory limit to a suitable value which is matching resource. 
     memory_limit: 8G
     system_memory: 4G
@@ -35,18 +36,21 @@ oceanbase-ce:
     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
   z1:
-    mysql_port: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone1
   z2:
-    mysql_port: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone2
   z3:
-    mysql_port: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone3

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

@@ -3,6 +3,8 @@
 #   username: your username
 #   password: your password if need
 #   key_file: your ssh-key file path if need
+#   port: your ssh port, default 22
+#   timeout: ssh connection timeout (second), default 30
 oceanbase-ce:
   servers:
     - name: z1
@@ -18,7 +20,6 @@ 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
     cluster_id: 1
-    datafile_size: 8G
     # please set memory limit to a suitable value which is matching resource. 
     memory_limit: 8G
     system_memory: 4G
@@ -35,18 +36,23 @@ oceanbase-ce:
     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
+    # observer cluster name, consistent with obproxy's cluster_name
+    appname: observer_cluster_name
   z1:
-    mysql_port: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone1
   z2:
-    mysql_port: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone2
   z3:
-    mysql_port: 2883
+    mysql_port: 2881
     rpc_port: 2882
     home_path: /root/observer
     zone: zone3
@@ -58,5 +64,7 @@ obproxy:
     home_path: /root/obproxy
     # oceanbase root server list
     # format: ip:mysql_port,ip:mysql_port
-    rs_list: 192.168.1.2:2883;192.168.1.3:2883;192.168.1.4:2883
-    enable_cluster_checkout: false
\ No newline at end of file
+    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: observer_cluster_name
\ No newline at end of file

example/mini-local-example.yaml

@@ -8,11 +8,10 @@ oceanbase-ce:
     # 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: 2883
+    mysql_port: 2881
     rpc_port: 2882
     zone: zone1
     cluster_id: 1
-    datafile_size: 8G
     # please set memory limit to a suitable value which is matching resource. 
     memory_limit: 8G
     system_memory: 4G
@@ -29,3 +28,6 @@ oceanbase-ce:
     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

example/mini-single-example.yaml

+## Only need to configure when remote login is required
+# user:
+#   username: your username
+#   password: your password if need
+#   key_file: your ssh-key file path if need
+#   port: your ssh port, default 22
+#   timeout: ssh connection timeout (second), default 30
 oceanbase-ce:
   servers:
     # Please don't use hostname, only IP can be supported
@@ -8,11 +15,10 @@ oceanbase-ce:
     # 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: 2883
+    mysql_port: 2881
     rpc_port: 2882
     zone: zone1
     cluster_id: 1
-    datafile_size: 8G
     # please set memory limit to a suitable value which is matching resource. 
     memory_limit: 8G
     system_memory: 4G
@@ -29,3 +35,6 @@ oceanbase-ce:
     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

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

@@ -3,6 +3,8 @@
 #   username: your username
 #   password: your password if need
 #   key_file: your ssh-key file path if need
+#   port: your ssh port, default 22
+#   timeout: ssh connection timeout (second), default 30
 oceanbase-ce:
   servers:
     # Please don't use hostname, only IP can be supported
@@ -13,11 +15,10 @@ oceanbase-ce:
     # 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: 2883
+    mysql_port: 2881
     rpc_port: 2882
     zone: zone1
     cluster_id: 1
-    datafile_size: 8G
     # please set memory limit to a suitable value which is matching resource. 
     memory_limit: 8G
     system_memory: 4G
@@ -34,6 +35,11 @@ oceanbase-ce:
     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
+    # observer cluster name, consistent with obproxy's cluster_name
+    appname: observer_cluster_name
 obproxy:
   servers:
     - 192.168.1.2
@@ -42,5 +48,7 @@ obproxy:
     home_path: /root/obproxy
     # oceanbase root server list
     # format: ip:mysql_port,ip:mysql_port
-    rs_list: 192.168.1.3:2883
-    enable_cluster_checkout: false
\ No newline at end of file
+    rs_list: 192.168.1.3:2881
+    enable_cluster_checkout: false
+    # observer cluster name, consistent with oceanbase-ce's appname
+    cluster_name: observer_cluster_name
\ No newline at end of file

example/single-example.yaml

@@ -3,6 +3,8 @@
 #   username: your username
 #   password: your password if need
 #   key_file: your ssh-key file path if need
+#   port: your ssh port, default 22
+#   timeout: ssh connection timeout (second), default 30
 oceanbase-ce:
   servers:
     # Please don't use hostname, only IP can be supported
@@ -13,10 +15,13 @@ oceanbase-ce:
     # 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: 2883
+    mysql_port: 2881
     rpc_port: 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
\ No newline at end of file

example/single-with-obproxy-example.yaml

@@ -3,6 +3,8 @@
 #   username: your username
 #   password: your password if need
 #   key_file: your ssh-key file path if need
+#   port: your ssh port, default 22
+#   timeout: ssh connection timeout (second), default 30
 oceanbase-ce:
   servers:
     # Please don't use hostname, only IP can be supported
@@ -12,8 +14,7 @@ oceanbase-ce:
     # 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: 2883
+    mysql_port: 2881
     rpc_port: 2882
     zone: zone1
     # Please set devname as the network adaptor's name whose ip is  in the setting of severs.
@@ -23,7 +24,12 @@ oceanbase-ce:
     # 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
+    # observer cluster name, consistent with obproxy's cluster_name
+    appname: observer_cluster_name
 obproxy:
   servers:
     - 192.168.1.2
@@ -32,5 +38,7 @@ obproxy:
     home_path: /root/obproxy
     # oceanbase root server list
     # format: ip:mysql_port,ip:mysql_port
-    rs_list: 192.168.1.3:2883
-    enable_cluster_checkout: false
\ No newline at end of file
+    rs_list: 192.168.1.3:2881
+    enable_cluster_checkout: false
+    # observer cluster name, consistent with oceanbase-ce's appname
+    cluster_name: observer_cluster_name
\ No newline at end of file