This is an automated email from the ASF dual-hosted git repository.
tianxiaoliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-service-center.git
The following commit(s) were added to refs/heads/master by this push:
new 6ea14f9 [SCB-2094]use data-source.rst (#870)
6ea14f9 is described below
commit 6ea14f9001559cd71f4775d9687be6630bd8a53f
Author: robotLJW <[email protected]>
AuthorDate: Wed Feb 24 11:17:58 2021 +0800
[SCB-2094]use data-source.rst (#870)
---
docs/conf.py | 1 -
docs/user-guides.rst | 2 +-
docs/user-guides/data-source.md | 122 ----------------------
docs/user-guides/data-source.rst | 212 +++++++++++++++++++++++++++++++++++++++
4 files changed, 213 insertions(+), 124 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index b52129e..a64db03 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -62,7 +62,6 @@ source_parsers = {
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- 'sphinx_markdown_tables',
]
# Add any paths that contain templates here, relative to this directory.
diff --git a/docs/user-guides.rst b/docs/user-guides.rst
index fad3bcd..bdfd5a6 100644
--- a/docs/user-guides.rst
+++ b/docs/user-guides.rst
@@ -7,7 +7,7 @@ User Guides
user-guides/pr-raising-guide.md
user-guides/security-tls.md
- user-guides/data-source.md
+ user-guides/data-source.rst
user-guides/sc-cluster.rst
user-guides/integration-grafana.rst
user-guides/rbac.md
diff --git a/docs/user-guides/data-source.md b/docs/user-guides/data-source.md
deleted file mode 100644
index a89f211..0000000
--- a/docs/user-guides/data-source.md
+++ /dev/null
@@ -1,122 +0,0 @@
-# Data Source
-
-## etcd
-
-Download the etcd according to your own
-environment. [Installation package
address](https://github.com/etcd-io/etcd/releases).
-
-Configure app.yaml according to your needs.
-
-```YAML
-registry:
- # buildin, etcd, embeded_etcd, mongo
- kind: etcd
- # registry cache, if this option value set 0, service center can run
- # in lower memory but no longer push the events to client.
- cache:
- mode: 1
- # the cache will be clear after X, if not set cache will be never clear
- ttl:
- # enabled if registry.kind equal to etcd or embeded_etcd
- etcd:
- # the interval of etcd health check, aggregation conflict check and sync
loop
- autoSyncInterval: 30s
- compact:
- # indicate how many revision you want to keep in etcd
- indexDelta: 100
- interval: 12h
- cluster:
- # if registry_plugin equals to 'embeded_etcd', then
- # name: sc-0
- # managerEndpoints: http://127.0.0.1:2380";
- # endpoints: sc-0=http://127.0.0.1:2380
- # if registry_plugin equals to 'etcd', then
- # endpoints: 127.0.0.1:2379
- endpoints: 127.0.0.1:2379
- # the timeout for failing to establish a connection
- connect:
- timeout: 10s
- # the timeout for failing to read response of registry
- request:
- timeout: 30s
-```
-
-| field | description | required | value |
-| :---- | :---- | :---- | :---- |
-| registry.kind | database type (etcd or mongo) | yes | etcd / mongo |
-| registry.cache.mode | open cache (1 is on, 0 is off)| yes | 1 / 0 |
-| registry.cache.ttl | cache timeout (if not set cache will be never clear)|
no | an integer time, like 30s/20m/10h |
-| registry.etcd.autoSyncInterval | synchronization interval | yes | an integer
time, like 30s/20m/10h |
-| registry.etcd.compact.indexDelta | version retained in etcd | yes | a 64 bit
integer, like 100 |
-| registry.etcd.compact.interval | compression interval | yes | an integer
time, like 30s/20m/10h |
-| registry.etcd.cluster.endpoints | endpoints address | yes | string, like
127.0.0.1:2379 |
-| registry.etcd.connect.timeout | the timeout for establishing a connection |
yes | an integer time, like 30s/20m/10h |
-| registry.etcd.request.timeout | request timeout | yes | an integer time,
like 30s/20m/10h |
-
-**Download the installation package according to the environment information**
-
-1. Download etcd package.
-2. Unzip, modify the configuration and start etcd.
-3. Download the latest release from [ServiceComb
Website](http://servicecomb.apache.org/release/).
-4. Decompress, modify /conf/app.yaml.
-5. Execute the start script to run service center
-
-## mongo
-
-Download the mongodb according to your own
-environment.[Installation package
address](https://www.mongodb.com/try/download/community).
-
-Configure app.yaml according to your needs.
-
-```YAML
-registry:
- # buildin, etcd, embeded_etcd, mongo
- kind: mongo
- # registry cache, if this option value set 0, service center can run
- # in lower memory but no longer push the events to client.
- cache:
- mode: 1
- # the cache will be clear after X, if not set cache will be never clear
- ttl:
- mongo:
- heartbeat:
- # Mongo's heartbeat plugin
- # heartbeat.kind="checker or cache"
- # if heartbeat.kind equals to 'cache', should set
cacheCapacity,workerNum and taskTimeout
- # capacity = 10000
- # workerNum = 10
- # timeout = 10
- kind: cache
- cacheCapacity: 10000
- workerNum: 10
- timeout: 10
- cluster:
- uri: mongodb://localhost:27017
- sslEnabled: false
- rootCAFile: /opt/ssl/ca.crt
- verifyPeer: false
- certFile: /opt/ssl/client.crt
- keyFile: /opt/ssl/client.key
-```
-
-| field | description | required | value |
-| :---- | :---- | :---- | :---- |
-| registry.kind | database type (etcd or mongo) | yes | mongo / etcd |
-| registry.cache.mode | open cache (1 is on, 0 is off)| yes | 1 / 0 |
-| registry.cache.ttl | cache timeout (if not set cache will be never clear)|
no | an integer time, like 30s/20m/10h |
-| registry.mongo.heartbeat.kind | there are two types of heartbeat plug-ins.
With cache and without cache. | yes | cache/checker |
-| registry.mongo.heartbeat.cacheCapacity | cache capacity | yes | a integer,
like 10000 |
-| registry.mongo.heartbeat.workerNum | the number of working cooperations |
yes | a integer, like 10 |
-| registry.mongo.heartbeat.timeout | processing task timeout (default unit:
s)| yes | a integer, like 10 |
-| registry.mongo.cluster.uri | mongodb server address | yes | string, like
mongodb://localhost:27017 |
-| registry.mongo.cluster.sslEnabled | ssl enabled / not enabled | yes | false
/ true |
-| registry.mongo.cluster.rootCAFile | if sslEnabled equal true, should set CA
file path | yes | string, like /opt/ssl/ca.crt |
-| registry.mongo.cluster.verifyPeer | insecure skip verify | yes | false /
true |
-| registry.mongo.cluster.certFile | the cert file path need to be set
according to the configuration of mongodb server | no | string, like
/opt/ssl/client.crt |
-| registry.mongo.cluster.keyFile | the key file path need to be set according
to the configuration of mongodb server | no | string, like /opt/ssl/client.key |
-
-1. Download mongodb package.
-2. Unzip, modify the configuration and start mongodb.[mongodb configure
ssl](https://docs.mongodb.com/v4.0/tutorial/configure-ssl/)
-3. Download the latest release from [ServiceComb
Website](http://servicecomb.apache.org/release/).
-4. Decompress, modify /conf/app.yaml.
-5. Execute the start script to run service center
\ No newline at end of file
diff --git a/docs/user-guides/data-source.rst b/docs/user-guides/data-source.rst
new file mode 100644
index 0000000..9d07bd6
--- /dev/null
+++ b/docs/user-guides/data-source.rst
@@ -0,0 +1,212 @@
+Data Source
+========================
+
+Etcd
+----------------------------------------
+Download the etcd according to your own
+environment. `Etcd Installation package address`_.
+
+Configure app.yaml according to your needs.
+
+::
+
+ registry:
+ # buildin, etcd, embeded_etcd, mongo
+ kind: etcd
+ # registry cache, if this option value set 0, service center can run
+ # in lower memory but no longer push the events to client.
+ cache:
+ mode: 1
+ # the cache will be clear after X, if not set cache will be never clear
+ ttl:
+ # enabled if registry.kind equal to etcd or embeded_etcd
+ etcd:
+ # the interval of etcd health check, aggregation conflict check and
sync loop
+ autoSyncInterval: 30s
+ compact:
+ # indicate how many revision you want to keep in etcd
+ indexDelta: 100
+ interval: 12h
+ cluster:
+ # if registry_plugin equals to 'embeded_etcd', then
+ # name: sc-0
+ # managerEndpoints: http://127.0.0.1:2380";
+ # endpoints: sc-0=http://127.0.0.1:2380
+ # if registry_plugin equals to 'etcd', then
+ # endpoints: 127.0.0.1:2379
+ endpoints: 127.0.0.1:2379
+ # the timeout for failing to establish a connection
+ connect:
+ timeout: 10s
+ # the timeout for failing to read response of registry
+ request:
+ timeout: 30s
+
+.. list-table::
+ :widths: 15 20 5 10
+ :header-rows: 1
+
+ * - field
+ - description
+ - required
+ - value
+ * - registry.kind
+ - database type (etcd or mongo)
+ - yes
+ - etcd / mongo
+ * - registry.cache.mode
+ - open cache (1 is on, 0 is off)
+ - yes
+ - 1 / 0
+ * - registry.cache.ttl
+ - cache timeout (if not set cache will be never clear)
+ - no
+ - an integer time, like 30s/20m/10h
+ * - registry.etcd.autoSyncInterval
+ - synchronization interval
+ - yes
+ - an integer time, like 30s/20m/10h
+ * - registry.etcd.compact.indexDelta
+ - version retained in etcd
+ - yes
+ - a 64 bit integer, like 100
+ * - registry.etcd.compact.interval
+ - compression interval
+ - yes
+ - an integer time, like 30s/20m/10h
+ * - registry.etcd.cluster.endpoints
+ - endpoints address
+ - yes
+ - string, like 127.0.0.1:2379
+ * - registry.etcd.connect.timeout
+ - the timeout for establishing a connection
+ - yes
+ - an integer time, like 30s/20m/10h
+ * - registry.etcd.request.timeout
+ - request timeout
+ - yes
+ - an integer time, like 30s/20m/10h
+
+**Download the installation package according to the environment information**
+
+1. Download etcd package.
+2. Unzip, modify the configuration and start etcd.
+3. Download the latest release from `ServiceComb Website`_.
+4. Decompress, modify /conf/app.yaml.
+5. Execute the start script to run service center
+
+
+
+Mongodb
+----------------------------------------
+
+Download the mongodb according to your own
+environment. `Mongodb Installation package address`_.
+
+Configure app.yaml according to your needs.
+
+::
+
+ registry:
+ # buildin, etcd, embeded_etcd, mongo
+ kind: mongo
+ # registry cache, if this option value set 0, service center can run
+ # in lower memory but no longer push the events to client.
+ cache:
+ mode: 1
+ # the cache will be clear after X, if not set cache will be never clear
+ ttl:
+ mongo:
+ heartbeat:
+ # Mongo's heartbeat plugin
+ # heartbeat.kind="checker or cache"
+ # if heartbeat.kind equals to 'cache', should set
cacheCapacity,workerNum and taskTimeout
+ # capacity = 10000
+ # workerNum = 10
+ # timeout = 10
+ kind: cache
+ cacheCapacity: 10000
+ workerNum: 10
+ timeout: 10
+ cluster:
+ uri: mongodb://localhost:27017
+ sslEnabled: false
+ rootCAFile: /opt/ssl/ca.pem
+ verifyPeer: false
+ certFile: /opt/ssl/client.crt
+ keyFile: /opt/ssl/client.key
+
+.. list-table::
+ :widths: 15 20 5 10
+ :header-rows: 1
+
+ * - field
+ - description
+ - required
+ - value
+ * - registry.kind
+ - database type (etcd or mongo)
+ - yes
+ - mongo / etcd
+ * - registry.cache.mode
+ - open cache (1 is on, 0 is off)
+ - yes
+ - 1 / 0
+ * - registry.cache.ttl
+ - cache timeout (if not set cache will be never clear)
+ - no
+ - an integer time, like 30s/20m/10h
+ * - registry.mongo.heartbeat.kind
+ - there are two types of heartbeat plug-ins. With cache and without cache.
+ - yes
+ - cache/checker
+ * - registry.mongo.heartbeat.cacheCapacity
+ - cache capacity
+ - yes
+ - a integer, like 10000
+ * - registry.mongo.heartbeat.workerNum
+ - the number of working cooperations
+ - yes
+ - a integer, like 10
+ * - registry.mongo.heartbeat.timeout
+ - processing task timeout (default unit: s)
+ - yes
+ - a integer, like 10
+ * - registry.mongo.cluster.uri
+ - mongodb server address
+ - yes
+ - string, like mongodb://localhost:27017
+ * - registry.mongo.cluster.sslEnabled
+ - ssl enabled / not enabled
+ - yes
+ - false / true
+ * - registry.mongo.cluster.rootCAFile
+ - if sslEnabled equal true, should set CA file path
+ - yes
+ - string, like /opt/ssl/ca.pem
+ * - registry.mongo.cluster.verifyPeer
+ - insecure skip verify
+ - yes
+ - false / true
+ * - registry.mongo.cluster.certFile
+ - the cert file path need to be set according to the configuration of
mongodb server
+ - no
+ - string, like /opt/ssl/client.crt
+ * - registry.mongo.cluster.keyFile
+ - the key file path need to be set according to the configuration of
mongodb server
+ - no
+ - string, like /opt/ssl/client.key
+
+
+**Download the installation package according to the environment information**
+
+1. Download mongodb package.
+2. Unzip, modify the configuration and start mongodb. `Mongodb configure ssl`_.
+3. Download the latest release from `ServiceComb Website`_.
+4. Decompress, modify /conf/app.yaml.
+5. Execute the start script to run service center
+
+.. _Etcd Installation package address: https://github.com/etcd-io/etcd/releases
+.. _Mongodb Installation package address:
https://www.mongodb.com/try/download/community
+.. _Mongodb configure ssl:
https://docs.mongodb.com/v4.0/tutorial/configure-ssl/
+.. _ServiceComb Website: http://servicecomb.apache.org/release/
\ No newline at end of file
