This is an automated email from the ASF dual-hosted git repository.
menghaoran pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new d808439 Update management document (#13419)
d808439 is described below
commit d8084398f215b47b3834061edafc93364c04f984
Author: Liang Zhang <[email protected]>
AuthorDate: Wed Nov 3 01:10:56 2021 +0800
Update management document (#13419)
* Update index of management
* Add concept of management
* Update management document
---
.../content/features/governance/_index.cn.md | 25 ------------
.../content/features/governance/_index.en.md | 27 -------------
.../features/governance/management/_index.cn.md | 12 ------
.../features/governance/management/_index.en.md | 12 ------
.../governance/management/change-history.cn.md | 46 ----------------------
.../governance/management/change-history.en.md | 46 ----------------------
.../governance/management/dependency.cn.md | 13 ------
.../governance/management/dependency.en.md | 13 ------
.../content/features/management/_index.cn.md | 23 +++++++++++
.../content/features/management/_index.en.md | 24 +++++++++++
.../content/features/management/concept.cn.md | 13 ++++++
.../content/features/management/concept.en.md | 14 +++++++
.../features/readwrite-splitting/_index.cn.md | 4 +-
.../features/readwrite-splitting/_index.en.md | 4 +-
.../content/features/sharding/_index.cn.md | 4 +-
.../content/features/sharding/_index.en.md | 4 +-
.../content/features/transaction/_index.cn.md | 4 +-
.../content/features/transaction/_index.en.md | 4 +-
.../reference/api-change-history/_index.cn.md | 4 +-
.../reference/api-change-history/_index.en.md | 4 +-
.../content/reference/encrypt/_index.cn.md | 4 +-
.../content/reference/encrypt/_index.en.md | 4 +-
docs/document/content/reference/faq/_index.cn.md | 4 +-
docs/document/content/reference/faq/_index.en.md | 4 +-
.../management/_index.cn.md} | 42 ++------------------
.../management/_index.en.md} | 39 +-----------------
.../content/reference/scaling/_index.cn.md | 4 +-
.../content/reference/scaling/_index.en.md | 6 +--
.../document/content/reference/shadow/_index.cn.md | 4 +-
.../document/content/reference/shadow/_index.en.md | 4 +-
.../content/reference/sharding/_index.cn.md | 4 +-
.../content/reference/sharding/_index.en.md | 4 +-
docs/document/content/reference/test/_index.cn.md | 4 +-
.../content/reference/transaction/_index.cn.md | 4 +-
.../content/reference/transaction/_index.en.md | 4 +-
.../usage/management/_index.cn.md | 35 ++++++++++++++++
.../usage/management/_index.en.md | 35 ++++++++++++++++
.../usage/observability/_index.cn.md | 2 +-
.../usage/observability/_index.en.md | 2 +-
39 files changed, 195 insertions(+), 314 deletions(-)
diff --git a/docs/document/content/features/governance/_index.cn.md
b/docs/document/content/features/governance/_index.cn.md
deleted file mode 100644
index 82c5b42..0000000
--- a/docs/document/content/features/governance/_index.cn.md
+++ /dev/null
@@ -1,25 +0,0 @@
-+++
-pre = "<b>4.5. </b>"
-title = "分布式治理"
-weight = 5
-chapter = true
-+++
-
-## 背景
-
-随着数据规模的不断膨胀，使用多节点集群的分布式方式逐渐成为趋势。
-在这种情况下，如何高效、自动化管理集群节点，实现不同节点的协同工作，配置一致性，状态一致性，高可用性等，就成为一个重要的挑战。
-
-## 挑战
-
-分布式治理的挑战，主要在于集群管理的复杂性。
-
-集成管理的复杂性体现在，一方面我们需要把所有的节点，不管是底层数据库节点，还是中间件或者业务系统节点，它们的状态都统一管理起来，并且能够实时的探测到最新的变动情况，进一步为集群的控制和调度提供依据。这方面我们使用集群拓扑状态图来管理集群状态，同时使用心跳检测机制实现状态检测与更新。
-
-另一方面，不同节点节点之间的统一协调，策略与规则的同步，也需要我们能够设计一套在分布式情况下，进行全局事件通知机制，以及独占性操作的分布式协调锁机制。这方面，我们使用
Zookeeper/Etcd 等实现配置的同步，状态变更的通知，以及分布式锁来控制排他性操作。
-
-同时，由于治理功能本身可以采用合适的第三方组件作为基础服务，需要我们抽象统一的接口，统一各种不同的组件的标准调用 API，对接到治理功能模块。
-
-## 目标
-
-支持 Zookeeper/etcd，管理数据源、规则和策略的配置，管理各个 Proxy 实例的状态。
diff --git a/docs/document/content/features/governance/_index.en.md
b/docs/document/content/features/governance/_index.en.md
deleted file mode 100644
index 1751113..0000000
--- a/docs/document/content/features/governance/_index.en.md
+++ /dev/null
@@ -1,27 +0,0 @@
-+++
-pre = "<b>4.5. </b>"
-title = "Governance"
-weight = 5
-chapter = true
-+++
-
-## Background
-
-As the scale of data continues to expand, a distributed approach using
multi-node clusters has gradually become a trend.
-In this case, how to efficiently and automatically manage cluster nodes,
realize the collaborative work of different nodes, configuration consistency,
state consistency, high availability, etc., has become a challenge.
-
-## Challenges
-
-The challenges of distributed governance mainly lie in the complexity of
cluster management.
-
-The complexity of integrated management is reflected in that on the one hand,
we need to manage the status of all nodes in a unified manner and can detect
the latest changes in real time, whether it is the underlying database node,
middleware or business system node, to further provide the basis for the
control and scheduling of the cluster.
-In this regard, we use the cluster topology state diagram to manage the
cluster state and the heartbeat detection mechanism to achieve state detection
and update.
-
-On the other hand, the unified coordination and the synchronization of
policies and rules between different nodes also require us to design a set of
global event notification mechanisms and distributed coordination lock
mechanisms for exclusive operations in distributed situations.
-In this regard, we use Zookeeper/Etcd to achieve configuration
synchronization, notification of state changes and distributed locks to control
exclusive operations.
-
-At the same time, since the governance function itself can use appropriate
third-party components as basic services, we need to abstract a unified
interface, unify the standard calling APIs of various components and dock to
the governance function module.
-
-## Goal
-
-Support Zookeeper/etcd, manage the configuration of data sources, rules and
policies, manage the status of each Proxy instances.
diff --git a/docs/document/content/features/governance/management/_index.cn.md
b/docs/document/content/features/governance/management/_index.cn.md
deleted file mode 100644
index 027e162..0000000
--- a/docs/document/content/features/governance/management/_index.cn.md
+++ /dev/null
@@ -1,12 +0,0 @@
-+++
-title = "治理"
-weight = 1
-chapter = true
-+++
-
-## 导览
-
-本小节主要介绍 Apache ShardingSphere 分布式治理的相关功能
-
-* 注册中心
-* 第三方组件依赖
diff --git a/docs/document/content/features/governance/management/_index.en.md
b/docs/document/content/features/governance/management/_index.en.md
deleted file mode 100644
index 825c5e6..0000000
--- a/docs/document/content/features/governance/management/_index.en.md
+++ /dev/null
@@ -1,12 +0,0 @@
-+++
-title = "Management"
-weight = 1
-chapter = true
-+++
-
-## Navigation
-
-This chapter mainly introduces the features of the distributed governance:
-
-* Registry center
-* Third-party components dependency
diff --git
a/docs/document/content/features/governance/management/change-history.cn.md
b/docs/document/content/features/governance/management/change-history.cn.md
deleted file mode 100644
index 1a1dfb4..0000000
--- a/docs/document/content/features/governance/management/change-history.cn.md
+++ /dev/null
@@ -1,46 +0,0 @@
-+++
-title = "变更历史"
-weight = 3
-+++
-
-## 5.0.0-alpha
-
-### 配置中心
-
-#### 配置中心数据结构
-
-```yaml
-namespace
-├──users # 权限配置
-├──props # 属性配置
-├──schemas # Schema 配置
-├ ├──${schema_1} # Schema 名称1
-├ ├ ├──datasource # 数据源配置
-├ ├ ├──rule # 规则配置
-├ ├ ├──table # 表结构配置
-├ ├──${schema_2} # Schema 名称2
-├ ├ ├──datasource # 数据源配置
-├ ├ ├──rule # 规则配置
-├ ├ ├──table # 表结构配置
-```
-
-### 注册中心
-
-#### 注册中心数据结构
-
-```yaml
-namespace
- ├──states
- ├ ├──proxynodes
- ├ ├ ├──${your_instance_ip_a}@${your_instance_pid_x}@${UUID}
- ├ ├ ├──${your_instance_ip_b}@${your_instance_pid_y}@${UUID}
- ├ ├ ├──....
- ├ ├──datanodes
- ├ ├ ├──${schema_1}
- ├ ├ ├ ├──${ds_0}
- ├ ├ ├ ├──${ds_1}
- ├ ├ ├──${schema_2}
- ├ ├ ├ ├──${ds_0}
- ├ ├ ├ ├──${ds_1}
- ├ ├ ├──....
-```
diff --git
a/docs/document/content/features/governance/management/change-history.en.md
b/docs/document/content/features/governance/management/change-history.en.md
deleted file mode 100644
index d31cf34..0000000
--- a/docs/document/content/features/governance/management/change-history.en.md
+++ /dev/null
@@ -1,46 +0,0 @@
-+++
-title = "Change History"
-weight = 3
-+++
-
-## 5.0.0-alpha
-
-### Config Center
-
-#### Structure in Configuration Center
-
-```yaml
-namespace
-├──users # Users configuration
-├──props # Properties configuration
-├──schemas # Schema configuration
-├ ├──${schema_1} # Schema name 1
-├ ├ ├──datasource # Datasource configuration
-├ ├ ├──rule # Rule configuration
-├ ├ ├──table # Table configuration
-├ ├──${schema_2} # Schema name 2
-├ ├ ├──datasource # Datasource configuration
-├ ├ ├──rule # Rule configuration
-├ ├ ├──table # Table configuration
-```
-
-### Registry Center
-
-#### Data Structure in Registry Center
-
-```yaml
-namespace
- ├──states
- ├ ├──proxynodes
- ├ ├ ├──${your_instance_ip_a}@${your_instance_pid_x}@${UUID}
- ├ ├ ├──${your_instance_ip_b}@${your_instance_pid_y}@${UUID}
- ├ ├ ├──....
- ├ ├──datanodes
- ├ ├ ├──${schema_1}
- ├ ├ ├ ├──${ds_0}
- ├ ├ ├ ├──${ds_1}
- ├ ├ ├──${schema_2}
- ├ ├ ├ ├──${ds_0}
- ├ ├ ├ ├──${ds_1}
- ├ ├ ├──....
-```
diff --git
a/docs/document/content/features/governance/management/dependency.cn.md
b/docs/document/content/features/governance/management/dependency.cn.md
deleted file mode 100644
index d02aa8f..0000000
--- a/docs/document/content/features/governance/management/dependency.cn.md
+++ /dev/null
@@ -1,13 +0,0 @@
-+++
-title = "第三方组件依赖"
-weight = 2
-+++
-
-Apache ShardingSphere 在数据库治理模块使用 SPI 方式载入数据到配置中心和注册中心，进行实例熔断和数据库禁用。
-目前，Apache ShardingSphere 内部支持 ZooKeeper，Etcd等常用的配置中心/注册中心。
-此外，开发者可以使用其他第三方组件，并通过 SPI 的方式注入到 Apache
ShardingSphere，从而使用该配置中心和注册中心，实现数据库治理功能。
-
-| | *实现驱动*
| *版本* | *配置中心* | *注册中心* |
-| --------------------------------------------- |
---------------------------------------------------- | ------ | ---------- |
--------- |
-| [Zookeeper](https://zookeeper.apache.org/) | [Apache
Curator](http://curator.apache.org/) | 3.6.x | 支持 | 支持 |
-| [Etcd](https://etcd.io/) |
[jetcd](https://github.com/etcd-io/jetcd) | v3 | 支持 | 支持
|
diff --git
a/docs/document/content/features/governance/management/dependency.en.md
b/docs/document/content/features/governance/management/dependency.en.md
deleted file mode 100644
index cdb4e0a..0000000
--- a/docs/document/content/features/governance/management/dependency.en.md
+++ /dev/null
@@ -1,13 +0,0 @@
-+++
-title = "Third-party Components"
-weight = 2
-+++
-
-Apache ShardingSphere uses SPI to load data to the config center and registry
center and disable instances and databases.
-Currently, Apache ShardingSphere supports frequently used registry centers,
Zookeeper, Etcd, Apollo and Nacos.
-In addition, by injecting them to ShardingSphere with SPI, users can use other
third-party config and registry centers to enable databases governance.
-
-| | *Driver*
| *Version* | *Config Center* | *Registry Center* |
-| --------------------------------------------- |
---------------------------------------------------- | --------- |
--------------- | ----------------- |
-| [Zookeeper](https://zookeeper.apache.org/) | [Apache
Curator](http://curator.apache.org/) | 3.6.x | Support |
Support |
-| [Etcd](https://etcd.io/) |
[jetcd](https://github.com/etcd-io/jetcd) | v3 | Support
| Support |
diff --git a/docs/document/content/features/management/_index.cn.md
b/docs/document/content/features/management/_index.cn.md
new file mode 100644
index 0000000..f1e53ca
--- /dev/null
+++ b/docs/document/content/features/management/_index.cn.md
@@ -0,0 +1,23 @@
++++
+pre = "<b>4.2. </b>"
+title = "管控"
+weight = 2
+chapter = true
++++
+
+## 背景
+
+随着数据规模的不断膨胀，使用多节点集群的分布式方式逐渐成为趋势。
+对集群整体视角的统一管理能力，和针对单独组件细粒度的控制能力，是基于存算分离的现代数据库体系中不可或缺的功能。
+
+## 挑战
+
+管控的挑战，在于对集群的集中化管理的统一管理能力以及在单点出现故障时精细化的操作能力。
+
+集中化管理的挑战体现在将包括数据库存储节点和中间件计算节点的状态统一管理，并且能够实时的探测到分布式环境下最新的变动情况，进一步为集群的控制和调度提供依据。
+
+面对超负荷的流量下，针对某一节点进行熔断和限流，以保证整个数据库集群得以继续运行，是分布式系统下对单一节点控制能力的挑战。
+
+## 目标
+
+实现从数据库到计算节点打通的一体化管理能力，在故障中为组件提供细粒度的控制能力，并尽可能的提供自愈的可能，是 Apache ShardingSphere
管控模块的主要设计目标。
diff --git a/docs/document/content/features/management/_index.en.md
b/docs/document/content/features/management/_index.en.md
new file mode 100644
index 0000000..ef6c835
--- /dev/null
+++ b/docs/document/content/features/management/_index.en.md
@@ -0,0 +1,24 @@
++++
+pre = "<b>4.2. </b>"
+title = "Management"
+weight = 2
+chapter = true
++++
+
+## Background
+
+As the scale of data continues to expand, a distributed database has become a
trend gradually.
+The unified management ability of cluster perspective, and control ability of
individual components are necessary ability in modern database system.
+
+## Challenges
+
+The challenge is ability which are unified management of centralized
management, and operation in case of single node in failure.
+
+Centralized management is to uniformly manage the state of database storage
nodes and middleware computing nodes,
+and can detect the latest updates in the distributed environment in real time,
further provide information with control and scheduling.
+
+In the overload traffic scenario, circuit breaker and request limiting for a
node to ensure whole database cluster can run continuously is a challenge to
control ability of a single node.
+
+## Goal
+
+The goal of Apache ShardingSphere management module is to realize the
integrated management ability from database to computing node, and provide
control ability for components in case of failure.
diff --git a/docs/document/content/features/management/concept.cn.md
b/docs/document/content/features/management/concept.cn.md
new file mode 100644
index 0000000..9f35f88
--- /dev/null
+++ b/docs/document/content/features/management/concept.cn.md
@@ -0,0 +1,13 @@
++++
+title = "核心概念"
+weight = 1
++++
+
+## 熔断
+
+阻断 Apache ShardingSphere 和数据库的连接。
+当某个 Apache ShardingSphere 节点超过负载后，停止该节点对数据库的访问，使数据库能够保证足够的资源为其他节点提供服务。
+
+## 限流
+
+面对超负荷的请求开启限流，以保护部分请求可以得以高质量的响应。
diff --git a/docs/document/content/features/management/concept.en.md
b/docs/document/content/features/management/concept.en.md
new file mode 100644
index 0000000..89af3a7
--- /dev/null
+++ b/docs/document/content/features/management/concept.en.md
@@ -0,0 +1,14 @@
++++
+title = "Core Concept"
+weight = 1
++++
+
+## Circuit Breaker
+
+Fuse connection between Apache ShardingSphere and the database.
+When an Apache ShardingSphere node exceeds the max load, stop the node's
access to the database,
+so that the database can ensure sufficient resources to provide services for
other Apache ShardingSphere nodes.
+
+## Request Limit
+
+In the face of overload requests, open request limiting to protect some
requests can still respond quickly.
diff --git a/docs/document/content/features/readwrite-splitting/_index.cn.md
b/docs/document/content/features/readwrite-splitting/_index.cn.md
index fd6645e..d78a92b 100644
--- a/docs/document/content/features/readwrite-splitting/_index.cn.md
+++ b/docs/document/content/features/readwrite-splitting/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>4.4. </b>"
+pre = "<b>4.5. </b>"
title = "读写分离"
-weight = 4
+weight = 5
chapter = true
+++
diff --git a/docs/document/content/features/readwrite-splitting/_index.en.md
b/docs/document/content/features/readwrite-splitting/_index.en.md
index d5d7c7b..bb50fa3 100644
--- a/docs/document/content/features/readwrite-splitting/_index.en.md
+++ b/docs/document/content/features/readwrite-splitting/_index.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>4.4. </b>"
+pre = "<b>4.5. </b>"
title = "Readwrite-splitting"
-weight = 4
+weight = 5
chapter = true
+++
diff --git a/docs/document/content/features/sharding/_index.cn.md
b/docs/document/content/features/sharding/_index.cn.md
index dba2e97..490dadf 100644
--- a/docs/document/content/features/sharding/_index.cn.md
+++ b/docs/document/content/features/sharding/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>4.2. </b>"
+pre = "<b>4.3. </b>"
title = "数据分片"
-weight = 2
+weight = 3
chapter = true
+++
diff --git a/docs/document/content/features/sharding/_index.en.md
b/docs/document/content/features/sharding/_index.en.md
index 4f2cd9c..46afbc0 100644
--- a/docs/document/content/features/sharding/_index.en.md
+++ b/docs/document/content/features/sharding/_index.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>4.2. </b>"
+pre = "<b>4.3. </b>"
title = "Sharding"
-weight = 2
+weight = 3
chapter = true
+++
diff --git a/docs/document/content/features/transaction/_index.cn.md
b/docs/document/content/features/transaction/_index.cn.md
index 3a27a06..4a39295 100644
--- a/docs/document/content/features/transaction/_index.cn.md
+++ b/docs/document/content/features/transaction/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>4.3. </b>"
+pre = "<b>4.4. </b>"
title = "分布式事务"
-weight = 3
+weight = 4
chapter = true
+++
diff --git a/docs/document/content/features/transaction/_index.en.md
b/docs/document/content/features/transaction/_index.en.md
index 050235b..e813c68 100644
--- a/docs/document/content/features/transaction/_index.en.md
+++ b/docs/document/content/features/transaction/_index.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>4.3. </b>"
+pre = "<b>4.4. </b>"
title = "Distributed Transaction"
-weight = 3
+weight = 4
chapter = true
+++
diff --git a/docs/document/content/reference/api-change-history/_index.cn.md
b/docs/document/content/reference/api-change-history/_index.cn.md
index 76ff5b4..a748a01 100644
--- a/docs/document/content/reference/api-change-history/_index.cn.md
+++ b/docs/document/content/reference/api-change-history/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.8. </b>"
+pre = "<b>7.9. </b>"
title = "API 变更历史"
-weight = 8
+weight = 9
chapter = true
+++
diff --git a/docs/document/content/reference/api-change-history/_index.en.md
b/docs/document/content/reference/api-change-history/_index.en.md
index dcbc0cc..fd962d0 100644
--- a/docs/document/content/reference/api-change-history/_index.en.md
+++ b/docs/document/content/reference/api-change-history/_index.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.8. </b>"
+pre = "<b>7.9. </b>"
title = "API Change Histories"
-weight = 8
+weight = 9
chapter = true
+++
diff --git a/docs/document/content/reference/encrypt/_index.cn.md
b/docs/document/content/reference/encrypt/_index.cn.md
index ddf75d8..fa52ae4 100644
--- a/docs/document/content/reference/encrypt/_index.cn.md
+++ b/docs/document/content/reference/encrypt/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.4. </b>"
+pre = "<b>7.5. </b>"
title = "数据加密"
-weight = 4
+weight = 5
+++
## 处理流程详解
diff --git a/docs/document/content/reference/encrypt/_index.en.md
b/docs/document/content/reference/encrypt/_index.en.md
index ed823b7..86a3cb4 100644
--- a/docs/document/content/reference/encrypt/_index.en.md
+++ b/docs/document/content/reference/encrypt/_index.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.4. </b>"
+pre = "<b>7.5. </b>"
title = "Encryption"
-weight = 4
+weight = 5
+++
## Process Details
diff --git a/docs/document/content/reference/faq/_index.cn.md
b/docs/document/content/reference/faq/_index.cn.md
index 620f46c..254c847 100644
--- a/docs/document/content/reference/faq/_index.cn.md
+++ b/docs/document/content/reference/faq/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.7. </b>"
+pre = "<b>7.8. </b>"
title = "FAQ"
-weight = 7
+weight = 8
chapter = true
+++
diff --git a/docs/document/content/reference/faq/_index.en.md
b/docs/document/content/reference/faq/_index.en.md
index 304bd57..6723707 100644
--- a/docs/document/content/reference/faq/_index.en.md
+++ b/docs/document/content/reference/faq/_index.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.7. </b>"
+pre = "<b>7.8. </b>"
title = "FAQ"
-weight = 7
+weight = 8
chapter = true
+++
diff --git
a/docs/document/content/features/governance/management/registry-center.cn.md
b/docs/document/content/reference/management/_index.cn.md
similarity index 74%
rename from
docs/document/content/features/governance/management/registry-center.cn.md
rename to docs/document/content/reference/management/_index.cn.md
index 48d75aa..0d44e48 100644
--- a/docs/document/content/features/governance/management/registry-center.cn.md
+++ b/docs/document/content/reference/management/_index.cn.md
@@ -1,18 +1,9 @@
+++
-title = "注册中心"
+pre = "<b>7.1. </b>"
+title = "管控"
weight = 1
+++
-## 实现动机
-
-- 配置集中化：越来越多的运行时实例，使得散落的配置难于管理，配置不同步导致的问题十分严重。将配置集中于配置中心，可以更加有效进行管理。
-
-- 配置动态化：配置修改后的分发，是配置中心可以提供的另一个重要能力。它可支持数据源和规则的动态切换。
-
-- 存放运行时的动态/临时状态数据，比如可用的 ShardingSphere 的实例，需要禁用或熔断的数据源等。
-
-- 提供熔断数据库访问程序对数据库的访问和禁用从库的访问的编排治理能力。治理模块仍然有大量未完成的功能（比如流控等）。
-
## 注册中心数据结构
在定义的命名空间下，`rules` 、`props` 和 `metadata` 节点以 YAML
格式存储配置，可通过修改节点来实现对于配置的动态管理。`status` 存储数据库访问对象运行节点，用于区分不同数据库访问实例。
@@ -153,35 +144,10 @@ tables: # 表
### /status/compute_nodes
数据库访问对象运行实例信息，子节点是当前运行实例的标识。
-运行实例标识由运行服务器的 IP 地址和 PORT 构成。运行实例标识均为临时节点，当实例上线时注册，下线时自动清理。
+运行实例标识由运行服务器的 IP 地址和 PORT 构成。
+运行实例标识均为临时节点，当实例上线时注册，下线时自动清理。
注册中心监控这些节点的变化来治理运行中实例对数据库的访问等。
### /status/storage_nodes
可以治理读写分离从库，可动态添加删除以及禁用。
-
-## 动态生效
-
-在注册中心上修改、删除、新增相关配置，会动态推送到生产环境并立即生效。
-
-## 操作指南
-
-### 熔断实例
-
-可在 `IP地址@PORT` 节点写入 `DISABLED`（忽略大小写）表示禁用该实例，删除 `DISABLED` 表示启用。
-
-Zookeeper 命令如下：
-
-```
-[zk: localhost:2181(CONNECTED) 0] set
/${your_zk_namespace}/status/compute_nodes/circuit_breaker/${your_instance_ip_a}@${your_instance_port_x}
DISABLED
-```
-
-### 禁用从库
-
-在读写分离场景下，可在数据源名称子节点中写入 `DISABLED`（忽略大小写）表示禁用从库数据源，删除 `DISABLED` 或节点表示启用。
-
-Zookeeper 命令如下：
-
-```
-[zk: localhost:2181(CONNECTED) 0] set
/${your_zk_namespace}/status/storage_nodes/disable/${your_schema_name.your_replica_datasource_name}
DISABLED
-```
diff --git
a/docs/document/content/features/governance/management/registry-center.en.md
b/docs/document/content/reference/management/_index.en.md
similarity index 74%
rename from
docs/document/content/features/governance/management/registry-center.en.md
rename to docs/document/content/reference/management/_index.en.md
index 8146b8a..c32297a 100644
--- a/docs/document/content/features/governance/management/registry-center.en.md
+++ b/docs/document/content/reference/management/_index.en.md
@@ -1,18 +1,9 @@
+++
-title = "Registry Center"
+pre = "<b>7.1. </b>"
+title = "Management"
weight = 1
+++
-## Motivation
-
-- Centralized configuration: more and more running examples have made it hard
to manage separate configurations and asynchronized configurations can cause
serious problems. Concentrating them in the configuration center can make the
management more effective.
-
-- Dynamic configuration: distribution after configuration modification is
another important capability of configuration center. It can support dynamic
switch between data sources and rule configurations.
-
-- Hold all ephemeral status data dynamically generated in runtime(such as
available proxy instances, disabled datasource instances etc).
-
-- Disable the access to replica database and the access of application.
Governance still has many functions(such as flow control) to be developed.
-
## Data Structure in Registry Center
Under defined namespace, `rules`, `props` and `metadata` nodes persist in
YAML, modifying nodes can dynamically refresh configurations. `status` node
persist the runtime node of database access object, to distinguish different
database access instances.
@@ -157,29 +148,3 @@ It includes running instance information of database
access object, with sub-nod
### /status/storage_nodes
It is able to orchestrate replica database, delete or disable data dynamically.
-
-## Dynamic Effectiveness
-
-Modification, deletion and insertion of relevant configurations in the config
center will immediately take effect in the producing environment.
-
-## Operation Guide
-
-### Circuit Breaker
-
-Write `DISABLED` (case insensitive) to `IP@PORT` to disable that instance;
delete `DISABLED` to enable the instance.
-
-Zookeeper command is as follows:
-
-```
-[zk: localhost:2181(CONNECTED) 0] set
/${your_zk_namespace}/status/compute_nodes/circuit_breaker/${your_instance_ip_a}@${your_instance_port_x}
DISABLED
-```
-
-### Disable Replica Database
-
-Under readwrite-splitting scenarios, users can write `DISABLED` (case
insensitive) to sub-nodes of data source name to disable replica database
sources. Delete `DISABLED` or the node to enable it.
-
-Zookeeper command is as follows:
-
-```
-[zk: localhost:2181(CONNECTED) 0] set
/${your_zk_namespace}/status/storage_nodes/disable/${your_schema_name.your_replica_datasource_name}
DISABLED
-```
diff --git a/docs/document/content/reference/scaling/_index.cn.md
b/docs/document/content/reference/scaling/_index.cn.md
index 466b980..33ea225 100644
--- a/docs/document/content/reference/scaling/_index.cn.md
+++ b/docs/document/content/reference/scaling/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.3. </b>"
+pre = "<b>7.4. </b>"
title = "弹性伸缩"
-weight = 3
+weight = 4
+++
## 原理说明
diff --git a/docs/document/content/reference/scaling/_index.en.md
b/docs/document/content/reference/scaling/_index.en.md
index e15c24e..ecb8400 100644
--- a/docs/document/content/reference/scaling/_index.en.md
+++ b/docs/document/content/reference/scaling/_index.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.3. </b>"
+pre = "<b>7.4. </b>"
title = "Scaling"
-weight = 3
+weight = 4
+++
## Principle Description
@@ -57,4 +57,4 @@ These captured incremental data, Apache ShardingSphere also
write to the new clu
In this phase, there may be a temporary read only time, make the data in old
data nodes static so that the incremental phase complete fully.
The read only time is range seconds to minutes, it depends on the amount of
data and the checking data.
-After finished, Apache ShardingSphere can switch the configuration by
register-center and config-center, make application use new sharding rule and
new data nodes.
\ No newline at end of file
+After finished, Apache ShardingSphere can switch the configuration by
register-center and config-center, make application use new sharding rule and
new data nodes.
diff --git a/docs/document/content/reference/shadow/_index.cn.md
b/docs/document/content/reference/shadow/_index.cn.md
index 9574a53..ae2c4c0 100644
--- a/docs/document/content/reference/shadow/_index.cn.md
+++ b/docs/document/content/reference/shadow/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.5. </b>"
+pre = "<b>7.6. </b>"
title = "影子库"
-weight = 5
+weight = 6
+++
## 整体架构
diff --git a/docs/document/content/reference/shadow/_index.en.md
b/docs/document/content/reference/shadow/_index.en.md
index 852230f..3323689 100644
--- a/docs/document/content/reference/shadow/_index.en.md
+++ b/docs/document/content/reference/shadow/_index.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.5. </b>"
+pre = "<b>7.6. </b>"
title = "Shadow"
-weight = 5
+weight = 6
+++
## Overall Architecture
diff --git a/docs/document/content/reference/sharding/_index.cn.md
b/docs/document/content/reference/sharding/_index.cn.md
index 9505cd0..abeecb4 100644
--- a/docs/document/content/reference/sharding/_index.cn.md
+++ b/docs/document/content/reference/sharding/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.1. </b>"
+pre = "<b>7.2. </b>"
title = "数据分片"
-weight = 1
+weight = 2
chapter = true
+++
diff --git a/docs/document/content/reference/sharding/_index.en.md
b/docs/document/content/reference/sharding/_index.en.md
index 15540b1..ce1a658 100644
--- a/docs/document/content/reference/sharding/_index.en.md
+++ b/docs/document/content/reference/sharding/_index.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.1. </b>"
+pre = "<b>7.2. </b>"
title = "Sharding"
-weight = 1
+weight = 2
chapter = true
+++
diff --git a/docs/document/content/reference/test/_index.cn.md
b/docs/document/content/reference/test/_index.cn.md
index 242b1bf..6fbac8d 100644
--- a/docs/document/content/reference/test/_index.cn.md
+++ b/docs/document/content/reference/test/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.6. </b>"
+pre = "<b>7.7. </b>"
title = "测试"
-weight = 6
+weight = 7
chapter = true
+++
diff --git a/docs/document/content/reference/transaction/_index.cn.md
b/docs/document/content/reference/transaction/_index.cn.md
index a4aa9f6..e737c21 100644
--- a/docs/document/content/reference/transaction/_index.cn.md
+++ b/docs/document/content/reference/transaction/_index.cn.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.2. </b>"
+pre = "<b>7.3. </b>"
title = "分布式事务"
-weight = 2
+weight = 3
chapter = true
+++
diff --git a/docs/document/content/reference/transaction/_index.en.md
b/docs/document/content/reference/transaction/_index.en.md
index a4e2e07..5cebc9f 100644
--- a/docs/document/content/reference/transaction/_index.en.md
+++ b/docs/document/content/reference/transaction/_index.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>7.2. </b>"
+pre = "<b>7.3. </b>"
title = "Transaction"
-weight = 2
+weight = 3
chapter = true
+++
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/usage/management/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/usage/management/_index.cn.md
new file mode 100644
index 0000000..b4a6c31
--- /dev/null
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/usage/management/_index.cn.md
@@ -0,0 +1,35 @@
++++
+title = "管控"
+weight = 4
++++
+
+## 熔断实例
+
+可在 `IP地址@PORT` 节点写入 `DISABLED`（忽略大小写）表示禁用该实例，删除 `DISABLED` 表示启用。
+
+Zookeeper 命令如下：
+
+```
+[zk: localhost:2181(CONNECTED) 0] set
/${your_zk_namespace}/status/compute_nodes/circuit_breaker/${your_instance_ip_a}@${your_instance_port_x}
DISABLED
+```
+
+## 禁用从库
+
+在读写分离场景下，可在数据源名称子节点中写入 `DISABLED`（忽略大小写）表示禁用从库数据源，删除 `DISABLED` 或节点表示启用。
+
+Zookeeper 命令如下：
+
+```
+[zk: localhost:2181(CONNECTED) 0] set
/${your_zk_namespace}/status/storage_nodes/disable/${your_schema_name.your_replica_datasource_name}
DISABLED
+```
+
+## 第三方组件依赖
+
+Apache ShardingSphere 在数据库治理模块使用 SPI 方式载入数据到配置中心和注册中心，进行实例熔断和数据库禁用。
+目前，Apache ShardingSphere 内部支持 ZooKeeper，Etcd 等常用的配置中心/注册中心。
+此外，开发者可以使用其他第三方组件，并通过 SPI 的方式注入到 Apache
ShardingSphere，从而使用该配置中心和注册中心，实现数据库治理功能。
+
+| | *实现驱动*
| *版本* |
+| ------------------------------------------ |
-------------------------------------------- | ------ |
+| [Zookeeper](https://zookeeper.apache.org/) | [Apache
Curator](http://curator.apache.org/) | 3.6.x |
+| [Etcd](https://etcd.io/) |
[jetcd](https://github.com/etcd-io/jetcd) | v3 |
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/usage/management/_index.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/usage/management/_index.en.md
new file mode 100644
index 0000000..a8736d3
--- /dev/null
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/usage/management/_index.en.md
@@ -0,0 +1,35 @@
++++
+title = "Management"
+weight = 4
++++
+
+## Circuit Breaker
+
+Write `DISABLED` (case insensitive) to `IP@PORT` to disable that instance;
delete `DISABLED` to enable the instance.
+
+Zookeeper command is as follows:
+
+```
+[zk: localhost:2181(CONNECTED) 0] set
/${your_zk_namespace}/status/compute_nodes/circuit_breaker/${your_instance_ip_a}@${your_instance_port_x}
DISABLED
+```
+
+## Disable Replica Database
+
+Under readwrite-splitting scenarios, users can write `DISABLED` (case
insensitive) to sub-nodes of data source name to disable replica database
sources. Delete `DISABLED` or the node to enable it.
+
+Zookeeper command is as follows:
+
+```
+[zk: localhost:2181(CONNECTED) 0] set
/${your_zk_namespace}/status/storage_nodes/disable/${your_schema_name.your_replica_datasource_name}
DISABLED
+```
+
+## Third-party Components
+
+Apache ShardingSphere uses SPI to load data to the config center and registry
center and disable instances and databases.
+Currently, Apache ShardingSphere supports frequently used registry centers,
Zookeeper and Etcd.
+In addition, by injecting them to ShardingSphere with SPI, users can use other
third-party config and registry centers to enable databases governance.
+
+| | *Driver*
| *Version* |
+| ------------------------------------------ |
-------------------------------------------- | --------- |
+| [Zookeeper](https://zookeeper.apache.org/) | [Apache
Curator](http://curator.apache.org/) | 3.6.x |
+| [Etcd](https://etcd.io/) |
[jetcd](https://github.com/etcd-io/jetcd) | v3 |
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/usage/observability/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/usage/observability/_index.cn.md
index 5f993e0..0a57aa8 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/usage/observability/_index.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/usage/observability/_index.cn.md
@@ -1,6 +1,6 @@
+++
title = "可观察性"
-weight = 4
+weight = 5
chapter = true
+++
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/usage/observability/_index.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/usage/observability/_index.en.md
index 01dd7c4..866744f 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/usage/observability/_index.en.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/usage/observability/_index.en.md
@@ -1,6 +1,6 @@
+++
title = "Observability"
-weight = 4
+weight = 5
chapter = true
+++
