From af079dc99721d851479a8765d953af7f8806060d Mon Sep 17 00:00:00 2001 From: yuanyuan zhang Date: Fri, 24 Jan 2025 16:20:06 +0800 Subject: [PATCH] docs: fix bugs --- .../handle-an-exception/full-disk-lock.md | 16 +++++++++++----- .../backup-and-restore/backup/backup-repo.md | 8 ++++---- .../handle-an-exception/full-disk-lock.md | 16 +++++++++++----- .../backup-and-restore/backup/backup-repo.md | 6 +++--- 4 files changed, 29 insertions(+), 17 deletions(-) diff --git a/docs/user_docs/handle-an-exception/full-disk-lock.md b/docs/user_docs/handle-an-exception/full-disk-lock.md index a3a6c4af20b..44d86413c3b 100644 --- a/docs/user_docs/handle-an-exception/full-disk-lock.md +++ b/docs/user_docs/handle-an-exception/full-disk-lock.md @@ -44,11 +44,17 @@ When the space water level of all configured volumes falls below the defined thr 2. Add the `volumeProtectionSpec` field under `spec.componentDefs[]` to enable the full disk lock function. You can set the values of `highWatermark` as needed. ```yaml - volumeProtectionSpec: - highWatermark: 90 - volumes: - - highWatermark: 85 - name: data + ... + spec: + componentDefs: + ... + - name: mysql + volumeProtectionSpec: + highWatermark: 90 + volumes: + - highWatermark: 85 + name: data + ... ``` :::note diff --git a/docs/user_docs/maintenance/backup-and-restore/backup/backup-repo.md b/docs/user_docs/maintenance/backup-and-restore/backup/backup-repo.md index 66c9d785e8a..ec97a075157 100644 --- a/docs/user_docs/maintenance/backup-and-restore/backup/backup-repo.md +++ b/docs/user_docs/maintenance/backup-and-restore/backup/backup-repo.md @@ -499,9 +499,9 @@ If the BackupRepo status shows Failed or remains in PreChecking for a long time, To troubleshoot: -* Verify whether configuration parameters, such as `endpoint`, `accessKeyId`, and `secretAccessKey`, are correctly specified. +* Check whether configuration parameters, such as `endpoint`, `accessKeyId`, and `secretAccessKey`, are correctly specified. * For self-hosted object storage (e.g., Ceph Object Storage), try using `minio` as StorageProvider. The default `s3` StorageProvider uses a virtual hosting URL style, which some self-hosted storage may not support. -* If you see an `InvalidLocationConstraint` error, leave the `region` parameter empty and try again. +* If an `InvalidLocationConstraint` error occurs, check whether its parameter is corretly configured. If this error persists, leave the `region` parameter empty and try again. * If the status remains in the `PreChecking` state, check your network connection. Ensure the storage service is accessible from within the Kubernetes cluster. You can test this by running a Pod and connecting to the storage service using the corresponding client. * KubeBlocks uses [rclone](https://rclone.org/) internally for data transfer. Check whether rclone can successfully access the storage service. @@ -509,7 +509,7 @@ To troubleshoot: ### Automatic BackupRepo configuration -You can specify the BackupRepo information in a YAML configuration file when installing KubeBlocks, and KubeBlocks will create the BackupRepo and automatically install the necessary CSI Driver based on the provided configuration. +You can specify the BackupRepo information in a YAML configuration file when installing KubeBlocks, and KubeBlocks will create the BackupRepo accordingly. 1. Prepare the configuration file. @@ -535,7 +535,7 @@ You can specify the BackupRepo information in a YAML configuration file when ins :::note -* In KubeBlocks, the available `storageProvider` options are `s3`, `cos`, `gcs-s3comp`, `obs`, `oss`, `s3-compatible`, `pvc`, `ftp`, and `nfs`. +* In KubeBlocks, the available `storageProvider` options are `s3`, `cos`, `gcs-s3comp`, `obs`, `oss`, `minio`, `ftp`, and `nfs`. * For different `storageProvider`, the configuration may differ. `config` and `secrets` in the above example are applied to S3. * Execute the command `kubectl get storageproviders.dataprotection.kubeblocks.io` to view the supported `storageProvider` options. diff --git a/i18n/zh-cn/user-docs/handle-an-exception/full-disk-lock.md b/i18n/zh-cn/user-docs/handle-an-exception/full-disk-lock.md index d2821913b6b..e8a36db2ca5 100644 --- a/i18n/zh-cn/user-docs/handle-an-exception/full-disk-lock.md +++ b/i18n/zh-cn/user-docs/handle-an-exception/full-disk-lock.md @@ -39,11 +39,17 @@ KubeBlocks 的磁盘满锁功能确保了数据库的稳定性和可用性。该 2. 将 `volumeProtectionSpec` 字段添加至 `spec.componentDefs[]`，启用磁盘满锁功能。可根据需要设置 `highWatermark` 的值。 ```yaml - volumeProtectionSpec: - highWatermark: 90 - volumes: - - highWatermark: 85 - name: data + ... + spec: + componentDefs: + ... + - name: mysql + volumeProtectionSpec: + highWatermark: 90 + volumes: + - highWatermark: 85 + name: data + ... ``` :::note diff --git a/i18n/zh-cn/user-docs/maintenance/backup-and-restore/backup/backup-repo.md b/i18n/zh-cn/user-docs/maintenance/backup-and-restore/backup/backup-repo.md index 99cace3a695..2b5f7697048 100644 --- a/i18n/zh-cn/user-docs/maintenance/backup-and-restore/backup/backup-repo.md +++ b/i18n/zh-cn/user-docs/maintenance/backup-and-restore/backup/backup-repo.md @@ -511,7 +511,7 @@ BackupRepo 是备份数据的存储仓库，支持配置 OSS（阿里云对象 * 检查配置内容是否正确，如 `endpoint`，`accessKeyId` 和 `secretAccessKey` 等参数是否正确填写。 * 对于其他自建的对象存储，如 Ceph Object Storage ，可尝试使用 `minio` StorageProvider。由于 `s3` StorageProvider 默认使用 virtual hosting 风格的 URL 访问服务端，自建对象存储很可能不支持这种访问方式。 -* 如提示 `InvalidLocationConstraint` 错误，`region` 参数可尝试留空不填。 +* 如提示 `InvalidLocationConstraint` 错误，请先检查 `region` 参数是否正确填写。如果仍有 `InvalidLocationConstraint` 报错，可将尝试 `region` 参数留空不填。 * 如果长时间处于 `PreChecking` 状态，很可能是网络问题。请确保在 K8s 集群内能正常访问存储服务，例如可运行一个 Pod，在 Pod 里面通过对应的客户端尝试连接存储服务。 * KubeBlocks 内部使用 [rclone](https://rclone.org/) 传输数据，请确保能通过 rclone 正常访问当前所使用的存储服务。 @@ -519,7 +519,7 @@ BackupRepo 是备份数据的存储仓库，支持配置 OSS（阿里云对象 ### 自动配置 BackupRepo -安装 KubeBlocks 时，可以通过配置文件指定 BackupRepo 相关信息，KubeBlocks 会根据配置信息创建 BackupRepo 并自动安装必要的 CSI Driver。 +安装 KubeBlocks 时，可以通过配置文件指定 BackupRepo 相关信息，KubeBlocks 会根据配置信息创建 BackupRepo。 1. 准备配置文件。 @@ -545,7 +545,7 @@ BackupRepo 是备份数据的存储仓库，支持配置 OSS（阿里云对象 :::note -* KubeBlocks 中，`storageProvider` 目前可选值为 `s3`、`cos`、`gcs-s3comp`、`obs`、`oss`、`s3-compatible`、`ftp`、`nfs`。 +* KubeBlocks 中，`storageProvider` 目前可选值为 `s3`、`cos`、`gcs-s3comp`、`obs`、`oss`、`minio`、`ftp`、`nfs`。 * 不同 `storageProvider` 所需的配置信息并不统一，上面展示的 `config` 和 `secrets` 适用于 S3。 * 执行 `kubectl get storageproviders.dataprotection.kubeblocks.io` 命令可以查看支持的 `storageProvider`。