Skip to content

Commit

Permalink
docs: fix bugs in user docs (#5918)
Browse files Browse the repository at this point in the history
  • Loading branch information
michelle-0808 authored Nov 27, 2023
1 parent 7008c8f commit 4934ee6
Show file tree
Hide file tree
Showing 18 changed files with 40 additions and 39 deletions.
Binary file added docs/img/apecloud-mysql-intro-role-changing.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/observability-loki-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Scale for a Kafka cluster
description: How to scale a Kafka cluster, horizontal scaling, vertical scaling
keywords: [mysql, horizontal scaling, vertical scaling]
keywords: [kafka, horizontal scaling, vertical scaling]
sidebar_position: 3
sidebar_label: Scale
---
Expand Down Expand Up @@ -110,7 +110,7 @@ ivy85 default kafka kafka-3.3.2 Delete Runn
terminationPolicy: Halt
```
2. Check the cluste status to validate the vertical scaling.
2. Check the cluster status to validate the vertical scaling.
```bash
kbcli cluster list mysql-cluster
Expand All @@ -126,7 +126,7 @@ ivy85 default kafka kafka-3.3.2 Delete Runn
:::note
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the opsRequest of configuration to change parameters accordingly. Refer to [Configuration](./../configuration/configuration.md) for instructions.
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the OpsRequest of configuration to change parameters accordingly. Refer to [Configuration](./../configuration/configuration.md) for instructions.
:::
Expand All @@ -143,7 +143,7 @@ Horizontal scaling changes the amount of pods. For example, you can apply horizo
### Before you start
- Check whether the cluster STATUS is `Running`. Otherwise, the following operations may fail.
- You are not recommended to perform horizontal scaling on controller node, including the controller node both in combined mode and separated node.
- You are not recommended to perform horizontal scaling on the controller node, including the controller node both in combined mode and separated node.
- When scaling in horizontally, you must know the topic partition storage, if the topic has only one replication, data loss may caused when you scale in broker.
```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ You can also view the details of this configuration file and parameters.
</details>

* Allowed Values: It defines the valid value range of this parameter.
* Dynamic: The value of `Dynamic` in `Configure Constraint` defines how the parameter configuration takes effect. Currerntly, Kafka only supports static strategy, i.e. `Dynamic` is `false`. Restarting is required to make configuration effective.
* Dynamic: The value of `Dynamic` in `Configure Constraint` defines how the parameter configuration takes effect. Currently, Kafka only supports static strategy, i.e. `Dynamic` is `false`. Restarting is required to make the configuration effective.
* Description: It describes the parameter definition.

## Configure parameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Scale for MongoDB cluster
description: How to vertically scale a MongoDB cluster
keywords: [mongodb, vertical sclaing, vertially scale a mongodb cluster]
keywords: [mongodb, vertical scaling, vertically scale a mongodb cluster]
sidebar_position: 2
sidebar_label: Scale
---
Expand Down Expand Up @@ -115,7 +115,7 @@ kbcli cluster list mongodb-cluster

:::note

Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the opsRequest of configuration to change parameters accordingly. Refer to [Configuration](./../configuration/configuration.md) for instructions.
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the OpsRequest of configuration to change parameters accordingly. Refer to [Configuration](./../configuration/configuration.md) for instructions.

:::

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Configure cluster parameters
description: Configure cluster parameters
keywords: [parameter, configuration, reconfiguration]
keywords: [mongodb, parameter, configuration, reconfiguration]
sidebar_position: 1
---

Expand Down Expand Up @@ -57,7 +57,7 @@ The example below configures systemLog.verbosity to 1.
kbcli cluster describe-ops mongodb-cluster-reconfiguring-q8ndn -n default
```

2. Check configure history.
2. Check the configuration history.

```bash

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: MySQL introduction
description: MySQL introduction
keywords: [apecloud, mysql, introduction]
keywords: [apecloud mysql, mysql, introduction]
sidebar_position: 1
---

Expand All @@ -22,11 +22,11 @@ ApeCloud MySQL supports four roles, **Leader**, **Follower**, **Candidate**, and
- Learner: This role is usually used for cross-regional consistent read-only data. Data synchronization is performed through the Paxos protocol, and the data source can be a Leader or a Follower. The learner is a special role in the consensus algorithm protocol, and does not participate in voting or being elected as a Candidate role.
- Candidate: The Candidate is an intermediate role that exists only during the election process or when a majority number is not enough to select the Leader role. Normally, all Candidates in a high availability cluster will eventually become a Leader or a Follower after the election is completed.

Role | Leader |Follower | Learner | Candidate |
---- |----| ----|----|----|
**Capability**|RW/HA|RO/HA|RO|-|
| Role | Leader |Follower | Learner | Candidate |
| ---- |----| ----|----|----|
| **Capability**|RW/HA|RO/HA|RO|-|

![Role_changing](./../../../img/intro_role_changing.png)
![Role_changing](../../../img/apecloud-mysql-intro-role-changing.jpg)

### Failover

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ mysql-cluster default apecloud-mysql ac-mysql-8.0.30
terminationPolicy: Halt
```
2. Check the cluste status to validate the vertical scaling.
2. Check the cluster status to validate the vertical scaling.
```bash
kbcli cluster list mysql-cluster
Expand All @@ -126,7 +126,7 @@ mysql-cluster default apecloud-mysql ac-mysql-8.0.30
:::note
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the opsRequest of configuration to change parameters accordingly. Refer to [Configuration](./../configuration/configuration.md) for instructions.
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the OpsRequest of configuration to change parameters accordingly. Refer to [Configuration](./../configuration/configuration.md) for instructions.
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ You can also view the details of this configuration file and parameters.

* Allowed Values: It defines the valid value range of this parameter.
* Dynamic: The value of `Dynamic` in `Configure Constraint` defines how the parameter configuration takes effect. There are two different configuration strategies based on the effectiveness type of modified parameters, i.e. **dynamic** and **static**.
* When `Dynamic` is `true`, it means the effectiveness type of parameters is **dynamic** and can be configured online. Follow the instructions in [Configure dynamic parameters](#configure-dynamic-parameters).
* When `Dynamic` is `false`, it means the effectiveness type of parameters is **static** and a pod restarting is required to make configuration effective. Follow the instructions in [Configure static parameters](#configure-static-parameters).
* When `Dynamic` is `true`, it means the effectiveness type of parameters is **dynamic** and can be configured online.
* When `Dynamic` is `false`, it means the effectiveness type of parameters is **static** and a pod restarting is required to make the configuration effective.
* Description: It describes the parameter definition.

## Configure parameters
Expand Down Expand Up @@ -192,9 +192,9 @@ The example below takes configuring `max_connection` and `innodb_buffer_pool_siz

### Configure parameters with edit-config command

For your convenience, KubeBlocks offers a tool `edit-config` to help you to configure parameter in a visulized way.
For your convenience, KubeBlocks offers a tool `edit-config` to help you configure parameters in a visualized way.

For Linux and macOS, you can edit configuration files by vi. For Windows, you can edit files on notepad.
For Linux and macOS, you can edit configuration files by vi. For Windows, you can edit files on the notepad.

The following steps take configuring MySQL Standalone as an example.

Expand All @@ -206,7 +206,7 @@ The following steps take configuring MySQL Standalone as an example.

:::note

* `--config-spec` is required to specify a configuration template since ApeCloud MySQL currently supports multiple templates. You can run `kbcli cluster describe-config mysql-cluster` to view the all template names.
* `--config-spec` is required to specify a configuration template since ApeCloud MySQL currently supports multiple templates. You can run `kbcli cluster describe-config mysql-cluster` to view all template names.
* If there are multiple components in a cluster, use `--component` to specify a component.

:::
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Full feature and limit list
description: The full feature and limit list of KubeBlocks migration function for PostgreSQL
keywords: [postgresql, migration, migrate data in PostgreSQL to KubeBlocks, full feature, limit]
keywords: [mysql, migration, migrate data in MySQL to KubeBlocks, full feature, limit]
sidebar_position: 1
sidebar_label: Full feature and limit list
---
Expand Down Expand Up @@ -36,7 +36,7 @@ sidebar_label: Full feature and limit list
* Except for the incremental data migration module, other modules do not support resumable upload, i.e. if an exception occurs in this module, such as pod failure caused by downtime and network disconnection, a re-migration is required.
* During the data transmission task, DDL on the migration objects in the source database is not supported.
* The table name and field name cannot contain Chinese characters and special characters like a single quotation mark (') and a comma (,).
* During the migration process, the switchover of primary and secondry nodes in the source library is not supported, which may cause the connection string specified in the task configuration to change. This further leads to migration link failure.
* During the migration process, the switchover of primary and secondary nodes in the source library is not supported, which may cause the connection string specified in the task configuration to change. This further leads to migration link failure.
* Precheck module: None
* Structure initialization module
* The user-defined type is not supported.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ It is recommended to prepare data sampling for verification after the migration
2. (Optional) Specify migration steps by the flag `--steps`.
The default steps follow the order precheck -> structure initialization -> data initialization -> incremental migration. You can use `--steps` to specify migration steps. For example, perform tasks in the order of precheck -> structure initialization -> data initialization -> incremental migration.
The default steps follow the order precheck -> structure initialization -> data initialization -> incremental migration. You can use `--steps` to specify migration steps. For example, perform tasks in the order of precheck -> data initialization -> incremental migration.
```bash
kbcli migration create mytask --template apecloud-mysql2mysql \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ View the log of VTGate.
kubectl logs myproxy-cluster-vtgate-8659d5db95-4dzt5
```

View the log of VTTable and `-c` is required.
View the log of VTTablet and `-c` is required.

```bash
kubectl logs myproxy-cluster-mysql-0 -c vttablet
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ pg-cluster default postgresql-cluster postgresql-14.7.0 Delete
:::note
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the opsRequest of configuration to change parameters accordingly. Refer to [Configuration](./../configuration/configuration.md) for instructions.
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the OpsRequest of configuration to change parameters accordingly. Refer to [Configuration](./../configuration/configuration.md) for instructions.
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ You can also view the details of this configuration file and parameters.

* Allowed Values: It defines the valid value range of this parameter.
* Dynamic: The value of `Dynamic` in `Configure Constraint` defines how the parameter configuration takes effect. There are two different configuration strategies based on the effectiveness type of modified parameters, i.e. **dynamic** and **static**.
* When `Dynamic` is `true`, it means the effectiveness type of parameters is **dynamic** and can be configured online. Follow the instructions in [Configure dynamic parameters](#configure-dynamic-parameters).
* When `Dynamic` is `false`, it means the effectiveness type of parameters is **static** and a pod restarting is required to make configuration effective. Follow the instructions in [Configure static parameters](#configure-static-parameters).
* When `Dynamic` is `true`, it means the effectiveness type of parameters is **dynamic** and can be configured online.
* When `Dynamic` is `false`, it means the effectiveness type of parameters is **static** and a pod restarting is required to make the configuration effective.
* Description: It describes the parameter definition.

## Configure parameters
Expand Down Expand Up @@ -164,9 +164,9 @@ The example below takes configuring `max_connections` as an example.

### Configure parameters with edit-config command

For your convenience, KubeBlocks offers a tool `edit-config` to help you to configure parameter in a visulized way.
For your convenience, KubeBlocks offers a tool `edit-config` to help you configure parameters in a visualized way.

For Linux and macOS, you can edit configuration files by vi. For Windows, you can edit files on notepad.
For Linux and macOS, you can edit configuration files by vi. For Windows, you can edit files on the notepad.

1. Edit the configuration file.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Scale for a Pulsar
description: How to scale a Pulsar cluster, horizontal scaling, vertical scaling
keywords: [mysql, horizontal scaling, vertical scaling]
keywords: [pulsar, horizontal scaling, vertical scaling]
sidebar_position: 2
sidebar_label: Scale
---
Expand Down Expand Up @@ -92,7 +92,7 @@ kbcli cluster list pulsar
:::note
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the opsRequest of configuration to change parameters accordingly. Refer to [Configuration](./../configuration/configuration.md) for instructions.
Vertical scaling does not synchronize parameters related to CPU and memory and it is required to manually call the OpsRequest of configuration to change parameters accordingly. Refer to [Configuration](./../configuration/configuration.md) for instructions.
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ You can also view the details of this configuration file and parameters.

* Allowed Values: It defines the valid value range of this parameter.
* Dynamic: The value of `Dynamic` in `Configure Constraint` defines how the parameter configuration takes effect. There are two different configuration strategies based on the effectiveness type of modified parameters, i.e. **dynamic** and **static**.
* When `Dynamic` is `true`, it means the effectiveness type of parameters is **dynamic** and can be updated online. Follow the instructions in [Configure dynamic parameters](#configure-dynamic-parameters).
* When `Dynamic` is `false`, it means the effectiveness type of parameters is **static** and a pod restarting is required to make configuration effective. Follow the instructions in [Configure static parameters](#configure-static-parameters).
* When `Dynamic` is `true`, it means the effectiveness type of parameters is **dynamic** and can be updated online.
* When `Dynamic` is `false`, it means the effectiveness type of parameters is **static** and a pod restarting is required to make the configuration effective.
* Description: It describes the parameter definition.

## Configure parameters
Expand Down Expand Up @@ -161,9 +161,9 @@ The example below configures `acllog-max-len`.

### Configure parameters with edit-config command

For your convenience, KubeBlocks offers a tool `edit-config` to help you to configure parameter in a visulized way.
For your convenience, KubeBlocks offers a tool `edit-config` to help you configure parameters in a visualized way.

For Linux and macOS, you can edit configuration files by vi. For Windows, you can edit files on notepad.
For Linux and macOS, you can edit configuration files by vi. For Windows, you can edit files on the notepad.

1. Edit the configuration file.

Expand Down
7 changes: 4 additions & 3 deletions docs/user_docs/observability/advanced-logs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Advanced logs
description: How to configure advanced log function for a database using KubeBlocks v0.6.0
description: How to configure advanced log function for a database using KubeBlocks
keywords: [advanced logs, observability]
sidebar_position: 4
sidebar_label: Advanced logs
---
Expand Down Expand Up @@ -70,7 +71,7 @@ Before enabling the advanced logs function, deploy a Loki node first and then ap

3. Run Grafana to view the status of Loki. For example,

![Loki in Grafana]
![Loki in Grafana](./../../img/observability-loki-dashboard.png)

4. (Optional) Disable the Agamotto add-on.

Expand Down Expand Up @@ -273,7 +274,7 @@ For more LogCLI and LogQL grammar, refer to the [Loki official documentation](ht

By default, in the ClusterDefinition of MySQL, there is a sidecar container named `metrics` in the podSpec definition of the `mysql component`.

This `metrics` container detects the error logs and slow logs output by the MySQL in real-time, and dumps the logs to the host's `/var/log/KubeBlocks` directory. To prevent taking up too much host disk space, the default size of each file is 10 MB, and a maximum of 2 files can be saved.
This `metrics` container detects the error logs and slow logs output by MySQL in real-time, and dumps the logs to the host's `/var/log/KubeBlocks` directory. To prevent taking up too much host disk space, the default size of each file is 10 MB, and a maximum of 2 files can be saved.
In addition, the Agamotto component deployed on the host detects the `/var/log/KubeBlocks` folder in real-time and collects the log data in it to complete the entire log data collection link.
Expand Down
Binary file added docs/user_docs/observability/advanced-logs.pdf
Binary file not shown.

0 comments on commit 4934ee6

Please sign in to comment.