add comment info for about etcd

zhuxiangkui-zz · Mar 21, 2017 · 373e784 · 373e784
1 parent 185043b
commit 373e784
Show file tree

Hide file tree

Showing 10 changed files with 77 additions and 0 deletions.
diff --git a/common/etcd_config_get.erl b/common/etcd_config_get.erl
@@ -1,3 +1,12 @@
+
+%%%
+% feature: get configure info from etcd server
+% params : Prefix, Appname, Key(option)
+% example: ./erl_expect -sname ejabberd@ebs-ali-beijing-88 -setcookie secret common/etcd_config_get.erl "/imstest/vip1/msync/workerconfig/all" "msync" "httpc_timeout"
+%          ./erl_expect -sname ejabberd@ebs-ali-beijing-88 -setcookie secret common/etcd_config_get.erl "/imstest/vip1/msync/workerconfig/all" "msync"
+% note   : 在某一台msync/ejabberd 节点上执行即可
+%%%
+
 echo(off),
 
 FparseKey =

diff --git a/common/etcd_config_set.erl b/common/etcd_config_set.erl
@@ -1,3 +1,13 @@
+
+%%%
+% feature: set configure info into etcd server
+% params : Prefix, Appname, Key, value
+% example: ./erl_expect -sname ejabberd@ebs-ali-beijing-88 -setcookie secret ejabberd/etcd_config_get.erl "/imstest/vip1/msync/workerconfig/all" "msync" "httpc_timeout" "30000"
+%          ./erl_expect -sname ejabberd@ebs-ali-beijing-88 -setcookie secret ejabberd/etcd_config_get.erl "/imstest/vip1/msync/workerconfig/all" "message_store" "log" "[{host, \"redis\"},{port, 6379},{db, 0},{pool_size, 1}]"
+% note   : 在某一台msync/ejabberd 节点上执行即可
+%%%
+
+
 echo(off),
 
 case Args of

diff --git a/ejabberd/ejabberd_disable_etcd_config.erl b/ejabberd/ejabberd_disable_etcd_config.erl
@@ -1,3 +1,10 @@
+
+%%%
+% feature: disable etcd configure management feature on ejabberd
+% params :
+% example: ./erl_expect -sname ejabberd@ebs-ali-beijing-88 -setcookie secret ejabberd/ejabberd_disable_etcd_config.erl
+%%%
+
 echo(off),
 ok = ejabberd_etcd_config:disable_etcd_config(),
 ok.
diff --git a/ejabberd/ejabberd_disable_etcd_service_discovery.erl b/ejabberd/ejabberd_disable_etcd_service_discovery.erl
@@ -1,3 +1,10 @@
+
+%%%
+% feature: disable etcd service discovery feature on ejabberd
+% params :
+% example: ./erl_expect -sname ejabberd@ebs-ali-beijing-88 -setcookie secret ejabberd/ejabberd_disable_etcd_service_discovery.erl
+%%%
+
 echo(off),
 ejabberd_etcd_register:disable_etcd_service_disc(),
 ok.
diff --git a/ejabberd/ejabberd_enable_etcd_config.erl b/ejabberd/ejabberd_enable_etcd_config.erl
@@ -1,3 +1,10 @@
+
+%%%
+% feature: enable etcd configure management feature on ejabberd
+% params :
+% example: ./erl_expect -sname ejabberd@ebs-ali-beijing-88 -setcookie secret ejabberd/ejabberd_enable_etcd_config.erl
+%%%
+
 echo(off),
 EtcdClient =
     {ejabberd_etcd_client,

diff --git a/ejabberd/ejabberd_enable_etcd_service_discovery.erl b/ejabberd/ejabberd_enable_etcd_service_discovery.erl
@@ -1,3 +1,10 @@
+
+%%%
+% feature: enable etcd service discovery feature on ejabberd
+% params :
+% example: ./erl_expect -sname ejabberd@ebs-ali-beijing-88 -setcookie secret ejabberd/ejabberd_enable_etcd_service_discovery.erl
+%%%
+
 echo(off),
 EtcdClient =
     {ejabberd_etcd_client,

diff --git a/msync/msync_disable_etcd_config.erl b/msync/msync_disable_etcd_config.erl
@@ -1,3 +1,10 @@
+
+%%%
+% feature: disable etcd configure management feature on msync
+% params :
+% example: ./erl_expect -sname msync@ebs-ali-beijing-88 -setcookie secret msync/msync_disable_etcd_config.erl
+%%%
+
 echo(off),
 ok = msync_etcd_config:disable_etcd_config(),
 ok.
diff --git a/msync/msync_disable_etcd_service_discovery.erl b/msync/msync_disable_etcd_service_discovery.erl
@@ -1,3 +1,10 @@
+
+%%%
+% feature: disable etcd service discovery feature on msync
+% params :
+% example: ./erl_expect -sname msync@ebs-ali-beijing-88 -setcookie secret msync/msync_disable_etcd_service_discovery.erl
+%%%
+
 echo(off),
 msync_etcd_register:disable_etcd_service_disc(),
 ok.
diff --git a/msync/msync_enable_etcd_config.erl b/msync/msync_enable_etcd_config.erl
@@ -1,3 +1,11 @@
+
+%%%
+% feature: enable etcd configure management feature on msync
+% params :
+% example: ./erl_expect -sname msync@ebs-ali-beijing-88 -setcookie secret msync/msync_enable_etcd_config.erl
+%%%
+
+
 echo(off),
 EtcdClient =
     {msync_etcd_client,

diff --git a/msync/msync_enable_etcd_service_discovery.erl b/msync/msync_enable_etcd_service_discovery.erl
@@ -1,3 +1,11 @@
+
+%%%
+% feature: enable etcd service discovery feature on msync
+% params :
+% example: ./erl_expect -sname msync@ebs-ali-beijing-88 -setcookie secret msync/msync_enable_etcd_service_discovery.erl
+%%%
+
+
 echo(off),
 EtcdClient =
     {msync_etcd_client,