docs: update kbcli cluster create, yaml, and monitoring docs in release-1.0 #8729
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
michelle-0808
commented
Dec 30, 2024
michelle-0808
commented
- Updated the kbcli cluster create cli command examples
- Updated the creating cluster yaml examples
- Added ApeCloud MySQL, MySQL, PostgreSQL, Redis examples for creating PodMonitor
- Deleted "enabledLogs" field in the monitoring docs. The "enabledLogs" field in other docs will be deleted in the future.
...blocks-for-apecloud-mysql/cluster-management/create-and-connect-an-apecloud-mysql-cluster.md
Outdated
Show resolved
Hide resolved
docs/user_docs/kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md
Outdated
Show resolved
Hide resolved
| @@ -107,69 +107,77 @@ KubeBlocks supports creating two types of Redis clusters: Standalone and Replica | |||
|
|
|||
| <TabItem value="kubectl" label="kubectl" default> | |||
|
|
|||
| KubeBlocks implements a `Cluster` CRD to define a cluster. Here is an example of creating a Standalone. | |||
| KubeBlocks implements a `Cluster` CRD to define a cluster. Here is an example of creating a Replcation. KubeBlocks also supports creating a Redis cluster in other modes. You can refer to the examples provided in the [GitHub repository](https://github.com/apecloud/kubeblocks-addons/tree/main/examples/redis). | |||
There was a problem hiding this comment.
Replication here refers to ?
| @@ -135,8 +135,6 @@ spec: | |||
| componentSpecs: | |||
| - name: postgresql | |||
| componentDefRef: postgresql | |||
There was a problem hiding this comment.
componentDefRef is deprecated since v1.0. pls check.
There was a problem hiding this comment.
componentDefRef --> componentDef
zjx20
reviewed
Jan 3, 2025
| ```bash | ||
| kbcli cluster create mycluster --cluster-definition apecloud-mysql --set replicas=3 --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 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. |
| | `spec.componentSpecs.replicas` | It specifies the number of replicas of the component. | | ||
| | `spec.componentSpecs.resources` | It specifies the resource requirements of the component. | | ||
| | `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. | |
zjx20
approved these changes
Jan 6, 2025
shanshanying
approved these changes
Jan 7, 2025
shanshanying
approved these changes
Jan 7, 2025
michelle-0808
deleted the
support/update-kbcli-cluster-create-and-monitoring-docs-1.0
branch
|
/cherry-pick release-1.0-beta |
|
🤖 says: cherry pick action finished successfully 🎉! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.