docs: role and privilege (#215)

* docs: role and privilege
Co-authored-by: YinBo <[email protected]>

Author: Ke-Wng

dir.yaml

@@ -104,7 +104,7 @@
       collapsed: true
       children:
         - title_en: Index Cache
-          title_cn: 索引缓存
+          title_cn: 索引缓存调优
           path: development-guide/query-optimization/index-cache-optimization
         - title_en: Data Cache
           title_cn: 热点数据缓存
@@ -274,8 +274,8 @@
         - title_en: Gap Fill
           title_cn: 插值函数
           path: sql-reference/gap_fill
-        - title_en: Json
-          title_cn: Json 函数
+        - title_en: JSON
+          title_cn: JSON 函数
           path: sql-reference/json
         - title_en: Cast
           title_cn: 类型转换函数
@@ -446,6 +446,37 @@
     - title_en: TLS
       title_cn: 连接加密(TLS)
       path: user-security/tls
+    - title_en: Authentication and Authorization
+      title_cn: 认证与权限
+      collapsed: true
+      children:
+      - title_en: Authentication
+        title_cn: 连接认证
+        path: user-security/authentication/overview
+        collapsed: true
+        children:
+        - title_en: Overview
+          title_cn: 静态认证
+          path: user-security/authentication/static
+        - title_en: RBAC 
+          title_cn: 基于角色的访问控制
+          path: user-security/authentication/rbac
+      - title_en: Authorization
+        title_cn: 访问控制 
+        collapsed: true
+        children:
+        - title_en: Overview
+          title_cn: 概述
+          path: user-security/rbac/overview
+        - title_en: User Management 
+          title_cn: 用户管理
+          path: user-security/rbac/user
+        - title_en: Role Management
+          title_cn: 角色管理
+          path: user-security/rbac/role
+        - title_en: Privileges
+          title_cn: 权限管理
+          path: user-security/rbac/privilege
 - title_en: Release Notes
   title_cn: 版本发布说明
   collapsed: true

en_US/user-security/authentication/overview.md

@@ -1,26 +1,28 @@
 # 数据备份与恢复
+
+## 概述
 数据库备份和恢复的目的是为了保护数据安全，防止数据丢失或损坏。通过定期备份，能够在系统故障、硬件损坏或人为错误时，将数据库恢复到最近的可用状态，确保业务连续性和数据完整性。本章节主要介绍数据备份与恢复功能。
 
 ## 工具使用说明
 `dldump` 工具提供了丰富的选项以供配置，您可以通过执行 `dldump --help` 以查看 `dldump` 的所有子命令和选项。此处对一些重要的选项进行说明：
 
-| 参数                | 简写     | 描述                                                                                                                         |
-| ----------         | -------  | --------------------------------------------------------------------------------------------------------------------------  |
-| --host             | -h       | 指定 Datalayers 实例的地址，默认为：127.0.0.1                                                                                   |
-| --port             | -P       | 指定 Datalayers 实例的 SQL 服务端口，默认为：8360                                                                                |
-| --username         | -u       | 指定用于鉴权的用户名，默认为：admin                                                                                               |
-| --password         | -p       | 指定用于鉴权的密码，默认为：public                                                                                               |
-| --output           | -o       | 指定备份时数据的存储路径。为了避免用户无意间覆盖之前的备份，要求导出时指定的目录为空                                                       |
-| --input            | -i       | 指定恢复时数据的加载路径。如果指定的目录为空，则会中止恢复操作                                                                         |
-| --meta             |          | 指定备份时是否要包含元信息（如：建库和建表语句），默认包含元信息。如果不备份元信息，您可以传入 --meta false                                   |
-| --data             |          | 指定备份时是否要包含表数据，默认包含表数据。如果要求不备份表数据，您可以传入 --data false                                                 |
-| --database         | -d       | 指定备份或恢复的数据库。如果不显式设定该选项，则默认转储所有数据库                                                                       |
-| --table            | -t       | 指定备份或恢复的表。如果指定了 table，则必须指定 database。如果不显式设定该选项，则默认备份 database 下所有表                               |
-| --max-file-size    | -s       | 指定一个数据文件大小的最大值，默认为 8GiB。只支持整型作为合法的输入。单位为：GiB                                                         |
-| --start            |          | 指定一个时间戳，时间戳大于或等于 start 的表数据才会被备份。合法的日期格式和整型均认为是合法的时间戳                                         |
-| --end              |          | 指定一个时间戳，时间戳小于或等于 end 的表数据才会被备份。合法的日期格式和整型均认为是合法的时间戳                                           |
-| --tls              |          | 通过 TLS 加密方式与数据库进行交互。自签证书则需指定 root ca，如：--tls /etc/datalayers/datalayers.crt                                |
-| --help             |          | show this help, then exit                                                                                                    |
+| 参数                | <div style="width:40px">简写</div>     | 描述                                                                                                                         |
+| ----------         | -------                                | --------------------------------------------------------------------------------------------------------------------------  |
+| --host             | -h                                     | 指定 Datalayers 实例的地址，默认为：127.0.0.1                                                                                   |
+| --port             | -P                                     | 指定 Datalayers 实例的 SQL 服务端口，默认为：8360                                                                                |
+| --username         | -u                                     | 指定用于鉴权的用户名，默认为：admin                                                                                               |
+| --password         | -p                                     | 指定用于鉴权的密码，默认为：public                                                                                               |
+| --output           | -o                                     | 指定备份时数据的存储路径。为了避免用户无意间覆盖之前的备份，要求导出时指定的目录为空                                                       |
+| --input            | -i                                     | 指定恢复时数据的加载路径。如果指定的目录为空，则会中止恢复操作                                                                         |
+| --meta             |                                        | 指定备份时是否要包含元信息（如：建库和建表语句），默认包含元信息。如果不备份元信息，您可以传入 --meta false                                   |
+| --data             |                                        | 指定备份时是否要包含表数据，默认包含表数据。如果要求不备份表数据，您可以传入 --data false                                                 |
+| --database         | -d                                     | 指定备份或恢复的数据库。如果不显式设定该选项，则默认转储所有数据库                                                                       |
+| --table            | -t                                     | 指定备份或恢复的表。如果指定了 table，则必须指定 database。如果不显式设定该选项，则默认备份 database 下所有表                               |
+| --max-file-size    | -s                                     | 指定一个数据文件大小的最大值，默认为 8GiB。只支持整型作为合法的输入。单位为：GiB                                                         |
+| --start            |                                        | 指定一个时间戳，时间戳大于或等于 start 的表数据才会被备份。合法的日期格式和整型均认为是合法的时间戳                                         |
+| --end              |                                        | 指定一个时间戳，时间戳小于或等于 end 的表数据才会被备份。合法的日期格式和整型均认为是合法的时间戳                                           |
+| --tls              |                                        | 通过 TLS 加密方式与数据库进行交互。自签证书则需指定 root ca，如：--tls /etc/datalayers/datalayers.crt                                |
+| --help             |                                        | show this help, then exit                                                                                                    |
 
 ## 备份与恢复
 以下通过一个示例来介绍 **dldump** 工具的使用。这个示例首先为单机版 Datalayers 写入一些数据，然后使用 **dldump** 将数据导出到备份目录；再创建一个新的 Datalayers 实例，从备份目录加载数据并写入到新的 Datalayers 实例；最后使用 **dlsql** 工具查询新的 Datalayers 实例，以验证成功执行了备份与恢复。

en_US/user-security/authentication/rbac.md

@@ -25,10 +25,10 @@ addr = "0.0.0.0:8360"
 # Default: "0.0.0.0:8361".
 http = "0.0.0.0:8361"
 
-# 配置 Key-Value 服务的监听地址.
-# Key-Value 服务仅在集群模式下才能工作.
-# 默认情况下不启动 Key-Value 服务.
-# redis = "0.0.0.0:8362"
+# The unix socket file of peer server.
+# Don't support peer server by default.
+# Default: ""
+# peer_addr = "run/datalayers.sock"
 
 # 配置 session 超时时间.
 # Default: "10s".
@@ -47,6 +47,11 @@ timezone = "Asia/Shanghai"
 
 # The configurations of authorization.
 [server.auth]
+# The type of the authorization.
+# type = "static" or "rbac"
+# Default: "static"
+type = "static"
+
 # The username.
 # Default: "admin".
 username = "admin"
@@ -58,4 +63,38 @@ password = "public"
 # The provided JSON Web Token.
 # Default: "87113c3d906df75e9c6389fbd457d957".
 jwt_secret = "87212c3d906df71e9c6289fbd456d917"
+
+# Password strength requirements.
+# weak: no requirements, simple password.
+# moderate: at least 8 characters, including at least three types of the following:
+#   uppercase letters, lowercase letters, digits, and special characters.
+# strong: at least 14 characters, including all types of the following:
+#   uppercase letters, lowercase letters, digits, and special characters.
+# Default: "weak"
+#password_strength = "weak"
+
+# Password protection against brute-force attacks.
+# Form as "a/b/c", means:
+# Account locked for "b" minutes after "a" failed password attempts,
+#  and locked for another "c" miniutes after the each failed attempt.
+# The maximum of a/b/c is 10/120/120 respectively, and will be set to 3/5/5 if too big.
+# 0/-/- means no lockout.
+# Default: "0/0/0"
+#password_lockout = "3/5/5"
+
+# The configurations of the Redis service.
+[server.redis]
+# 配置 Key-Value 服务的监听地址.
+# Key-Value 服务仅在集群模式下才能工作.
+# 默认情况下不启动 Key-Value 服务.
+# Default: "".
+# addr = "0.0.0.0:8362"
+
+# The username.
+# Default: "admin".
+#username = "admin"
+
+# The password.
+# Default: "public".
+#password = "public"
 ```