You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2021/06/09 00:15:53 UTC

[shardingsphere] branch master updated: Update documents for Proxy authentication (#10722)

This is an automated email from the ASF dual-hosted git repository.

zhangliang 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 014c5a5  Update documents for Proxy authentication (#10722)
014c5a5 is described below

commit 014c5a5c134c848c3ab805ae4afdda50b5bb903e
Author: 吴伟杰 <wu...@apache.org>
AuthorDate: Wed Jun 9 08:15:30 2021 +0800

    Update documents for Proxy authentication (#10722)
    
    * Update documents for Proxy authentication
    
    * Update proxy documents in dev manual
---
 docs/document/content/dev-manual/proxy.cn.md                      | 8 ++++----
 docs/document/content/dev-manual/proxy.en.md                      | 8 ++++----
 .../shardingsphere-proxy/configuration/authentication.cn.md       | 4 ++++
 .../shardingsphere-proxy/configuration/authentication.en.md       | 4 ++++
 4 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/docs/document/content/dev-manual/proxy.cn.md b/docs/document/content/dev-manual/proxy.cn.md
index 6e2d012..73b6d79 100644
--- a/docs/document/content/dev-manual/proxy.cn.md
+++ b/docs/document/content/dev-manual/proxy.cn.md
@@ -36,7 +36,7 @@ chapter = true
 | ------------------------------- | ---------------------------- |
 | AuthorityProvideAlgorithm       | 用户权限加载逻辑                |
 
-| *已知实现类*                                         | *详细说明*                |
-| -------------------------------------------------- | ------------------------ |
-| NativeAuthorityProviderAlgorithm                   | 基于后端数据库存取权限信息    |
-| AllPrivilegesPermittedAuthorityProviderAlgorithm   | 默认授予所有权限(不鉴权)    |
+| *已知实现类*                                         | *Type*                   | *详细说明*                                                                           |
+| -------------------------------------------------- | ------------------------ | ----------------------------------------------------------------------------------- |
+| NativeAuthorityProviderAlgorithm                   | NATIVE                   | 基于后端数据库存取 server.yaml 中配置的权限信息。如果用户不存在,则自动创建用户并默认赋予最高权限。 |
+| AllPrivilegesPermittedAuthorityProviderAlgorithm   | ALL_PRIVILEGES_PERMITTED | 默认授予所有权限(不鉴权),不会与实际数据库数据库交互。                                      |
diff --git a/docs/document/content/dev-manual/proxy.en.md b/docs/document/content/dev-manual/proxy.en.md
index ed80368..a1efccc 100644
--- a/docs/document/content/dev-manual/proxy.en.md
+++ b/docs/document/content/dev-manual/proxy.en.md
@@ -36,7 +36,7 @@ chapter = true
 | ------------------------------- | ------------------------------ |
 | AuthorityProvideAlgorithm       | User authority loading logic   |
 
-| *Implementation Class*                             | *Description*                                                  |
-| -------------------------------------------------- | -------------------------------------------------------------- |
-| NativeAuthorityProviderAlgorithm                   | Persist user authority into the backend database               |
-| AllPrivilegesPermittedAuthorityProviderAlgorithm   | All privileges granted to user by default (No authentication)  |
+| *Implementation Class*                             | *Type*                   | *Description*                                                                                                          |
+| -------------------------------------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
+| NativeAuthorityProviderAlgorithm                   | NATIVE                   | Persist user authority defined in server.yaml into the backend database. An admin user will be created if not existed. |
+| AllPrivilegesPermittedAuthorityProviderAlgorithm   | ALL_PRIVILEGES_PERMITTED | All privileges granted to user by default (No authentication). Will not interact with the actual database.             |
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.cn.md
index b64afb7..3540113 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.cn.md
@@ -15,3 +15,7 @@ rules:
     provider:
       type: NATIVE
 ```
+
+hostname 为 `%` 或空字符串,则代表不限制 host。
+
+provider 的 type 必须显式指定,具体实现可以参考 [5.11 Proxy](/document/current/cn/dev-manual/proxy)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.en.md b/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.en.md
index 73f474a..52aa941 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.en.md
@@ -14,3 +14,7 @@ rules:
     provider:
       type: NATIVE
 ```
+
+If the hostname is `%` or empty, it means no restrict to the user's host.
+
+The type of the provider must be explicitly specified. Refer to [5.11 Proxy](/document/current/en/dev-manual/proxy) for more implementations.