From da7be6fb3e5c23c0374f826e8763c8d9280ef800 Mon Sep 17 00:00:00 2001 From: Shanshan Date: Wed, 8 Jan 2025 09:50:51 +0800 Subject: [PATCH] chore: update user-docs fix some typos (#8759) Co-authored-by: wusai80 --- docs/03 - debug.md | 6 +++--- docs/04 - basics.md | 2 +- .../prepare-a-local-k8s-cluster.md | 2 +- .../cluster-management/scale-for-apecloud-mysql.md | 14 +++++++------- .../configuration/configuration.md | 2 +- .../proxy/apecloud-mysql-proxy.md | 4 ++-- .../manage-elasticsearch.md | 2 +- .../cluster-management/connect-to-a-cluster.md | 2 +- .../cluster-management/start-stop-a-cluster.md | 2 +- .../configuration/configuration.md | 2 +- .../create-and-connect-to-a-mongodb-cluster.md | 8 ++++---- .../cluster-management/start-stop-a-cluster.md | 2 +- .../cluster-management/switchover.md | 2 +- .../configuration/configuration.md | 2 +- .../configuration/configuration.md | 2 +- .../high-availability/high-availability.md | 2 +- .../configuration/configuration.md | 2 +- .../kubeblocks-for-rabbitmq/manage-rabbitmq.md | 2 +- .../scale-for-a-redis-cluster.md | 2 +- .../configuration/configuration.md | 2 +- .../backup-and-restore/backup/scheduled-backup.md | 2 +- .../cross-k8s-deployment/cross-k8s-deployment.md | 4 ++-- .../maintenance/in-place-update/overview.md | 2 +- .../maintenance/scale/horizontal-scale.md | 2 +- docs/user_docs/observability/monitor-database.md | 2 +- docs/user_docs/overview/concept.md | 2 +- docs/user_docs/overview/supported-addons.md | 4 ++-- 27 files changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/03 - debug.md b/docs/03 - debug.md index 12ed201fc6c..f6a1aca5795 100644 --- a/docs/03 - debug.md +++ b/docs/03 - debug.md @@ -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 : ```shell brew install delve ``` @@ -45,9 +45,9 @@ 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. +`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 diff --git a/docs/04 - basics.md b/docs/04 - basics.md index 2bc0ed96dd8..b9174e6f6dc 100644 --- a/docs/04 - basics.md +++ b/docs/04 - basics.md @@ -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. diff --git a/docs/user_docs/installation/prepare-a-local-k8s-cluster/prepare-a-local-k8s-cluster.md b/docs/user_docs/installation/prepare-a-local-k8s-cluster/prepare-a-local-k8s-cluster.md index 5c0193ce9b5..3982079a18e 100644 --- a/docs/user_docs/installation/prepare-a-local-k8s-cluster/prepare-a-local-k8s-cluster.md +++ b/docs/user_docs/installation/prepare-a-local-k8s-cluster/prepare-a-local-k8s-cluster.md @@ -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/). diff --git a/docs/user_docs/kubeblocks-for-apecloud-mysql/cluster-management/scale-for-apecloud-mysql.md b/docs/user_docs/kubeblocks-for-apecloud-mysql/cluster-management/scale-for-apecloud-mysql.md index ee4027552eb..77b841af057 100644 --- a/docs/user_docs/kubeblocks-for-apecloud-mysql/cluster-management/scale-for-apecloud-mysql.md +++ b/docs/user_docs/kubeblocks-for-apecloud-mysql/cluster-management/scale-for-apecloud-mysql.md @@ -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 @@ -99,7 +99,7 @@ mycluster demo apecloud-mysql ac-mysql-8.0.30 Delete ``` - + 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. @@ -242,7 +242,7 @@ mycluster demo apecloud-mysql ac-mysql-8.0.30 Delete type: HorizontalScaling horizontalScaling: - componentName: mysql - scaleOut: + scaleOut: replicaChanges: 2 EOF ``` @@ -263,7 +263,7 @@ mycluster demo apecloud-mysql ac-mysql-8.0.30 Delete type: HorizontalScaling horizontalScaling: - componentName: mysql - scaleIn: + scaleIn: replicaChanges: 2 EOF ``` @@ -286,7 +286,7 @@ mycluster demo apecloud-mysql ac-mysql-8.0.30 Delete ``` - + 1. Change the value of `spec.componentSpecs.replicas` in the YAML file. @@ -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 @@ -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 ``` diff --git a/docs/user_docs/kubeblocks-for-apecloud-mysql/configuration/configuration.md b/docs/user_docs/kubeblocks-for-apecloud-mysql/configuration/configuration.md index 24ef32ae3a4..7c77e44e9cd 100644 --- a/docs/user_docs/kubeblocks-for-apecloud-mysql/configuration/configuration.md +++ b/docs/user_docs/kubeblocks-for-apecloud-mysql/configuration/configuration.md @@ -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 diff --git a/docs/user_docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md b/docs/user_docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md index c8718764ce1..36bad44c317 100644 --- a/docs/user_docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md +++ b/docs/user_docs/kubeblocks-for-apecloud-mysql/proxy/apecloud-mysql-proxy.md @@ -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 @@ -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 diff --git a/docs/user_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md b/docs/user_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md index ad88ceb4706..76e21367993 100644 --- a/docs/user_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md +++ b/docs/user_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md @@ -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 diff --git a/docs/user_docs/kubeblocks-for-kafka/cluster-management/connect-to-a-cluster.md b/docs/user_docs/kubeblocks-for-kafka/cluster-management/connect-to-a-cluster.md index 4c00fc5b1bc..8ad7a9b902d 100644 --- a/docs/user_docs/kubeblocks-for-kafka/cluster-management/connect-to-a-cluster.md +++ b/docs/user_docs/kubeblocks-for-kafka/cluster-management/connect-to-a-cluster.md @@ -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. ::: diff --git a/docs/user_docs/kubeblocks-for-kafka/cluster-management/start-stop-a-cluster.md b/docs/user_docs/kubeblocks-for-kafka/cluster-management/start-stop-a-cluster.md index 6fdbac18d41..79e8d95a56a 100644 --- a/docs/user_docs/kubeblocks-for-kafka/cluster-management/start-stop-a-cluster.md +++ b/docs/user_docs/kubeblocks-for-kafka/cluster-management/start-stop-a-cluster.md @@ -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 --- diff --git a/docs/user_docs/kubeblocks-for-kafka/configuration/configuration.md b/docs/user_docs/kubeblocks-for-kafka/configuration/configuration.md index e9e28517149..c33908e8896 100644 --- a/docs/user_docs/kubeblocks-for-kafka/configuration/configuration.md +++ b/docs/user_docs/kubeblocks-for-kafka/configuration/configuration.md @@ -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 diff --git a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md index d85d6d3dcb5..29c06731598 100644 --- a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md +++ b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md @@ -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 --- @@ -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 ... @@ -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]. | @@ -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. diff --git a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/start-stop-a-cluster.md b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/start-stop-a-cluster.md index 7c735ecc1a3..c30247da8e3 100644 --- a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/start-stop-a-cluster.md +++ b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/start-stop-a-cluster.md @@ -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 --- diff --git a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/switchover.md b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/switchover.md index 43e73221174..2ba7c6dbcaf 100644 --- a/docs/user_docs/kubeblocks-for-mongodb/cluster-management/switchover.md +++ b/docs/user_docs/kubeblocks-for-mongodb/cluster-management/switchover.md @@ -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. diff --git a/docs/user_docs/kubeblocks-for-mongodb/configuration/configuration.md b/docs/user_docs/kubeblocks-for-mongodb/configuration/configuration.md index cbd2e97f34d..8dcd3a91bef 100644 --- a/docs/user_docs/kubeblocks-for-mongodb/configuration/configuration.md +++ b/docs/user_docs/kubeblocks-for-mongodb/configuration/configuration.md @@ -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 diff --git a/docs/user_docs/kubeblocks-for-mysql-community-edition/configuration/configuration.md b/docs/user_docs/kubeblocks-for-mysql-community-edition/configuration/configuration.md index 26078fb04f7..6b38f93d3d2 100644 --- a/docs/user_docs/kubeblocks-for-mysql-community-edition/configuration/configuration.md +++ b/docs/user_docs/kubeblocks-for-mysql-community-edition/configuration/configuration.md @@ -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 diff --git a/docs/user_docs/kubeblocks-for-postgresql/high-availability/high-availability.md b/docs/user_docs/kubeblocks-for-postgresql/high-availability/high-availability.md index 29e98079827..0e4b0608d54 100644 --- a/docs/user_docs/kubeblocks-for-postgresql/high-availability/high-availability.md +++ b/docs/user_docs/kubeblocks-for-postgresql/high-availability/high-availability.md @@ -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. diff --git a/docs/user_docs/kubeblocks-for-pulsar/configuration/configuration.md b/docs/user_docs/kubeblocks-for-pulsar/configuration/configuration.md index 4469c689f64..2fd4f779954 100644 --- a/docs/user_docs/kubeblocks-for-pulsar/configuration/configuration.md +++ b/docs/user_docs/kubeblocks-for-pulsar/configuration/configuration.md @@ -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 diff --git a/docs/user_docs/kubeblocks-for-rabbitmq/manage-rabbitmq.md b/docs/user_docs/kubeblocks-for-rabbitmq/manage-rabbitmq.md index 3c548d846f6..0956464291f 100644 --- a/docs/user_docs/kubeblocks-for-rabbitmq/manage-rabbitmq.md +++ b/docs/user_docs/kubeblocks-for-rabbitmq/manage-rabbitmq.md @@ -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. | diff --git a/docs/user_docs/kubeblocks-for-redis/cluster-management/scale-for-a-redis-cluster.md b/docs/user_docs/kubeblocks-for-redis/cluster-management/scale-for-a-redis-cluster.md index d8ec6923d0d..abdc215ead1 100644 --- a/docs/user_docs/kubeblocks-for-redis/cluster-management/scale-for-a-redis-cluster.md +++ b/docs/user_docs/kubeblocks-for-redis/cluster-management/scale-for-a-redis-cluster.md @@ -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. ::: diff --git a/docs/user_docs/kubeblocks-for-redis/configuration/configuration.md b/docs/user_docs/kubeblocks-for-redis/configuration/configuration.md index 3041a1e0bfb..bdf4ba961ff 100644 --- a/docs/user_docs/kubeblocks-for-redis/configuration/configuration.md +++ b/docs/user_docs/kubeblocks-for-redis/configuration/configuration.md @@ -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 diff --git a/docs/user_docs/maintenance/backup-and-restore/backup/scheduled-backup.md b/docs/user_docs/maintenance/backup-and-restore/backup/scheduled-backup.md index 8ce4201609c..1576008744e 100644 --- a/docs/user_docs/maintenance/backup-and-restore/backup/scheduled-backup.md +++ b/docs/user_docs/maintenance/backup-and-restore/backup/scheduled-backup.md @@ -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. diff --git a/docs/user_docs/maintenance/cross-k8s-deployment/cross-k8s-deployment.md b/docs/user_docs/maintenance/cross-k8s-deployment/cross-k8s-deployment.md index b70a0c489dd..c8b5278cff3 100644 --- a/docs/user_docs/maintenance/cross-k8s-deployment/cross-k8s-deployment.md +++ b/docs/user_docs/maintenance/cross-k8s-deployment/cross-k8s-deployment.md @@ -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 @@ -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 diff --git a/docs/user_docs/maintenance/in-place-update/overview.md b/docs/user_docs/maintenance/in-place-update/overview.md index e7edf369d37..c15577a4acd 100644 --- a/docs/user_docs/maintenance/in-place-update/overview.md +++ b/docs/user_docs/maintenance/in-place-update/overview.md @@ -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: diff --git a/docs/user_docs/maintenance/scale/horizontal-scale.md b/docs/user_docs/maintenance/scale/horizontal-scale.md index 18fad5297a8..50165923b9d 100644 --- a/docs/user_docs/maintenance/scale/horizontal-scale.md +++ b/docs/user_docs/maintenance/scale/horizontal-scale.md @@ -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 diff --git a/docs/user_docs/observability/monitor-database.md b/docs/user_docs/observability/monitor-database.md index 22c21eae63c..c9134e39b81 100644 --- a/docs/user_docs/observability/monitor-database.md +++ b/docs/user_docs/observability/monitor-database.md @@ -14,7 +14,7 @@ This tutorial demonstrates how to configure the monitoring function for a Postgr ## Step 1. Install Prometheus Operator and Grafana -Install the Promethus Operator and Grafana to monitor the performance of a database. Skip this step if a Prometheus Operator is already installed in your environment. +Install the Prometheus Operator and Grafana to monitor the performance of a database. Skip this step if a Prometheus Operator is already installed in your environment. 1. Create a new namespace for Prometheus Operator. diff --git a/docs/user_docs/overview/concept.md b/docs/user_docs/overview/concept.md index dad9b7694a9..13791cb5c78 100644 --- a/docs/user_docs/overview/concept.md +++ b/docs/user_docs/overview/concept.md @@ -104,7 +104,7 @@ Although users do not need to write CRs for ClusterDefinition and ComponentDefin #### Cluster A Cluster object represents an entire database cluster managed by KubeBlocks. A Cluster can include multiple Components. Users specify the configuration for each Component here, and the Cluster Controller will generate and reconcile corresponding Component objects. Additionally, the Cluster Controller manages all Service addresses that are exposed at the Cluster level. -For distributed databases with a sharded-nothing architecture, like Redis Cluster, the Cluster supports managing multiple shards, with each shard managed by a separate Component. This architecture also supports dynamic resharding: if you need to scale out and add a new shard, you simply add a new Component; conversely, if you need to scale in and reduce the number of shards, you remove a Component. +For distributed databases with a shared-nothing architecture, like Redis Cluster, the Cluster supports managing multiple shards, with each shard managed by a separate Component. This architecture also supports dynamic resharding: if you need to scale out and add a new shard, you simply add a new Component; conversely, if you need to scale in and reduce the number of shards, you remove a Component. #### Component Component is a fundamental building block of a Cluster object. For example, a Redis Cluster can include Components like `redis`, `sentinel`, and potentially a proxy like `twemproxy`. diff --git a/docs/user_docs/overview/supported-addons.md b/docs/user_docs/overview/supported-addons.md index 3df59dab8e0..95acd57f15f 100644 --- a/docs/user_docs/overview/supported-addons.md +++ b/docs/user_docs/overview/supported-addons.md @@ -49,7 +49,7 @@ The versions listed below may not be up-to-date, and some supported versions mig | postgresql | This addon provides PostgreSQL services using the Spilo image with Patroni for high availability (HA). | | apecloud-postgresql | ApeCloud PostgreSQL is a free, fully compatible drop-in replacement for PostgreSQL, offering enhanced high availability through a RAFT protocol replication plugin. | | vanilla-postgresql | This Addon is based on the vanilla PostgreSQL, providing high availability capabilities for native PostgreSQL and its variants. | -| oriolebd | OrioleDB is a new storage engine for PostgreSQL, bringing a modern approach to database capacity, capabilities and performance to the world's most-loved database platform. | +| orioledb | OrioleDB is a new storage engine for PostgreSQL, bringing a modern approach to database capacity, capabilities and performance to the world's most-loved database platform. | | neon | Neon is Serverless Postgres. | **Supported Features** @@ -143,7 +143,7 @@ The versions listed below may not be up-to-date, and some supported versions mig | Addon (v0.9.0) | Supported Versions | Vscale | Hscale | Volumeexpand | Stop/Start | Restart | Expose | Backup/Restore | Logs | Config | Upgrade (DB engine version) | Account | Failover | Switchover | |:-------------------:|:---------------------------------------------------------:|:----------------:|:----------------:|:------------:|:----------------:|:----------------:|:------:|:--------------:|:----:|:------:|:---------------------------:|:-------:|:--------:|:----------:| | kafka |

kafka-broker-3.3.2

kafka-combine-3.3.2

kafka-controller-3.3.2

kafka-exporter-1.6.0

| ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | ✔️ | N/A | N/A | N/A | N/A | -| rabbitmq |

3.13.2

3.12.14

3.11.28

3.10.25

3.9.29

3.8.14

| ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | Managed by the RabitMQ Management system. | ✔️ | ✔️ | +| rabbitmq |

3.13.2

3.12.14

3.11.28

3.10.25

3.9.29

3.8.14

| ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | N/A | Managed by the RabbitMQ Management system. | ✔️ | ✔️ | | pulsar |

pulsar-bkrecovery-2.11.2

pulsar-bkrecovery-3.0.2

pulsar-bookkeeper-2.11.2

pulsar-bookkeeper-3.0.2

pulsar-broker-2.11.2

pulsar-broker-3.0.2

pulsar-proxy-2.11.2

pulsar-proxy-3.0.2

pulsar-zookeeper-2.11.2

pulsar-zookeeper-3.0.2

| ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | N/A | N/A | N/A | ✔️ | N/A | N/A | N/A | N/A | ## Vector Databases