Skip to content

Commit 0687263

Browse files
wangyeleiwangyelei
committed
chore: tidy up doc
1 parent 0c414a4 commit 0687263

9 files changed

Lines changed: 72 additions & 38 deletions

‎docs/user_docs/cli/kbcli_cluster_create.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,24 @@ kbcli cluster create [ClusterType] [flags]
5555

5656
* [kbcli cluster](kbcli_cluster.md) - Cluster command.
5757
* [kbcli cluster create apecloud-mysql](kbcli_cluster_create_apecloud-mysql.md) - Create a apecloud-mysql cluster.
58+
* [kbcli cluster create clickhouse](kbcli_cluster_create_clickhouse.md) - Create a clickhouse cluster.
5859
* [kbcli cluster create etcd](kbcli_cluster_create_etcd.md) - Create a etcd cluster.
60+
* [kbcli cluster create greptime](kbcli_cluster_create_greptime.md) - Create a greptime cluster.
5961
* [kbcli cluster create kafka](kbcli_cluster_create_kafka.md) - Create a kafka cluster.
62+
* [kbcli cluster create loki](kbcli_cluster_create_loki.md) - Create a loki cluster.
63+
* [kbcli cluster create milvus](kbcli_cluster_create_milvus.md) - Create a milvus cluster.
64+
* [kbcli cluster create minio](kbcli_cluster_create_minio.md) - Create a minio cluster.
6065
* [kbcli cluster create mongodb](kbcli_cluster_create_mongodb.md) - Create a mongodb cluster.
6166
* [kbcli cluster create mysql](kbcli_cluster_create_mysql.md) - Create a mysql cluster.
67+
* [kbcli cluster create oceanbase](kbcli_cluster_create_oceanbase.md) - Create a oceanbase cluster.
68+
* [kbcli cluster create orchestrator](kbcli_cluster_create_orchestrator.md) - Create a orchestrator cluster.
69+
* [kbcli cluster create polardbx](kbcli_cluster_create_polardbx.md) - Create a polardbx cluster.
6270
* [kbcli cluster create postgresql](kbcli_cluster_create_postgresql.md) - Create a postgresql cluster.
71+
* [kbcli cluster create pulsar](kbcli_cluster_create_pulsar.md) - Create a pulsar cluster.
6372
* [kbcli cluster create qdrant](kbcli_cluster_create_qdrant.md) - Create a qdrant cluster.
6473
* [kbcli cluster create rabbitmq](kbcli_cluster_create_rabbitmq.md) - Create a rabbitmq cluster.
6574
* [kbcli cluster create redis](kbcli_cluster_create_redis.md) - Create a redis cluster.
75+
* [kbcli cluster create victoria-metrics](kbcli_cluster_create_victoria-metrics.md) - Create a victoria-metrics cluster.
6676

6777
#### Go Back to [CLI Overview](cli.md) Homepage.
6878

‎docs/user_docs/cli/kbcli_cluster_create_apecloud-mysql.md‎

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -21,37 +21,29 @@ kbcli cluster create apecloud-mysql NAME [flags]
2121
### Options
2222

2323
```
24-
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5)
25-
--disable-exporter Enable or disable monitor. (default true)
26-
--dry-run string[="unchanged"] Must be "client", or "server". If with client strategy, only print the object that would be sent, and no data is actually sent. If with server strategy, submit the server-side request, but no data is persistent. (default "none")
27-
--edit Edit the API resource before creating
28-
--etcd.local.etcdctl-api string (default "3")
29-
--etcd.local.replicas int Value range [1, 3]. (default 3)
30-
--etcd.local.resources.storage string (default "20Gi")
31-
--etcd.local.service-version string (default "3.5.6")
32-
--etcd.mode string Legal values [serviceRef, local]. (default "local")
33-
--etcd.service-ref.cluster.component string (default "etcd")
34-
--etcd.service-ref.cluster.credential string
35-
--etcd.service-ref.cluster.name string
36-
--etcd.service-ref.cluster.port string (default "client")
37-
--etcd.service-ref.cluster.service string (default "headless")
38-
--etcd.service-ref.namespace string (default "default")
39-
--etcd.service-ref.service-descriptor string
40-
-h, --help help for apecloud-mysql
41-
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
42-
--mode string Cluster topology mode. Legal values [standalone, raftGroup]. (default "standalone")
43-
--node-labels stringToString Node label selector (default [])
44-
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
45-
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
46-
--proxy-enabled Enable proxy or not.
47-
--replicas int The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3. Value range [1, 5]. (default 1)
48-
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
49-
--storage-class-name string Storage class name of the data volume
50-
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
51-
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Delete, WipeOut]. (default "Delete")
52-
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
53-
--topology-keys stringArray Topology keys for affinity
54-
--version string MySQL Service Version. (default "8.0.30")
24+
--availability-policy string The availability policy of cluster. Legal values [none, node, zone]. (default "node")
25+
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5)
26+
--disable-exporter Enable or disable monitor. (default true)
27+
--dry-run string[="unchanged"] Must be "client", or "server". If with client strategy, only print the object that would be sent, and no data is actually sent. If with server strategy, submit the server-side request, but no data is persistent. (default "none")
28+
--edit Edit the API resource before creating
29+
-h, --help help for apecloud-mysql
30+
--host-network-accessible Specify whether the cluster can be accessed from within the VPC.
31+
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
32+
--mode string Cluster topology mode. Legal values [standalone, raftGroup]. (default "standalone")
33+
--node-labels stringToString Node label selector (default [])
34+
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
35+
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
36+
--proxy-enabled Enable proxy or not.
37+
--publicly-accessible Specify whether the cluster can be accessed from the public internet.
38+
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
39+
--replicas int The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3. Value range [1, 5]. (default 1)
40+
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
41+
--storage-class-name string Storage class name of the data volume
42+
--tenancy string The tenancy of cluster. Legal values [SharedNode, DedicatedNode]. (default "SharedNode")
43+
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
44+
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
45+
--topology-keys stringArray Topology keys for affinity
46+
--version string Cluster version. (default "ac-mysql-8.0.30")
5547
```
5648

5749
### Options inherited from parent commands

‎docs/user_docs/cli/kbcli_cluster_create_kafka.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ kbcli cluster create kafka NAME [flags]
4848
--replicas int The number of Kafka broker replicas for combined mode. Legal values [1, 3, 5]. (default 1)
4949
--sasl-enable Enable authentication using SASL/PLAIN for Kafka.
5050
--sasl-scram-enable Enable authentication using SASL/SCRAM for Kafka.
51+
--sasl.enable Enable SASL authentication.
52+
--sasl.inter-broker-protocol string SASL mechanism used for inter-broker communication. Should be one of sasl.mechanisms. Legal values [PLAIN, SCRAM-SHA-256, SCRAM-SHA-512]. (default "PLAIN")
53+
--sasl.mechanisms stringArray Legal values [PLAIN, SCRAM-SHA-256, SCRAM-SHA-512].
54+
--sasl.use-kb-build-in-sasl Whether to use the built-in SASL server callback handler. (default true)
5155
--storage float Data Storage size, the unit is Gi. Value range [1, 10000]. (default 10)
5256
--storage-class string The StorageClass for Kafka Data Storage.
5357
--storage-enable Enable storage for Kafka.

‎docs/user_docs/cli/kbcli_cluster_create_mongodb.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ kbcli cluster create mongodb NAME [flags]
4040
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Delete, WipeOut]. (default "Delete")
4141
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
4242
--topology-keys stringArray Topology keys for affinity
43-
--version string Cluster version. Legal values [8.0.8, 7.0.18, 6.0.21, 5.0.29, 4.4.29, 4.2.25, 4.0.28]. (default "6.0.21")
4443
```
4544

4645
### Options inherited from parent commands

‎docs/user_docs/cli/kbcli_cluster_create_mysql.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ kbcli cluster create mysql NAME [flags]
4343
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
4444
--topology string Topology type of the serve. Note that under the orc/orc-proxysql topology, it is necessary to specify the Orchestrator cluster information. You should choose either orchestrator.cluster-service-selector or orchestrator.service-reference. This means that depending on your setup, you will configure one of these options to properly integrate with the Orchestrator service for managing your MySQL cluster. Legal values [semisync, semisync-proxysql, mgr, mgr-proxysql, orc, orc-proxysql]. (default "semisync")
4545
--topology-keys stringArray Topology keys for affinity
46-
--version string MySQL version Legal values [8.0.39, 8.0.38, 8.0.37, 8.0.36, 8.4.7, 8.4.3, 8.4.2, 8.4.1, 8.4.0, 5.7.44]. (default "8.0.39")
46+
--version string MySQL version Legal values [8.0.44, 8.0.41, 8.0.39, 8.0.38, 8.0.37, 8.0.36, 8.4.7, 8.4.3, 8.4.2, 8.4.1, 8.4.0, 5.7.44]. (default "8.0.39")
4747
```
4848

4949
### Options inherited from parent commands

‎docs/user_docs/cli/kbcli_cluster_create_rabbitmq.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ kbcli cluster create rabbitmq NAME [flags]
3131
--node-labels stringToString Node label selector (default [])
3232
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
3333
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
34-
--replicas int The number of replicas, for standalone mode, the replicas is 1, for replicaset mode, the default replicas is 3. Value range [1, 5]. (default 1)
34+
--replicas int The number of replicas, for standalone mode, the replicas is 1, for replicaset mode, the default replicas is 3. Value range [1, 5]. (default 3)
3535
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
3636
--storage-class-name string Storage class name of the data volume
3737
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
3838
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Delete, WipeOut]. (default "Delete")
3939
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
4040
--topology-keys stringArray Topology keys for affinity
41-
--version string Cluster version. Legal values [4.0.9, 3.13.7, 3.13.2, 3.12.14, 3.11.28, 3.10.25, 3.9.29, 3.8.14]. (default "3.13.7")
41+
--version string Cluster version. Legal values [4.2.1, 4.1.6, 4.0.9, 3.13.7, 3.12.14, 3.11.28, 3.10.25, 3.9.29, 3.8.34]. (default "3.13.7")
4242
```
4343

4444
### Options inherited from parent commands

‎docs/user_docs/cli/kbcli_cluster_custom-ops.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,35 @@ kbcli cluster custom-ops OpsDef --cluster <clusterName> <your custom params> [fl
5757
### SEE ALSO
5858

5959
* [kbcli cluster](kbcli_cluster.md) - Cluster command.
60+
* [kbcli cluster custom-ops add-arch-for-dm](kbcli_cluster_custom-ops_add-arch-for-dm.md) - Create a custom ops with opsDef add-arch-for-dm
61+
* [kbcli cluster custom-ops hdfs-balancer](kbcli_cluster_custom-ops_hdfs-balancer.md) - Create a custom ops with opsDef hdfs-balancer
62+
* [kbcli cluster custom-ops hive-server2-apply-account](kbcli_cluster_custom-ops_hive-server2-apply-account.md) - Create a custom ops with opsDef hive-server2-apply-account
63+
* [kbcli cluster custom-ops kafka-quota](kbcli_cluster_custom-ops_kafka-quota.md) - Create a custom ops with opsDef kafka-quota
64+
* [kbcli cluster custom-ops kafka-topic](kbcli_cluster_custom-ops_kafka-topic.md) - Create a custom ops with opsDef kafka-topic
65+
* [kbcli cluster custom-ops kafka-user-acl](kbcli_cluster_custom-ops_kafka-user-acl.md) - Create a custom ops with opsDef kafka-user-acl
66+
* [kbcli cluster custom-ops mongodb-shard-toggle-balancer](kbcli_cluster_custom-ops_mongodb-shard-toggle-balancer.md) - Create a custom ops with opsDef mongodb-shard-toggle-balancer
67+
* [kbcli cluster custom-ops mssql-dynamic-modify-member](kbcli_cluster_custom-ops_mssql-dynamic-modify-member.md) - Create a custom ops with opsDef mssql-dynamic-modify-member
68+
* [kbcli cluster custom-ops mssql-dynamic-modify-member-1.0.0](kbcli_cluster_custom-ops_mssql-dynamic-modify-member-1.0.0.md) - Create a custom ops with opsDef mssql-dynamic-modify-member-1.0.0
69+
* [kbcli cluster custom-ops mssql-dynamic-remove-ag](kbcli_cluster_custom-ops_mssql-dynamic-remove-ag.md) - Create a custom ops with opsDef mssql-dynamic-remove-ag
70+
* [kbcli cluster custom-ops mssql-dynamic-remove-ag-1.0.0](kbcli_cluster_custom-ops_mssql-dynamic-remove-ag-1.0.0.md) - Create a custom ops with opsDef mssql-dynamic-remove-ag-1.0.0
71+
* [kbcli cluster custom-ops mssql-dynamic-remove-member](kbcli_cluster_custom-ops_mssql-dynamic-remove-member.md) - Create a custom ops with opsDef mssql-dynamic-remove-member
72+
* [kbcli cluster custom-ops mssql-dynamic-remove-member-1.0.0](kbcli_cluster_custom-ops_mssql-dynamic-remove-member-1.0.0.md) - Create a custom ops with opsDef mssql-dynamic-remove-member-1.0.0
73+
* [kbcli cluster custom-ops nebula-balance-data](kbcli_cluster_custom-ops_nebula-balance-data.md) - Create a custom ops with opsDef nebula-balance-data
74+
* [kbcli cluster custom-ops ob-alter-unit](kbcli_cluster_custom-ops_ob-alter-unit.md) - Create a custom ops with opsDef ob-alter-unit
75+
* [kbcli cluster custom-ops ob-switch-configserver](kbcli_cluster_custom-ops_ob-switch-configserver.md) - Create a custom ops with opsDef ob-switch-configserver
76+
* [kbcli cluster custom-ops pg-update-standby-config](kbcli_cluster_custom-ops_pg-update-standby-config.md) - Create a custom ops with opsDef pg-update-standby-config
77+
* [kbcli cluster custom-ops post-rebuild-for-clickhouse](kbcli_cluster_custom-ops_post-rebuild-for-clickhouse.md) - Create a custom ops with opsDef post-rebuild-for-clickhouse
78+
* [kbcli cluster custom-ops post-scale-for-dmdb](kbcli_cluster_custom-ops_post-scale-for-dmdb.md) - Create a custom ops with opsDef post-scale-for-dmdb
79+
* [kbcli cluster custom-ops post-scale-out-shard-for-clickhouse](kbcli_cluster_custom-ops_post-scale-out-shard-for-clickhouse.md) - Create a custom ops with opsDef post-scale-out-shard-for-clickhouse
80+
* [kbcli cluster custom-ops redis-cluster-rebalance](kbcli_cluster_custom-ops_redis-cluster-rebalance.md) - Create a custom ops with opsDef redis-cluster-rebalance
81+
* [kbcli cluster custom-ops redis-master-account-ops](kbcli_cluster_custom-ops_redis-master-account-ops.md) - Create a custom ops with opsDef redis-master-account-ops
82+
* [kbcli cluster custom-ops redis-reset-master](kbcli_cluster_custom-ops_redis-reset-master.md) - Create a custom ops with opsDef redis-reset-master
83+
* [kbcli cluster custom-ops redis-sentinel-account-ops](kbcli_cluster_custom-ops_redis-sentinel-account-ops.md) - Create a custom ops with opsDef redis-sentinel-account-ops
84+
* [kbcli cluster custom-ops redis-shard-account-ops](kbcli_cluster_custom-ops_redis-shard-account-ops.md) - Create a custom ops with opsDef redis-shard-account-ops
85+
* [kbcli cluster custom-ops remove-remote-arch](kbcli_cluster_custom-ops_remove-remote-arch.md) - Create a custom ops with opsDef remove-remote-arch
86+
* [kbcli cluster custom-ops switchover-for-dm](kbcli_cluster_custom-ops_switchover-for-dm.md) - Create a custom ops with opsDef switchover-for-dm
87+
* [kbcli cluster custom-ops update-license-for-dm](kbcli_cluster_custom-ops_update-license-for-dm.md) - Create a custom ops with opsDef update-license-for-dm
88+
* [kbcli cluster custom-ops update-license-for-kingbase](kbcli_cluster_custom-ops_update-license-for-kingbase.md) - Create a custom ops with opsDef update-license-for-kingbase
6089

6190
#### Go Back to [CLI Overview](cli.md) Homepage.
6291

‎go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ require (
126126
github.com/charmbracelet/x/term v0.2.0 // indirect
127127
github.com/chzyer/readline v1.5.1 // indirect
128128
github.com/clbanning/mxj/v2 v2.5.7 // indirect
129-
github.com/cloudflare/circl v1.3.7 // indirect
129+
github.com/cloudflare/circl v1.6.1 // indirect
130130
github.com/cncf/xds/go v0.0.0-20250501225837-2ac532fd4443 // indirect
131131
github.com/cockroachdb/apd/v3 v3.2.1 // indirect
132132
github.com/containerd/cgroups/v3 v3.0.3 // indirect

‎go.sum‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -798,8 +798,8 @@ github.com/clbanning/mxj/v2 v2.5.7/go.mod h1:hNiWqW14h+kc+MdF9C6/YoRfjEJoR3ou6tn
798798
github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
799799
github.com/cloudflare/cfssl v0.0.0-20180223231731-4e2dcbde5004 h1:lkAMpLVBDaj17e85keuznYcH5rqI438v41pKcBl4ZxQ=
800800
github.com/cloudflare/cfssl v0.0.0-20180223231731-4e2dcbde5004/go.mod h1:yMWuSON2oQp+43nFtAV/uvKQIFpSPerB57DCt9t8sSA=
801-
github.com/cloudflare/circl v1.3.7 h1:qlCDlTPz2n9fu58M0Nh1J/JzcFpfgkFHHX3O35r5vcU=
802-
github.com/cloudflare/circl v1.3.7/go.mod h1:sRTcRWXGLrKw6yIGJ+l7amYJFfAXbZG0kBSc8r4zxgA=
801+
github.com/cloudflare/circl v1.6.1 h1:zqIqSPIndyBh1bjLVVDHMPpVKqp8Su/V+6MeDzzQBQ0=
802+
github.com/cloudflare/circl v1.6.1/go.mod h1:uddAzsPgqdMAYatqJ0lsjX1oECcQLIlRpzZh3pJrofs=
803803
github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
804804
github.com/cncf/udpa/go v0.0.0-20200629203442-efcf912fb354/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=
805805
github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=

0 commit comments

Comments
 (0)