docs: merge cn api docs and update descriptions for termination policy #8414
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
michelle-0808
commented
Nov 6, 2024
michelle-0808
commented
- Updated the descriptions about the termination policy. This update applies to all the engines in the en docs but the descriptions are the same.
- Merged cn api docs into user docs: apecloud mysql, mysql, postgresql.
- Fixed some bugs, such as cluster name, missing namespace in commands.
zjx20
reviewed
Nov 7, 2024
| * 确保 ApeCloud MySQL 引擎已启用。如果引擎未启用，可参考[该文档](./../../overview/database-engines-supported.md#使用引擎)启用引擎。 | ||
| * 如果您想通过 `kbcli` 创建并连接 ApeCloud MySQL 集群，请先[安装 kbcli](./../../installation/install-with-kbcli/install-kbcli.md)。 | ||
| * 安装 KubeBlocks，可通过 [kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) 或者 [Helm](./../../installation/install-with-helm/install-kubeblocks.md) 安装。 | ||
| * 确保 ApeCloud MySQL 引擎已启用。KubeBlocks 默认已安装 ApeCloud MySQL，如果您在安装 KubeBlcoks 关闭/卸载了该引擎，可参考相关文档，再次启用/安装该引擎，可通过 [kbcli](./../../installation/install-with-kbcli/install-addons.md) 或者 [Helm](./../../installation/install-with-helm/install-addons.md) 操作。 |
| 1. 获取用于 `kubectl exec` 命令的 `username` 和 `password`。 | ||
|
|
||
| ```bash | ||
| kubectl get secrets -n demo mycluster-conn-credential -o jsonpath='{.data.\username}' | base64 -d |
There was a problem hiding this comment.
{.data.\username} => {.data.username}
Don't escape. Check the rest of the PR.
|
|
||
| </details> | ||
| </details> | ||
|
|
||
| 4. 连接到数据库，验证参数是否按预期配置。 | ||
|
|
||
| 整体搜索过程有 30 秒的延迟，因为 kubelet 需要一些时间同步对 Pod 卷的修改。 |
| 1. 启用 etcd 引擎，创建 etcd 集群。 | ||
|
|
||
| 1. 安装并启用 etcd 引擎。ectd 引擎默认未安装，需安装后在进行后续操作。可参考[使用引擎](./../../overview/database-engines-supported.md#使用引擎)。 | ||
| 1. 安装并启用 etcd 引擎。ectd 引擎默认未安装，需安装后在进行后续操作。可参考[使用引擎](./../../installation/install-with-kbcli/install-addons.md)文档。 |
|
|
||
| :::note | ||
|
|
||
| 如果您只有一个节点可用于部署集群版，可在创建集群时将 `extra.availability-policy` 设置为 `none`。 |
There was a problem hiding this comment.
extra.availability-policy => extra.availabilityPolicy
| ```bash | ||
| helm install prometheus kubeblocks/prometheus --namespace kb-system --create-namespace | ||
| helm install prometheus kubeblocks/prometheus --namespace kb-system --create-namespace | ||
| helm install prometheus kubeblocks/prometheus --namespace kb-system --create-namespace |
| # 2. Connect to the Grafana dashboard | ||
| kubectl port-forward svc/grafana -n kb-system 3000:8 | ||
|
|
||
| # 3. Open the web browser and enter the address 127.0.0.1:3000 to visit the dashboard. |
| # 故障模拟与自动恢复 | ||
|
|
||
| 作为一个开源数据管理平台，Kubeblocks目前支持三十多种数据库引擎，并且持续扩展中。由于这些数据库本身的高可用能力是参差不齐的，因此KubeBlocks设计实现了一套高可用系统用于保障数据库实例的高可用能力。KubeBlocks高可用系统采用了统一的HA框架设计，实现对数据库的高可用支持，使得不同的数据库在KubeBlocks上可以获得类似的高可用能力和体验。 | ||
| 作为一个开源数据管理平台，Kubeblocks 目前支持三十多种数据库引擎，并且持续扩展中。由于这些数据库本身的高可用能力是参差不齐的，因此 KubeBlocks 设计实现了一套高可用系统用于保障数据库实例的高可用能力。KubeBlocks 高可用系统采用了统一的HA框架设计，实现对数据库的高可用支持，使得不同的数据库在 KubeBlocks 上可以获得类似的高可用能力和体验。 |
|
|
||
| 这是因为节点删除后，都会自动触发重建，然后 MySQL 会自动完成集群恢复及选主。选主完成后，Kubeblocks 会探测新的主节点，并更新访问链路，恢复可用。整体耗时在 30 秒内。 | ||
| 这是因为节点删除后，都会自动触发重建，然后 MySQL 会自动完成集群恢复及选主。选主完成后，Kubeblocks 会探测新的主节点，并更新访问链路，恢复可用。整体耗时在 30 秒内。 |
zjx20
approved these changes
Nov 8, 2024
shanshanying
approved these changes
Nov 11, 2024
|
/cherry-pick release-1.0-beta |
|
🤖 says: cherry pick action finished successfully 🎉! |
ian-hui
pushed a commit
to ian-hui/kubeblocks
that referenced
this pull request
Nov 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.