Merge pull request #856 from chris-sun-star/2.3.3-doc

2.3.3 doc

Author: cheer-chen

docsite/docs/manual/500.ob-operator-user-guide/200.tenant-management-of-ob-operator/100.create-tenant.md

@@ -46,6 +46,9 @@ spec:
   credentials: # optional
     root: t1-ro # optional, empty root password if not given
     standbyRo: t1-ro # optional, generate automatically if not given
+  variables:
+    - name: "lower_case_table_names"
+      value: "1"
   pools:
     - zone: zone1
       type:
@@ -103,6 +106,7 @@ The following table describes the parameters.
 | connectWhiteList | Optional. The IP addresses of the clients that are allowed to connect to the tenant. `%` indicates that all client IP addresses are allowed to connect to the tenant. The default value is `%`. When you modify this parameter, the value must include the CIDR block of ob-operator; otherwise, ob-operator cannot connect to the tenant.  |
 | forceDelete | Optional. Specifies whether to forcibly delete the tenant. The default value is `false`.  |
 | credentials | Optional. The secret resources referenced for creating the user and changing the password when you create the tenant. You can specify the passwords of the root account and the standbyro account. If you do not specify this parameter, the password is not changed.  |
+| variables | Optional. A list of tenant-level variables to set. Each item in the list should have a `name` and a `value`. (supported from version 2.3.3) |
 | pools | The topology of the tenant, which defines the replica and resource distribution of the tenant in each zone.  |
 | type.name | Required. The type of replicas in the zone. The valid values are `full` and `readonly`. This parameter is case insensitive.  |
 | type.replica | Optional. The number of replicas in the zone. This parameter is set to `1` by default.  |
@@ -147,6 +151,9 @@ Spec:
   Credentials:
     Root:        t1-ro
     Standby Ro:  t1-ro
+  variables:
+    - name: "lower_case_table_names"
+      value: "1"
   Force Delete:  true
   Obcluster:     obcluster
   Pools:

docsite/docs/manual/500.ob-operator-user-guide/300.high-availability/400.tenant-backup-of-ob-operator.md

@@ -78,9 +78,14 @@ The parameters are described as follows:
 
 destination:
 
-* type: the type of the destination. Valid values are `NFS` and `OSS`.
-* path: the path of the backup destination. If you use an OSS backup destination, the path must start with `oss://`. If you use an NFS backup destination, you must specify a relative path, which must not start with `/`.
-* ossAccessSecret: the name of the secret resource that stores the OSS access credential. If you use an OSS backup destination, you must specify this parameter.
+* type: The type of the destination. Valid values are `NFS`, `OSS`, `S3`, `COS`, and `S3_COMPATIBLE`.                                                                                                                                   │
+* path: The path of the backup destination.                                                                                                                                                                                             │
+  * For `NFS`, you must specify a relative path, which must not start with `/`.                                                                                                                                                         │
+  * For `OSS`, the path must start with `oss://` and include the `host` parameter. Example: `oss://bucket/backup?host=oss-cn-hangzhou.aliyuncs.com`                                                                                     │
+  * For `S3`, the path must start with `s3://` and include the `host` parameter. Example: `s3://bucket/backup?host=s3.us-west-1.amazonaws.com`                                                                                          │
+  * For `COS`, the path must start with `cos://` and include the `host` parameter. Example: `cos://bucket/backup?host=cos.ap-nanjing.myqcloud.com`                                                                                      │
+  * For `S3_COMPATIBLE`, the path must start with `s3://` and include the `host` parameter for the S3-compatible endpoint. Example: `s3://bucket/backup?host=minio.example.com`                                                         │
+* ossAccessSecret: The name of the secret resource that stores the access credential. This is required for `OSS`, `S3`, `COS`, and `S3_COMPATIBLE`.
 
 Here is the configuration of a sample tenantSecret resource:
 
@@ -120,6 +125,9 @@ data:
   # base64 encoded
   accessId: ******
   accessKey: ******
+  appId: ******             # this config is for COS
+  s3Region: ******          # this config is for S3
+  addressingModel: ******   # this config is for S3_COMPATIBLE, (supported from version 2.3.3)
 ```
 
 ## Common operations

docsite/i18n/zh-Hans/docusaurus-plugin-content-docs/current/manual/500.ob-operator-user-guide/200.tenant-management-of-ob-operator/100.create-tenant.md

@@ -46,6 +46,9 @@ spec:
   credentials: # 可选
     root: t1-ro # 可选，如不传则 root 用户密码为空
     standbyRo: t1-ro # 可选，如不传则自动创建
+  variables:
+    - name: "lower_case_table_names"
+      value: "1"
   pools:
     - zone: zone1
       type: 
@@ -103,6 +106,7 @@ spec:
 | connectWhiteList | 指定允许连接该租户的客户端 IP，`%` 表示任何客户端 IP 都可以连接该租户；非必填，默认设置为 `%`。如果用户需要修改改配置，则需要将 ob-operator 所处的网段包含在配置内，否则 ob-operator 会连接不上该租户。 |
 | forceDelete | 删除时是否强制删除，非必填，默认为 false。 |
 | credentials | 创建租户时创建用户和修改密码的 Secret 资源引用。目前支持配置 root 账号和 standbyRo 两个用户的密码，非必填，不填则不修改密码。 |
+| variables | 可选。要设置的租户级变量列表。列表中的每个项目都应包含 `name` 和 `value`。 (从 2.3.3 版本开始支持) |
 | pools | 租户的拓扑结构，用于定义租户在每个 zone 上的副本、资源分布等情况。 |
 | type.name | 指定租户在该 zone 的副本类型，支持 full 和 readonly, 需要写出完整类型, 大小写不敏感；必填。|
 | type.replica | 指定租户在该 zone 的副本数；非必填，默认为 1。 |
@@ -144,6 +148,9 @@ Metadata:
 Spec:
   Charset:             utf8mb4
   Connect White List:  %
+  variables:
+    - name: "lower_case_table_names"
+      value: "1"
   Credentials:
     Root:        t1-ro
     Standby Ro:  t1-ro

docsite/i18n/zh-Hans/docusaurus-plugin-content-docs/current/manual/500.ob-operator-user-guide/300.high-availability/400.tenant-backup-of-ob-operator.md

@@ -78,9 +78,14 @@ spec:
 
 destination：
 
-* type：目的地类型，支持 NFS 和 OSS 两种。
-* path：目的地的备份路径，如果是 OSS 类型，则需要以 `oss://` 开头；如果是 NFS 类型，则是非 `/` 开头的相对路径。
-* ossAccessSecret： 存放访问 OSS 凭证的 Secret 资源名，如果备份目的地类型为 OSS，该字段必须提供。
+* type：目的地类型，支持 `NFS`、`OSS`、`S3`、`COS` 和 `S3_COMPATIBLE`。                                                                                                                                                                │
+* path：目的地的备份路径。                                                                                                                                                                                                             │
+  * `NFS` 类型：非 `/` 开头的相对路径。                                                                                                                                                                                                │
+  * `OSS` 类型：以 `oss://` 开头，并包含 `host` 参数。示例：`oss://bucket/backup?host=oss-cn-hangzhou.aliyuncs.com`                                                                                                                    │
+  * `S3` 类型：以 `s3://` 开头，并包含 `host` 参数。示例：`s3://bucket/backup?host=s3.us-west-1.amazonaws.com`                                                                                                                         │
+  * `COS` 类型：以 `cos://` 开头，并包含 `host` 参数。示例：`cos://bucket/backup?host=cos.ap-nanjing.myqcloud.com`                                                                                                                     │
+  * `S3_COMPATIBLE` 类型：以 `s3://` 开头，并包含 S3 兼容存储的 `host` 参数。示例：`s3://bucket/backup?host=minio.example.com`                                                                                                         │
+* ossAccessSecret：存放访问凭证的 Secret 资源名。如果备份目的地类型为 `OSS`、`S3`、`COS` 或 `S3_COMPATIBLE`，该字段必须提供。
 
 tenantSecret 示例：
 
@@ -120,6 +125,9 @@ data:
   # base64 encoded
   accessId: ******
   accessKey: ******
+  appId: ******             # this config is for COS
+  s3Region: ******          # this config is for S3
+  addressingModel: ******   # this config is for S3_COMPATIBLE, (supported from version 2.3.3)
 ```
 
 ## 常用操作