Skip to content

Commit

Permalink
docs: fix bugs
Browse files Browse the repository at this point in the history
  • Loading branch information
@michelle-0808
michelle-0808 committed Jan 6, 2025
1 parent dccaf07 commit 82ceb61
Show file tree
Hide file tree
Showing 20 changed files with 162 additions and 352 deletions.
15 changes: 12 additions & 3 deletions ...ecloud-mysql/cluster-management/create-and-connect-an-apecloud-mysql-cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,16 +197,25 @@ KubeBlocks supports creating two types of ApeCloud MySQL clusters: Standalone an
Create a Standalone.

```bash
kbcli cluster create apecloud-mysql mycluster --set mode='standalone' --namespace demo
kbcli cluster create apecloud-mysql mycluster --mode='standalone' --namespace demo
```

Create a RaftGroup Cluster.

```bash
kbcli cluster create apecloud-mysql mycluster --set mode='raftGroup' --namespace demo
kbcli cluster create apecloud-mysql mycluster --mode='raftGroup' --namespace demo
```

If you only have one node for deploying a RaftGroup Cluster, you can configure the cluster affinity by setting `--pod-anti-afffinity`, `--tolerations`, and `--topology-keys` when creating a RaftGroup Cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability.
If you only have one node for deploying a RaftGroup Cluster, you can configure the cluster affinity by setting `--pod-anti-affinity`, `--tolerations`, and `--topology-keys` when creating a RaftGroup Cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability. For example,

```bash
kbcli cluster create apecloud-mysql mycluster \
--mode='raftGroup' \
--pod-anti-affinity='Preferred' \
--tolerations='node-role.kubeblocks.io/data-plane:NoSchedule' \
--topology-keys='null' \
--namespace demo
```

2. Verify whether this cluster is created successfully.

Expand Down
10 changes: 9 additions & 1 deletion docs/user_docs/kubeblocks-for-elasticsearch/manage-elasticsearch.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,15 @@ kubectl get cluster mycluster -n demo -o yaml
kbcli cluster create elasticsearch -h
```

If you only have one node for deploying a cluster with multiple nodes, you can configure the cluster affinity by setting `--pod-anti-afffinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability.
If you only have one node for deploying a cluster with multiple nodes and replicas, you can configure the cluster affinity by setting `--pod-anti-affinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability. For example,

```bash
kbcli cluster create elasticsearch mycluster \
--pod-anti-affinity='Preferred' \
--tolerations='node-role.kubeblocks.io/data-plane:NoSchedule' \
--topology-keys='null' \
--namespace demo
```

2. Check whether the cluster is created.

Expand Down
16 changes: 13 additions & 3 deletions docs/user_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ This document shows how to create a Kafka cluster.
| 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-kafka-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 must be `kafaka` to create a Kafka Cluster. |
| `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 must be `kafka` to create a Kafka Cluster. |
| `spec.topology` | It specifies the name of the ClusterTopology to be used when creating the Cluster. Valid options are: [combined,combined_monitor,separated,separated_monitor]. |
| `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.replicas` | It specifies the amount of replicas of the component. |
Expand All @@ -239,7 +239,7 @@ This document shows how to create a Kafka cluster.

1. Create a Kafka cluster.

The cluster creation command is simply `kbcli cluster create`. Further, you can customize your cluster resources as demanded by using the `--set` flag.
The cluster creation command is simply `kbcli cluster create`.

```bash
kbcli cluster create kafka mycluster -n demo
Expand All @@ -253,7 +253,17 @@ This document shows how to create a Kafka cluster.
kbcli cluster create kafka -h
```

If you only have one node for deploying a cluster with multiple replicas, you can configure the cluster affinity by setting `--pod-anti-afffinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability.
If you only have one node for deploying a cluster with multiple replicas, you can configure the cluster affinity by setting `--pod-anti-affinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability. For example,

```bash
kbcli cluster create kafka mycluster \
--mode='combined' \
--replicas=3 \
--pod-anti-affinity='Preferred' \
--tolerations='node-role.kubeblocks.io/data-plane:NoSchedule' \
--topology-keys='null' \
--namespace demo
```

2. Verify whether this cluster is created successfully.

Expand Down
92 changes: 0 additions & 92 deletions docs/user_docs/kubeblocks-for-milvus/manage-milvus.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,8 @@ This tutorial illustrates how to create and manage a Milvus cluster by `kbcli`,

## Create a cluster

<Tabs>

<TabItem value="kubectl" label="kubectl" default>

KubeBlocks implements a `Cluster` CRD to define a cluster. Here is an example of creating a Milvus cluster. If you only have one node for deploying a cluster with multiple replicas, configure the cluster affinity by setting `spec.schedulingPolicy` or `spec.componentSpecs.schedulingPolicy`. For details, you can refer to the [API docs](https://kubeblocks.io/docs/preview/developer_docs/api-reference/cluster#apps.kubeblocks.io/v1.SchedulingPolicy). But for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability.


```yaml
cat <<EOF | kubectl apply -f -
apiVersion: apps.kubeblocks.io/v1
Expand Down Expand Up @@ -290,93 +285,6 @@ Run the following command to see the created Milvus cluster object:
kubectl get cluster mycluster -n demo -o yaml
```

</TabItem>

<TabItem value="kbcli" label="kbcli">

***Steps***

1. Execute the following command to create a Milvus cluster.

```bash
kbcli cluster create mycluster --cluster-definition=milvus-2.3.2 -n demo
```

If you want to customize your cluster specifications, `kbcli` provides various options, such as setting cluster version, termination policy, CPU, and memory. You can view these options by adding `--help` or `-h` flag.

```bash
kbcli cluster create milvus --help

kbcli cluster create milvus -h
```

If you only have one node for deploying a cluster with multiple replicas, you can configure the cluster affinity by setting `--pod-anti-afffinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability.

2. Check whether the cluster is created successfully.

```bash
kbcli cluster list -n demo
>
NAME NAMESPACE CLUSTER-DEFINITION VERSION TERMINATION-POLICY STATUS CREATED-TIME
mycluster demo milvus-2.3.2 Delete Running Jul 05,2024 17:35 UTC+0800
```

3. Check the cluster information.

```bash
kbcli cluster describe mycluster -n demo
>
Name: milvus Created Time: Jul 05,2024 17:35 UTC+0800
NAMESPACE CLUSTER-DEFINITION VERSION STATUS TERMINATION-POLICY
demo milvus-2.3.2 Running Delete

Endpoints:
COMPONENT MODE INTERNAL EXTERNAL
milvus ReadWrite milvus-milvus.default.svc.cluster.local:19530 <none>
minio ReadWrite milvus-minio.default.svc.cluster.local:9000 <none>
proxy ReadWrite milvus-proxy.default.svc.cluster.local:19530 <none>
milvus-proxy.default.svc.cluster.local:9091

Topology:
COMPONENT INSTANCE ROLE STATUS AZ NODE CREATED-TIME
etcd milvus-etcd-0 <none> Running <none> <none> Jul 05,2024 17:35 UTC+0800
minio milvus-minio-0 <none> Running <none> <none> Jul 05,2024 17:35 UTC+0800
milvus milvus-milvus-0 <none> Running <none> <none> Jul 05,2024 17:35 UTC+0800
indexnode milvus-indexnode-0 <none> Running <none> <none> Jul 05,2024 17:35 UTC+0800
mixcoord milvus-mixcoord-0 <none> Running <none> <none> Jul 05,2024 17:35 UTC+0800
querynode milvus-querynode-0 <none> Running <none> <none> Jul 05,2024 17:35 UTC+0800
datanode milvus-datanode-0 <none> Running <none> <none> Jul 05,2024 17:35 UTC+0800
proxy milvus-proxy-0 <none> Running <none> <none> Jul 05,2024 17:35 UTC+0800

Resources Allocation:
COMPONENT DEDICATED CPU(REQUEST/LIMIT) MEMORY(REQUEST/LIMIT) STORAGE-SIZE STORAGE-CLASS
milvus false 1 / 1 1Gi / 1Gi data:20Gi csi-hostpath-sc
etcd false 1 / 1 1Gi / 1Gi data:20Gi csi-hostpath-sc
minio false 1 / 1 1Gi / 1Gi data:20Gi csi-hostpath-sc
proxy false 1 / 1 1Gi / 1Gi data:20Gi csi-hostpath-sc
mixcoord false 1 / 1 1Gi / 1Gi data:20Gi csi-hostpath-sc
datanode false 1 / 1 1Gi / 1Gi data:20Gi csi-hostpath-sc
indexnode false 1 / 1 1Gi / 1Gi data:20Gi csi-hostpath-sc
querynode false 1 / 1 1Gi / 1Gi data:20Gi csi-hostpath-sc

Images:
COMPONENT TYPE IMAGE
milvus milvus milvusdb/milvus:v2.3.2
etcd etcd docker.io/milvusdb/etcd:3.5.5-r2
minio minio docker.io/minio/minio:RELEASE.2022-03-17T06-34-49Z
proxy proxy milvusdb/milvus:v2.3.2
mixcoord mixcoord milvusdb/milvus:v2.3.2
datanode datanode milvusdb/milvus:v2.3.2
indexnode indexnode milvusdb/milvus:v2.3.2
querynode querynode milvusdb/milvus:v2.3.2

Show cluster events: kbcli cluster list-events -n demo milvus
```

</TabItem>

</Tabs>

## Scale

Currently, KubeBlocks supports vertically scaling a Milvus cluster.
Expand Down
11 changes: 10 additions & 1 deletion ...locks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,16 @@ KubeBlocks supports creating two types of MongoDB clusters: Standalone and Repli
kbcli cluster create mongodb -h
```

If you only have one node for deploying a cluster with multiple replicas, you can configure the cluster affinity by setting `--pod-anti-afffinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability.
If you only have one node for deploying a cluster with multiple replicas, you can configure the cluster affinity by setting `--pod-anti-affinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability. For example,

```bash
kbcli cluster create mongodb mycluster \
--mode='replicaset' \
--pod-anti-affinity='Preferred' \
--tolerations='node-role.kubeblocks.io/data-plane:NoSchedule' \
--topology-keys='null' \
--namespace demo
```

2. Verify whether this cluster is created successfully.

Expand Down
11 changes: 10 additions & 1 deletion ...ysql-community-edition/cluster-management/create-and-connect-a-mysql-cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,16 @@ KubeBlocks supports creating two types of MySQL clusters: Standalone and Replica
kbcli cluster create mysql -h
```

If you only have one node for deploying a Replication Cluster, you can configure the cluster affinity by setting `--pod-anti-afffinity`, `--tolerations`, and `--topology-keys` when creating a Replication Cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability.
If you only have one node for deploying a Replication Cluster, you can configure the cluster affinity by setting `--pod-anti-affinity`, `--tolerations`, and `--topology-keys` when creating a Replication Cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability. For example,

```bash
kbcli cluster create mysql mycluster \
--mode='replication' \
--pod-anti-affinity='Preferred' \
--tolerations='node-role.kubeblocks.io/data-plane:NoSchedule' \
--topology-keys='null' \
--namespace demo
```

2. Verify whether this cluster is created successfully.

Expand Down
11 changes: 7 additions & 4 deletions ...ks-for-postgresql/cluster-management/create-and-connect-a-postgresql-cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -205,14 +205,17 @@ KubeBlocks supports creating two types of PostgreSQL clusters: Standalone and Re
kbcli cluster create postgresql -h
```

For example, you can create a Replication Cluster with the `--replicas` flag.
If you only have one node for deploying a Replication Cluster, you can configure the cluster affinity by setting `--pod-anti-affinity`, `--tolerations`, and `--topology-keys` when creating a Replication Cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability. For example,

```bash
kbcli cluster create postgresql mycluster --replicas=2 -n demo
kbcli cluster create postgresql mycluster \
--mode='replication' \
--pod-anti-affinity='Preferred' \
--tolerations='node-role.kubeblocks.io/data-plane:NoSchedule' \
--topology-keys='null' \
--namespace demo
```

If you only have one node for deploying a RaftGroup Cluster, you can configure the cluster affinity by setting `--pod-anti-afffinity`, `--tolerations`, and `--topology-keys` when creating a Replication Cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability.

2. Verify whether this cluster is created successfully.

```bash
Expand Down
11 changes: 10 additions & 1 deletion docs/user_docs/kubeblocks-for-qdrant/manage-qdrant.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,16 @@ kubectl get cluster mycluster -n demo -o yaml
kbcli cluster create qdrant -h
```

If you only have one node for deploying a cluster with multiple replicas, you can configure the cluster affinity by setting `--pod-anti-afffinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability.
If you only have one node for deploying a cluster with multiple replicas, you can configure the cluster affinity by setting `--pod-anti-affinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability. For example,

```bash
kbcli cluster create qdrant mycluster \
--replicas=3
--pod-anti-affinity='Preferred' \
--tolerations='node-role.kubeblocks.io/data-plane:NoSchedule' \
--topology-keys='null' \
--namespace demo
```

2. Check whether the cluster is created.

Expand Down
10 changes: 9 additions & 1 deletion ...s/kubeblocks-for-redis/cluster-management/create-and-connect-a-redis-cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,15 @@ kubectl get cluster mycluster -n demo -o yaml
kbcli cluster create redis -h
```

If you only have one node for deploying a cluster with multiple replicas, you can configure the cluster affinity by setting `--pod-anti-afffinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability.
If you only have one node for deploying a cluster with multiple replicas, you can configure the cluster affinity by setting `--pod-anti-affinity`, `--tolerations`, and `--topology-keys` when creating a cluster. But you should note that for a production environment, it is not recommended to deploy all replicas on one node, which may decrease the cluster availability. For example,

```bash
kbcli cluster create redis mycluster \
--pod-anti-affinity='Preferred' \
--tolerations='node-role.kubeblocks.io/data-plane:NoSchedule' \
--topology-keys='null' \
--namespace demo
```

2. Verify whether this cluster is created successfully.

Expand Down
Loading

0 comments on commit 82ceb61

Please sign in to comment.