Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adjust cn docs format #6754

Merged
merged 2 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ kbcli cluster list mongodb-cluster
- STATUS=Abnormal 表示垂直扩容异常。原因可能是正常实例的数量少于总实例数,或者 Leader 实例正常运行而其他实例异常。
> 你可以手动检查是否由于资源不足而导致报错。如果 Kubernetes 集群支持 AutoScaling,系统在资源充足的情况下会执行自动恢复。或者你也可以创建足够的资源,并使用 `kubectl describe` 命令进行故障排除。


:::note

垂直扩容不会同步与 CPU 和内存相关的参数,需要手动调用配置的 OpsRequest 来进行更改。详情请参考[配置](./../../kubeblocks-for-mongodb/configuration/configure-cluster-parameters.md)。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,11 @@ Linux 和 macOS 系统可以使用 vi 编辑器编辑配置文件,Windows 系
kbcli cluster edit-config mongodb-cluster
```

:::note
:::note

如果集群中有多个组件,请使用 `--component` 参数指定一个组件。
:::
如果集群中有多个组件,请使用 `--component` 参数指定一个组件。

:::

2. 查看参数配置状态。

Expand All @@ -111,9 +111,9 @@ Linux 和 macOS 系统可以使用 vi 编辑器编辑配置文件,Windows 系
kbcli cluster connect mongodb-cluster
```

:::note
:::note

1. `edit-config` 不能同时编辑静态参数和动态参数。
2. KubeBlocks 未来将支持删除参数。
1. `edit-config` 不能同时编辑静态参数和动态参数。
2. KubeBlocks 未来将支持删除参数。

:::
:::
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ KubeBlocks 提供了一套统一的默认配置生成策略,适用于在 KubeB

## 查看参数信息

* 查看集群的配置文件。
查看集群的配置文件。

```bash
kbcli cluster describe-config mysql-cluster
```
```bash
kbcli cluster describe-config mysql-cluster
```

从元信息中可以看到,集群 `mysql-cluster` 有一个名为 `my.cnf` 的配置文件。
从元信息中可以看到,集群 `mysql-cluster` 有一个名为 `my.cnf` 的配置文件。

你也可以查看此配置文件和参数的详细信息。
你也可以查看此配置文件和参数的详细信息。

* 查看当前配置文件的详细信息。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ ApeCloud MySQL 代理是 Vitess 项目的一个分支。为了提供更好的 SQ

**读写分离**:ApeCloud MySQL 代理通过自动将读查询路由到只读节点,将写查询路由到主节点,简化了应用程序逻辑。这是通过解析 SQL 语句实现的,它因此改善了负载均衡,确保有效利用可用资源。

**写后读一致性**: :此功能与读写分离配合使用,以在获得性能改进的同时保持数据一致性。当应用程序将数据写入主节点,并在只读节点上读取时,ApeCloud MySQL 代理确保刚刚写入主节点的数据可以从只读节点中访问和读取。
**写后读一致性**:此功能与读写分离配合使用,以在获得性能改进的同时保持数据一致性。当应用程序将数据写入主节点,并在只读节点上读取时,ApeCloud MySQL 代理确保刚刚写入主节点的数据可以从只读节点中访问和读取。

**负载均衡**:ApeCloud MySQL 代理通过使用各种负载均衡策略将查询路由到适当的只读节点,从而帮助管理只读节点。这确保工作负载在所有可用节点上均匀分布,因此实现了性能优化和资源利用率的提高。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,11 +174,11 @@ Linux 和 macOS 系统可以使用 vi 编辑器编辑配置文件,Windows 系
kbcli cluster edit-config pg-cluster
```

:::note
:::note

如果集群中有多个组件,请使用 `--component` 参数指定一个组件。
如果集群中有多个组件,请使用 `--component` 参数指定一个组件。

:::
:::

2. 查看参数配置状态。

Expand All @@ -192,12 +192,12 @@ Linux 和 macOS 系统可以使用 vi 编辑器编辑配置文件,Windows 系
kbcli cluster connect pg-cluster
```

:::note
:::note

1. `edit-config` 不能同时编辑静态参数和动态参数。
2. KubeBlocks 将在后续版本支持参数删除。
1. `edit-config` 不能同时编辑静态参数和动态参数。
2. KubeBlocks 将在后续版本支持参数删除。

:::
:::

## 查看历史记录并比较参数差异

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ kbcli migration logs ${migration-task-name} --step ${step-name}
在业务切换到目标数据库之后,默认新写入的 Sequence 不会以源库的 Sequence 的最大值作为初始值继续去递增。需要手动设置。

```bash
# PostgreSQL Function 示例:
# PostgreSQL Function 示例

CREATE FUNCTION build_setvals() returns void
AS $$
Expand All @@ -198,16 +198,16 @@ kbcli migration logs ${migration-task-name} --step ${step-name}
$$
LANGUAGE plpgsql;

# Execute:
# 执行
psql -hxx -p xx -U xx -d xx -c "set client_min_messages = notice; select build_setvals();" | grep setval

# Output like:
# 输出类似于
NOTICE: select setval('public.seq_test_1'::regclass, 2);
NOTICE: select setval('public.seq_test_2'::regclass, 1001);
NOTICE: select setval('public.seq_test_3'::regclass, 203);
NOTICE: select setval('public.seq_test_4'::regclass, 476);

# Execute the above script in the sink
# 在目标端执行上述脚本
```

* Slot 的生命周期
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,21 @@ kbcli cluster list pulsar

:::

- 扩展 `journal` 卷。
- 扩展 `journal` 卷。

```bash
kbcli cluster volume-expand pulsar --storage=40Gi --components=bookies -t journal
```
```bash
kbcli cluster volume-expand pulsar --storage=40Gi --components=bookies -t journal
```

- `--components` 表示需扩容的组件名称。
- `--volume-claim-templates` 表示组件中的 VolumeClaimTemplate 名称。
- `--storage` 表示磁盘需扩容至的大小。
- `--components` 表示需扩容的组件名称。
- `--volume-claim-templates` 表示组件中的 VolumeClaimTemplate 名称。
- `--storage` 表示磁盘需扩容至的大小。

- 扩展 `ledger` 卷。
- 扩展 `ledger` 卷。

```bash
kbcli cluster volume-expand pulsar --storage=200Gi --components=bookies -t ledgers
```
```bash
kbcli cluster volume-expand pulsar --storage=200Gi --components=bookies -t ledgers
```

**选项 2.** 创建 OpsRequest

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ sidebar_position: 1

* 查看集群的当前配置文件。

```bash
kbcli cluster describe-config pulsar
```
```bash
kbcli cluster describe-config pulsar
```

* 查看当前配置文件的详细信息。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,11 +171,11 @@ Linux 和 macOS 系统可以使用 vi 编辑器编辑配置文件,Windows 系
kbcli cluster edit-config redis-cluster
```

:::note
:::note

如果集群中有多个组件,请使用 `--component` 参数指定一个组件。
如果集群中有多个组件,请使用 `--component` 参数指定一个组件。

:::
:::

2. 查看参数配置状态。

Expand All @@ -184,16 +184,17 @@ Linux 和 macOS 系统可以使用 vi 编辑器编辑配置文件,Windows 系
```

3. 连接到数据库,验证参数是否按预期配置。

```bash
kbcli cluster connect redis-cluster
```

:::note
:::note

1. `edit-config` 不能同时编辑静态参数和动态参数。
2. KubeBlocks 未来将支持删除参数。
1. `edit-config` 不能同时编辑静态参数和动态参数。
2. KubeBlocks 未来将支持删除参数。

:::
:::

## 查看历史记录并比较参数差异

Expand Down
Loading