Skip to content

Commit

Permalink
docs: fix bugs
Browse files Browse the repository at this point in the history
  • Loading branch information
michelle-0808 committed Nov 14, 2024
1 parent ab303ec commit c18ee22
Show file tree
Hide file tree
Showing 44 changed files with 1,028 additions and 1,039 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';

# Stop/Start an ApeCloud MySQL cluster

You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. You can start this cluster again by snapshots if you want to restore the cluster resources.
You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. You can start this cluster again to restore it to the state it was in before it was stopped.

## Stop a cluster

Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/kubeblocks-for-milvus/manage-milvus.md
Original file line number Diff line number Diff line change
Expand Up @@ -733,7 +733,7 @@ mycluster milvus-2.3.2 Delete R
## Stop/Start a cluster
You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. You can start this cluster again by snapshots if you want to restore the cluster resources.
You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. You can start this cluster again to restore it to the state it was in before it was stopped.
### Stop a cluster
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,36 +133,34 @@ KubeBlocks supports creating two types of MongoDB clusters: Standalone and Repli
apiVersion: apps.kubeblocks.io/v1alpha1
kind: Cluster
metadata:
annotations:
finalizers:
- cluster.kubeblocks.io/finalizer
labels:
app.kubernetes.io/instance: mycluster
app.kubernetes.io/managed-by: Helm
app.kubernetes.io/version: 5.0.14
helm.sh/chart: mongodb-cluster-0.9.1
name: mycluster
namespace: demo
spec:
clusterDefinitionRef: mongodb
clusterVersionRef: mongodb-6.0
terminationPolicy: Delete
affinity:
podAntiAffinity: Preferred
tenancy: SharedNode
topologyKeys:
- kubernetes.io/hostname
tolerations:
- key: kb-data
operator: Equal
value: 'true'
effect: NoSchedule
componentSpecs:
- name: mongodb
componentDefRef: mongodb
enabledLogs:
- running
disableExporter: true
serviceAccountName: kb-mongo-cluster
replicas: 1
- componentDef: mongodb
name: mongodb
replicas: 3
resources:
limits:
cpu: '0.5'
cpu: "0.5"
memory: 0.5Gi
requests:
cpu: '0.5'
cpu: "0.5"
memory: 0.5Gi
serviceVersion: 6.0.16
volumeClaimTemplates:
- name: data
spec:
Expand All @@ -171,13 +169,12 @@ KubeBlocks supports creating two types of MongoDB clusters: Standalone and Repli
resources:
requests:
storage: 20Gi
terminationPolicy: Delete
EOF
```
| Field | Definition |
|---------------------------------------|--------------------------------------|
| `spec.clusterDefinitionRef` | It specifies the name of the ClusterDefinition for creating a specific type of cluster. |
| `spec.clusterVersionRef` | It is the name of the cluster version CRD that defines the cluster version. |
| `spec.terminationPolicy` | It is the policy of cluster termination. The default value is `Delete`. Valid values are `DoNotTerminate`, `Delete`, `WipeOut`. For the detailed definition, you can refer to [Termination Policy](./delete-mongodb-cluster.md#termination-policy). |
| `spec.affinity` | It defines a set of node affinity scheduling rules for the cluster's Pods. This field helps control the placement of Pods on nodes within the cluster. |
| `spec.affinity.podAntiAffinity` | It specifies the anti-affinity level of Pods within a component. It determines how pods should spread across nodes to improve availability and performance. |
Expand All @@ -186,7 +183,6 @@ KubeBlocks supports creating two types of MongoDB clusters: Standalone and Repli
| `spec.componentSpecs` | It is the list of components that define the cluster components. This field allows customized configuration of each component within a cluster. |
| `spec.componentSpecs.componentDefRef` | It is the name of the component definition that is defined in the cluster definition and you can get the component definition names with `kubectl get clusterdefinition mongodb -o json \| jq '.spec.componentDefs[].name'`. |
| `spec.componentSpecs.name` | It specifies the name of the component. |
| `spec.componentSpecs.disableExporter` | It defines whether the monitoring function is enabled. |
| `spec.componentSpecs.replicas` | It specifies the number of replicas of the component. |
| `spec.componentSpecs.resources` | It specifies the resource requirements of the component. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';

# Stop/Start a MongoDB Cluster

You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. Start this cluster again if you want to restore the cluster resources from the original storage by snapshots.
You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. You can start this cluster again to restore it to the state it was in before it was stopped.

## Stop a cluster

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';

# Stop/Start a MySQL cluster

You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. You can start this cluster again by snapshots if you want to restore the cluster resources.
You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. You can start this cluster again to restore it to the state it was in before it was stopped.

## Stop a cluster

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';

# Stop/Start PostgreSQL Cluster

You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. Start this cluster again if you want to restore the cluster resources from the original storage by snapshots.
You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. You can start this cluster again to restore it to the state it was in before it was stopped.

## Stop a cluster

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';

# Stop/Start a Redis Cluster

You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. Start this cluster again if you want to restore the cluster resources from the original storage by snapshots.
You can stop/start a cluster to save computing resources. When a cluster is stopped, the computing resources of this cluster are released, which means the pods of Kubernetes are released, but the storage resources are reserved. You can start this cluster again to restore it to the state it was in before it was stopped.

## Stop a cluster

Expand Down
Loading

0 comments on commit c18ee22

Please sign in to comment.