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

chore: update user-docs fix some typos #8759

Merged
merged 2 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
4 changes: 2 additions & 2 deletions docs/03 - debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ We can use [Delve](https://github.com/go-delve/delve) for Go debugging.
### Install Delve
- Follow the [General install instructions](https://github.com/go-delve/delve/tree/master/Documentation/installation).
> Make sure `PATH` containers `$GOPATH/bin` which will allow you to run Go binary executables without specifying the absolute path.
- If you are using MacOS, you can install vid HomeBrew with the following command :
- If you are using MacOS, you can install via HomeBrew with the following command :
shanshanying marked this conversation as resolved.
Show resolved Hide resolved
```shell
brew install delve
```
Expand Down Expand Up @@ -47,7 +47,7 @@ API server listening at: [::]:2347
### Connect the debug server with a frontend client
`Delve` support lots of code editors ([editor plugins for Delve](https://github.com/go-delve/delve/blob/master/Documentation/EditorIntegration.md)), you can choose your favorite editor to connect with the listen address for debugging.

This section introduces how to start debugging with the Delve CLI, Goland and VSCode. Please refer to the Delve or editors documentation for more details.
This section introduces how to start debugging with the Delve CLI, GoLand and VSCode. Please refer to the Delve or editors documentation for more details.

#### Delve CLI

Expand Down
2 changes: 1 addition & 1 deletion docs/04 - basics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Basics
### Kubebuilder
`KubeBlocks` is using kubebuilder as the operator framework, before your start to code, suggest to read [kubebuilder books](https://book.kubebuilder.io/).
`KubeBlocks` is using KubeBuilder as the operator framework, before your start to code, suggest to read [kubebuilder books](https://book.kubebuilder.io/).

### Makefile
`KubeBlocks` includes a [Makefile](../Makefile) in the root of the repo. This serves as a high-level interface for common commands. Running `make help` will produce a list of make targets with descriptions. These targets will be referenced throughout this document.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Kind stands for Kubernetes IN Docker. It runs Kubernetes clusters within Docker

Minikube runs a single-node Kubernetes cluster on your local machine, either in a virtual machine or a container.

1. Install Minikube. For details, you can refer to [Minikube Quck Start](https://minikube.sigs.k8s.io/docs/start/).
1. Install Minikube. For details, you can refer to [Minikube Quick Start](https://minikube.sigs.k8s.io/docs/start/).

<Tabs>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Scale for an ApeCloudto scale a MySQL cluster, horizontal scaling, vertical scaling
title: How to scale a MySQL cluster, horizontal scaling, vertical scaling
keywords: [mysql, horizontal scaling, vertical scaling]
sidebar_position: 2
sidebar_label: Scale
Expand Down Expand Up @@ -99,7 +99,7 @@ mycluster demo apecloud-mysql ac-mysql-8.0.30 Delete
```

</TabItem>

<TabItem value="Edit cluster YAML file" label="Edit cluster YAML file">

1. Change the configuration of `spec.componentSpecs.resources` in the YAML file. `spec.componentSpecs.resources` controls the requirement and limit of resources and changing them triggers a vertical scaling.
Expand Down Expand Up @@ -242,7 +242,7 @@ mycluster demo apecloud-mysql ac-mysql-8.0.30 Delete
type: HorizontalScaling
horizontalScaling:
- componentName: mysql
scaleOut:
scaleOut:
replicaChanges: 2
EOF
```
Expand All @@ -263,7 +263,7 @@ mycluster demo apecloud-mysql ac-mysql-8.0.30 Delete
type: HorizontalScaling
horizontalScaling:
- componentName: mysql
scaleIn:
scaleIn:
replicaChanges: 2
EOF
```
Expand All @@ -286,7 +286,7 @@ mycluster demo apecloud-mysql ac-mysql-8.0.30 Delete
```

</TabItem>

<TabItem value="Edit cluster YAML file" label="Edit cluster YAML file">

1. Change the value of `spec.componentSpecs.replicas` in the YAML file.
Expand Down Expand Up @@ -368,7 +368,7 @@ In the example below, a snapshot exception occurs.

```bash
Status:
conditions:
conditions:
- lastTransitionTime: "2024-09-19T04:20:26Z"
message: VolumeSnapshot/mycluster-mysql-scaling-dbqgp: Failed to set default snapshot
class with error cannot find default snapshot class
Expand Down Expand Up @@ -402,7 +402,7 @@ This exception occurs because the `VolumeSnapshotClass` is not configured. This

```bash
kubectl delete backup -l app.kubernetes.io/instance=mycluster -n demo

kubectl delete volumesnapshot -l app.kubernetes.io/instance=mycluster -n demo
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ KubeBlocks supports configuring cluster parameters with an OpsRequest.
| `spec.reconfigure.configurations.name` | It specifies the configuration template name. |
| `preConditionDeadlineSeconds` | It specifies the maximum number of seconds this OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed. |

2. Apply the configuration opsRequest.
2. Apply the configuration OpsRequest.

```bash
kubectl apply -f mycluster-configuring-demo.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ It is recommended to use kbcli to create an ApeCloud MySQL Proxy Cluster.
etcd-cluster etcd etcd-v3.5.6 Halt Running 10s
```

5. View the service address of this etcd clsuter.
5. View the service address of this etcd cluster.

```bash
kubectl get service
Expand All @@ -110,7 +110,7 @@ It is recommended to use kbcli to create an ApeCloud MySQL Proxy Cluster.
helm search repo kubeblocks/apecloud-mysql --devel --versions
```

2. (Optional) If you disable the `apecloud-mysql` Addon when installing KuebBlocks, run the command below to specify a version and install the cluster definition of ApeCloud MySQL. Skip this step if you install KubeBlocks with the default settings.
2. (Optional) If you disable the `apecloud-mysql` Addon when installing KubeBlocks, run the command below to specify a version and install the cluster definition of ApeCloud MySQL. Skip this step if you install KubeBlocks with the default settings.

```bash
helm install myproxy kubeblocks/apecloud-mysql --version=v0.9.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ curl http://127.0.0.1:9200/_cat/nodes?v

## Scale

KubeBlocks supports horizontally and vertially scaling an Elasticsearch cluster.
KubeBlocks supports horizontally and vertically scaling an Elasticsearch cluster.

### Before you start

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ If you use AWS EKS, you may want to access to the Kafka cluster from EC2 instanc

:::caution

The current version only supports Kafka broker with a single replica (combined: --replicas=1 or separated: --broker-replicas=1) to adpot the following approach.
The current version only supports Kafka broker with a single replica (combined: --replicas=1 or separated: --broker-replicas=1) to adopt the following approach.

:::

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Stop/Start a Kafka cluster
description: How to start/stop a Kafka cluster
keywords: [mongodb, stop a kafka cluster, start a kafka cluster]
keywords: [kafka, stop a kafka cluster, start a kafka cluster]
sidebar_position: 5
sidebar_label: Stop/Start
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ KubeBlocks supports configuring cluster parameters with OpsRequest.
| `spec.reconfigure.configurations.name` | It specifies the configuration template name. |
| `preConditionDeadlineSeconds` | It specifies the maximum number of seconds this OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed. |

2. Apply the configuration opsRequest.
2. Apply the configuration OpsRequest.

```bash
kubectl apply -f mycluster-configuring-demo.yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Create and connect to a MongoDB Cluster
description: How to create and connect to a MongoDB cluster
keywords: [mogodb, create a mongodb cluster]
keywords: [mongodb, create a mongodb cluster]
sidebar_position: 1
sidebar_label: Create and connect
---
Expand Down Expand Up @@ -39,7 +39,7 @@ This tutorial shows how to create and connect to a MongoDB cluster.
```bash
kbcli addon list
>
NAME TYPE STATUS EXTRAS AUTO-INSTALL
NAME TYPE STATUS EXTRAS AUTO-INSTALL
...
mongodb Helm Enabled true
...
Expand Down Expand Up @@ -139,7 +139,7 @@ KubeBlocks supports creating two types of MongoDB clusters: Standalone and Repli
| Field | Definition |
|---------------------------------------|--------------------------------------|
| `spec.terminationPolicy` | It is the policy of cluster termination. Valid values are `DoNotTerminate`, `Delete`, `WipeOut`. For the detailed definition, you can refer to [Termination Policy](./delete-mongodb-cluster.md#termination-policy). |
| `spec.clusterDef` | It specifies the name of the ClusterDefinition to use when creating a Cluster. **Note: DO NOT UPDATE THIS FIELD**. The value must be `mongodb` to create a MongoDB Cluste. |
| `spec.clusterDef` | It specifies the name of the ClusterDefinition to use when creating a Cluster. **Note: DO NOT UPDATE THIS FIELD**. The value must be `mongodb` to create a MongoDB Cluster. |
| `spec.topology` | It specifies the name of the ClusterTopology to be used when creating the Cluster. |
| `spec.componentSpecs` | It is the list of ClusterComponentSpec objects that define the individual Components that make up a Cluster. This field allows customized configuration of each component within a cluster. |
| `spec.componentSpecs.serviceVersion` | It specifies the version of the Service expected to be provisioned by this Component. Valid options are: [4.0.28,4.2.24,4.4.29,5.0.28,6.0.16,7.0.1]. |
Expand Down Expand Up @@ -260,7 +260,7 @@ You can also port forward the service to connect to the database from your local
1. Run the following command to port forward the service.

```bash
kubectl port-forward -n demo svc/mycluster-mongodb 27017:27017
kubectl port-forward -n demo svc/mycluster-mongodb 27017:27017
```

2. Open a new terminal and run the following command to connect to the database.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Stop/Start a MongoDB cluster
description: How to start/stop a MongoDB cluster
keywords: [mongodb, stop a momgodb cluster, start a mongodb cluster]
keywords: [mongodb, stop a mongodb cluster, start a mongodb cluster]
sidebar_position: 5
sidebar_label: Stop/Start
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ kbcli cluster list-instances -n demo

## Handle an exception

If an error occurs, refer to [Handle an exaception](./../../handle-an-exception/handle-a-cluster-exception.md) to troubleshoot the operation.
If an error occurs, refer to [Handle an exception](./../../handle-an-exception/handle-a-cluster-exception.md) to troubleshoot the operation.
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ KubeBlocks supports configuring cluster parameters with OpsRequest.
| `spec.reconfigure.configurations.name` | It specifies the configuration template name. |
| `preConditionDeadlineSeconds` | It specifies the maximum number of seconds this OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed. |

2. Apply the configuration opsRequest.
2. Apply the configuration OpsRequest.

```bash
kubectl apply -f mycluster-configuring-demo.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ KubeBlocks supports configuring cluster parameters with OpsRequest.
| `spec.reconfigure.configurations.name` | It specifies the configuration template name. |
| `preConditionDeadlineSeconds` | It specifies the maximum number of seconds this OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed. |

2. Apply the configuration opsRequest.
2. Apply the configuration OpsRequest.

```bash
kubectl apply -f mycluster-configuring-demo.yaml -n demo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ KubeBlocks integrates [the open-source Patroni solution](https://patroni.readthe

## Before you start

* [Install kbcli](./../../installation/install-kbcli.md) if you want to manage the PostreSQL cluster with `kbcli`.
* [Install kbcli](./../../installation/install-kbcli.md) if you want to manage the PostgreSQL cluster with `kbcli`.
* [Install KubeBlocks](./../../installation/install-kubeblocks.md).
* [Create a PostgreSQL Replication Cluster](./../cluster-management/create-and-connect-a-postgresql-cluster.md#create-a-postgresql-cluster).
* Check whether the following role probe parameters exist to verify the role probe is enabled.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ KubeBlocks supports configuring cluster parameters with OpsRequest.
| `spec.reconfigure.configurations.name` | It specifies the configuration template name. |
| `preConditionDeadlineSeconds` | It specifies the maximum number of seconds this OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed. |

2. Apply the configuration opsRequest.
2. Apply the configuration OpsRequest.

```bash
kubectl apply -f mycluster-configuring-demo.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ EOF
| `spec.terminationPolicy` | It is the policy of cluster termination. Valid values are `DoNotTerminate`, `Delete`, `WipeOut`. For the detailed definition, you can refer to [Termination Policy](#termination-policy). |
| `spec.componentSpecs` | It is the list of ClusterComponentSpec objects that define the individual Components that make up a Cluster. This field allows customized configuration of each component within a cluster. |
| `spec.componentSpecs.serviceVersion` | It specifies the version of the Service expected to be provisioned by this Component. Valid options are [3.10.25,3.11.28,3.12.14,3.13.2,3.13.7,3.8.14,3.9.29]. |
| `spec.componentSpecs.serviceAccountName` | It specifies the name of the ServiceAccount required by the running Component. RabbitMQ needs the `peer-discovery` role to create events and get endpoiints. This is essential for discovering other RabbitMQ nodes and forming a cluster. |
| `spec.componentSpecs.serviceAccountName` | It specifies the name of the ServiceAccount required by the running Component. RabbitMQ needs the `peer-discovery` role to create events and get endpoints. This is essential for discovering other RabbitMQ nodes and forming a cluster. |
| `spec.componentSpecs.replicas` | It specifies the number of replicas of the component. RabbitMQ prefers ODD numbers like [3, 5, 7]. All data/state is replicated across all replicas. |
| `spec.componentSpecs.resources` | It specifies the resources required by the Component. |
| `spec.componentSpecs.volumeClaimTemplates` | It specifies a list of PersistentVolumeClaim templates that define the storage requirements for the Component. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ mycluster demo redis 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 Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Just in case you cannot find the configuration file of your cluster, you can swi
| `spec.reconfigure.configurations.name` | It specifies the configuration template name. |
| `preConditionDeadlineSeconds` | It specifies the maximum number of seconds this OpsRequest will wait for its start conditions to be met before aborting. If set to 0 (default), the start conditions must be met immediately for the OpsRequest to proceed. |

2. Apply the configuration opsRequest.
2. Apply the configuration OpsRequest.

```bash
kubectl apply -f mycluster-configuring-demo.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ kbcli cluster update mysql-cluster --backup-enabled=true \

- `--backup-enabled` indicates whether to enable scheduled backups.
- `--backup-method` specifies the backup method. You can use the `kbcli cluster describe-backup-policy mysql-cluster` command to view the supported backup methods.
- `--backup-repo-name` specifies the name of the backupRepo.
- `--backup-repo-name` specifies the name of the BackupRepo.
- `--backup-retention-period` specifies the retention period for backups, which is 7 days in the example.
- `--backup-cron-expression` specifies the backup schedule using a cron expression in UTC timezone. Refer to [cron](https://en.wikipedia.org/wiki/Cron) for the expression format.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Create several K8s clusters and prepare the configuration information for deploy
...
```

## Deloy cross-K8s clusters
## Deploy cross-K8s clusters

### Deploy the Kubeblocks operator

Expand Down Expand Up @@ -169,7 +169,7 @@ Here takes MetalLB as an example for providing LoadBalancer Services.
| 2 | k8s-2 | k8s-2 | 2 | 10.5.0.0/16 |
| 3 | k8s-3 | k8s-3 | 3 | 10.6.0.0/16 |

2. Deploy MetalLbB in all the data place K8s clusters.
2. Deploy MetalLB in all the data place K8s clusters.

```bash
helm repo add metallb https://metallb.github.io/metallb
Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/maintenance/in-place-update/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ In principle, KubeBlocks instance in-place updates leverage [the Kubernetes Pod
* `spec.containers[*].image`
* `spec.tolerations (only supports adding Toleration)`

Starting from Kubernetes version 1.27, support for in-place updates of CPU and Memory can be further enabled through the `InPlacePodVerticalScaling` feature switch. KubeBlocks also supports the `InPlacePodVerticalScaling` feature switc which further supports the following capabilities:
Starting from Kubernetes version 1.27, support for in-place updates of CPU and Memory can be further enabled through the `InPlacePodVerticalScaling` feature switch. KubeBlocks also supports the `InPlacePodVerticalScaling` feature switch which further supports the following capabilities:

For Kubernetes versions equal to or greater than 1.27 with InPlacePodVerticalScaling enabled, the following fields' in-place updates are supported:

Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/maintenance/scale/horizontal-scale.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ One of these limitations is evident in horizontal scaling scenarios, where *Stat

Another issue arises in the same scenario: if the node hosting Pods experiences a hardware failure, causing disk damage and rendering data read-write inaccessible, according to operational best practices, we need to offload the damaged Pod and rebuild replicas on healthy nodes. However, performing such operational tasks based on *StatefulSets* isn't easy. [Similar discussions](https://github.com/kubernetes/kubernetes/issues/83224) can be observed in the Kubernetes community.

To solve the limitations mentioned above, starting from version 0.9, KubeBlocks replaces *StatefulStes* with *InstanceSet* which is a general workload API and is in charge of a set of instances. With *InstanceSet*, KubeBlocks introduces the *specified instance scaling* feature to improve the availability.
To solve the limitations mentioned above, starting from version 0.9, KubeBlocks replaces *StatefulSets* with *InstanceSet* which is a general workload API and is in charge of a set of instances. With *InstanceSet*, KubeBlocks introduces the *specified instance scaling* feature to improve the availability.

## Before you start

Expand Down
Loading
Loading