add port intro (#45)

* add port intro

* fix typo

* remove extra spaces

* update

* update3

* update4

example/autodeploy/distributed-example.yaml

@@ -21,9 +21,9 @@ oceanbase-ce:
     # 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.
+    # External port for OceanBase Database. The default value is 2881. DO NOT change this value after the cluster is started.
     # mysql_port: 2881
-    # Internal port for OceanBase Database. The default value is 2882.
+    # Internal port for OceanBase Database. The default value is 2882. DO NOT change this value after the cluster is started.
     # rpc_port: 2882
     # Defines the zone for an observer. The default value is zone1.
     # zone: zone1

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

@@ -21,9 +21,9 @@ oceanbase-ce:
     # 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.
+    # External port for OceanBase Database. The default value is 2881.DO NOT change this value after the cluster is started.
     # mysql_port: 2881
-    # Internal port for OceanBase Database. The default value is 2882.
+    # Internal port for OceanBase Database. The default value is 2882. DO NOT change this value after the cluster is started.
     # rpc_port: 2882
     # Defines the zone for an observer. The default value is zone1.
     # zone: zone1

example/autodeploy/single-example.yaml

@@ -16,9 +16,9 @@ oceanbase-ce:
     # 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.
+    # External port for OceanBase Database. The default value is 2881. DO NOT change this value after the cluster is started.
     # mysql_port: 2881
-    # Internal port for OceanBase Database. The default value is 2882.
+    # Internal port for OceanBase Database. The default value is 2882. DO NOT change this value after the cluster is started.
     # rpc_port: 2882
     # Defines the zone for an observer. The default value is zone1.
     # zone: zone1

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

@@ -16,9 +16,9 @@ oceanbase-ce:
     # 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.
+    # External port for OceanBase Database. The default value is 2881. DO NOT change this value after the cluster is started.
     # mysql_port: 2881
-    # Internal port for OceanBase Database. The default value is 2882.
+    # Internal port for OceanBase Database. The default value is 2882. DO NOT change this value after the cluster is started.
     # rpc_port: 2882
     # Defines the zone for an observer. The default value is zone1.
     # zone: zone1

example/distributed-example.yaml

@@ -32,8 +32,8 @@ oceanbase-ce:
   # 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 # External port for OceanBase Database. The default value is 2881.
-    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.
@@ -42,8 +42,8 @@ oceanbase-ce:
     # redo_dir: /redo
     zone: zone1
   z2:
-    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.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.
@@ -52,8 +52,8 @@ oceanbase-ce:
     # redo_dir: /redo
     zone: zone2
   z3:
-    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.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.

example/distributed-with-obproxy-example.yaml

@@ -35,8 +35,8 @@ oceanbase-ce:
   # 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 # External port for OceanBase Database. The default value is 2881.
-    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.
@@ -45,8 +45,8 @@ oceanbase-ce:
     # redo_dir: /redo
     zone: zone1
   z2:
-    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.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.
@@ -55,8 +55,8 @@ oceanbase-ce:
     # redo_dir: /redo
     zone: zone2
   z3:
-    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.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.

example/local-example.yaml

@@ -13,8 +13,8 @@ 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: 2881 # External port for OceanBase Database. The default value is 2881.
-    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    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.
     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 # The maximum running memory for an observer

example/mini-distributed-example.yaml

@@ -42,8 +42,8 @@ oceanbase-ce:
     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 # External port for OceanBase Database. The default value is 2881.
-    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.
@@ -52,8 +52,8 @@ oceanbase-ce:
     # redo_dir: /redo
     zone: zone1
   z2:
-    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.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.
@@ -62,8 +62,8 @@ oceanbase-ce:
     # redo_dir: /redo
     zone: zone2
   z3:
-    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.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.

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

@@ -45,8 +45,8 @@ oceanbase-ce:
     # 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 # External port for OceanBase Database. The default value is 2881.
-    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.
@@ -55,8 +55,8 @@ oceanbase-ce:
     # redo_dir: /redo
     zone: zone1
   z2:
-    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.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.
@@ -65,8 +65,8 @@ oceanbase-ce:
     # redo_dir: /redo
     zone: zone2
   z3:
-    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.
+    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: /root/observer
     # The directory for data storage. The default value is $home_path/store.

example/mini-local-example.yaml

@@ -13,8 +13,8 @@ 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: 2881 # External port for OceanBase Database. The default value is 2881.
-    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    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.
     zone: zone1
     cluster_id: 1
     # please set memory limit to a suitable value which is matching resource. 

example/mini-single-example.yaml

@@ -20,8 +20,8 @@ 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: 2881 # External port for OceanBase Database. The default value is 2881.
-    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    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.
     zone: zone1
     cluster_id: 1
     # please set memory limit to a suitable value which is matching resource. 

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

@@ -20,8 +20,8 @@ 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: 2881 # External port for OceanBase Database. The default value is 2881.
-    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    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.
     zone: zone1
     cluster_id: 1
     # please set memory limit to a suitable value which is matching resource. 

example/single-example.yaml

@@ -20,8 +20,8 @@ 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: 2881 # External port for OceanBase Database. The default value is 2881.
-    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    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.
     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 # The maximum running memory for an observer

example/single-with-obproxy-example.yaml

@@ -20,8 +20,8 @@ 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: 2881 # External port for OceanBase Database. The default value is 2881.
-    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882.
+    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.
     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 # The maximum running memory for an observer