Skip to content

Commit 1ff66c5

Browse files
committed
chore: auto update cli doc changes
1 parent 3d909fc commit 1ff66c5

5 files changed

Lines changed: 36 additions & 33 deletions

docs/user_docs/cli/kbcli_cluster_create_elasticsearch.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ kbcli cluster create elasticsearch NAME [flags]
2424
--availability-policy string The availability policy of cluster. Legal values [none, node, zone]. (default "node")
2525
--cpu float CPU cores. Value range [0.5, 64]. (default 1)
2626
--disable-exporter Enable or disable monitor. (default true)
27+
--enable-kibana Whether to enable the Kibana
2728
-h, --help help for elasticsearch
2829
--host-network-accessible Specify whether the cluster can be accessed from within the VPC.
2930
--memory float Memory, the unit is Gi. Value range [1, 1000]. (default 2)

docs/user_docs/cli/kbcli_cluster_create_kafka.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,33 @@ kbcli cluster create kafka NAME [flags]
2121
### Options
2222

2323
```
24-
--availability-policy string The availability policy of cluster. Legal values [none, node, zone]. (default "node")
25-
--broker-heap string Kafka broker's jvm heap setting. (default "-XshowSettings:vm -XX:MaxRAMPercentage=100 -Ddepth=64")
26-
--broker-replicas int The number of Kafka broker replicas for separated mode. Value range [1, 100]. (default 1)
27-
--controller-heap string Kafka controller's jvm heap setting for separated mode (default "-XshowSettings:vm -XX:MaxRAMPercentage=100 -Ddepth=64")
28-
--controller-replicas int The number of Kafka controller replicas for separated mode. Legal values [1, 3, 5]. (default 1)
29-
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5)
30-
--disable-exporter Enable or disable monitor. (default true)
31-
-h, --help help for kafka
32-
--host-network-accessible Specify whether the cluster can be accessed from within the VPC.
33-
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
34-
--meta-storage float Metadata Storage size, the unit is Gi. Value range [1, 10000]. (default 5)
35-
--meta-storage-class string The StorageClass for Kafka Metadata Storage.
36-
--mode string Mode for Kafka kraft cluster, 'combined' is combined Kafka controller and broker,'separated' is broker and controller running independently. Legal values [combined, separated]. (default "combined")
37-
--monitor-enable Enable monitor for Kafka. (default true)
38-
--monitor-replicas int The number of Kafka monitor replicas. Value range [1, 5]. (default 1)
39-
--node-port-enabled Whether NodePort service is enabled, default is false
40-
--publicly-accessible Specify whether the cluster can be accessed from the public internet.
41-
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
42-
--replicas int The number of Kafka broker replicas for combined mode. Legal values [1, 3, 5]. (default 1)
43-
--sasl-enable Enable authentication using SASL/PLAIN for Kafka.
44-
--storage float Data Storage size, the unit is Gi. Value range [1, 10000]. (default 10)
45-
--storage-class string The StorageClass for Kafka Data Storage.
46-
--storage-enable Enable storage for Kafka.
47-
--tenancy string The tenancy of cluster. Legal values [SharedNode, DedicatedNode]. (default "SharedNode")
48-
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
49-
--version string Cluster version. (default "kafka-3.3.2")
24+
--availability-policy string The availability policy of cluster. Legal values [none, node, zone]. (default "node")
25+
--broker-heap string Kafka broker's jvm heap setting. (default "-XshowSettings:vm -XX:MaxRAMPercentage=100 -Ddepth=64")
26+
--broker-replicas int The number of Kafka broker replicas for separated mode. Value range [1, 100]. (default 1)
27+
--controller-heap string Kafka controller's jvm heap setting for separated mode (default "-XshowSettings:vm -XX:MaxRAMPercentage=100 -Ddepth=64")
28+
--controller-replicas int The number of Kafka controller replicas for separated mode. Legal values [1, 3, 5]. (default 1)
29+
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5)
30+
--disable-exporter Enable or disable monitor. (default true)
31+
--fixed-pod-ip-enabled advertised.listeners Whether to enable fixed Pod IP mode in Kafka's advertised.listeners
32+
-h, --help help for kafka
33+
--host-network-accessible Specify whether the cluster can be accessed from within the VPC.
34+
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
35+
--meta-storage float Metadata Storage size, the unit is Gi. Value range [1, 10000]. (default 5)
36+
--meta-storage-class string The StorageClass for Kafka Metadata Storage.
37+
--mode string Mode for Kafka kraft cluster, 'combined' is combined Kafka controller and broker,'separated' is broker and controller running independently. Legal values [combined, separated, withZookeeper]. (default "combined")
38+
--monitor-enable Enable monitor for Kafka. (default true)
39+
--monitor-replicas int The number of Kafka monitor replicas. Value range [1, 5]. (default 1)
40+
--node-port-enabled Whether NodePort service is enabled, default is false
41+
--publicly-accessible Specify whether the cluster can be accessed from the public internet.
42+
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
43+
--replicas int The number of Kafka broker replicas for combined mode. Legal values [1, 3, 5]. (default 1)
44+
--sasl-enable Enable authentication using SASL/PLAIN for Kafka.
45+
--storage float Data Storage size, the unit is Gi. Value range [1, 10000]. (default 10)
46+
--storage-class string The StorageClass for Kafka Data Storage.
47+
--storage-enable Enable storage for Kafka.
48+
--tenancy string The tenancy of cluster. Legal values [SharedNode, DedicatedNode]. (default "SharedNode")
49+
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
50+
--version string Cluster version. (default "kafka-3.3.2")
5051
```
5152

5253
### Options inherited from parent commands

docs/user_docs/cli/kbcli_cluster_create_mongodb.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,16 @@ kbcli cluster create mongodb NAME [flags]
2727
-h, --help help for mongodb
2828
--host-network-accessible Specify whether the cluster can be accessed from within the VPC.
2929
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
30-
--mode string Cluster topology mode. Legal values [standalone, replicaset]. (default "standalone")
30+
--mode string Cluster topology mode. Legal values [standalone, replicaset, sharding]. (default "standalone")
3131
--publicly-accessible Specify whether the cluster can be accessed from the public internet.
3232
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
3333
--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+
--shards int The number of shards, for sharding mode, the default shards is 3. Value range [2, 128]. (default 3)
3435
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
3536
--storage-class-name string Storage class name of the data volume
3637
--tenancy string The tenancy of cluster. Legal values [SharedNode, DedicatedNode]. (default "SharedNode")
3738
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
38-
--version string Cluster version. Legal values [8.0.4, 7.0.16, 7.0.12, 6.0.20, 6.0.16, 5.0.30, 5.0.28, 4.4.29, 4.2.24, 4.0.28]. (default "6.0.16")
39+
--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")
3940
```
4041

4142
### Options inherited from parent commands

docs/user_docs/cli/kbcli_cluster_create_postgresql.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ kbcli cluster create postgresql NAME [flags]
2222

2323
```
2424
--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)
25+
--cpu float CPU cores. Value range [0.5, 256]. (default 0.5)
2626
--disable-exporter Enable or disable monitor. (default true)
2727
-h, --help help for postgresql
2828
--host-network-accessible Specify whether the cluster can be accessed from within the VPC.
2929
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
30-
--mode string Cluster topology mode. Legal values [standalone, replication]. (default "standalone")
30+
--mode string Cluster topology mode. Legal values [standalone, replication, standby]. (default "standalone")
3131
--publicly-accessible Specify whether the cluster can be accessed from the public internet.
3232
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
3333
--replicas int The number of replicas, for standalone mode, the replicas is 1, for replication mode, the default replicas is 2. Value range [1, 5]. (default 1)

docs/user_docs/cli/kbcli_cluster_create_redis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,14 @@ kbcli cluster create redis NAME [flags]
2222

2323
```
2424
--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)
25+
--cpu float CPU cores. Value range [0.5, 256]. (default 0.5)
2626
--custom-secret-name string the secret must contain keys named 'username' and 'password'
2727
--custom-secret-namespace string the secret must contain keys named 'username' and 'password'
2828
--disable-exporter Enable or disable monitor. (default true)
2929
--fixed-pod-ip-enabled Whether Fixed Pod IP is enabled, default is false
3030
-h, --help help for redis
3131
--host-network-accessible Specify whether the cluster can be accessed from within the VPC.
32+
--load-balancer-enabled Whether LoadBalancer service is enabled, default is false
3233
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
3334
--mode string Cluster topology mode. Legal values [standalone, replication, cluster, replication-twemproxy]. (default "replication")
3435
--node-port-enabled Whether NodePort service is enabled, default is false
@@ -46,7 +47,6 @@ kbcli cluster create redis NAME [flags]
4647
--sentinel.memory float Sentinel component memory, the unit is Gi. Value range [0.1, 4]. (default 0.2)
4748
--sentinel.replicas float Sentinel component replicas Value range [1, 5]. (default 3)
4849
--sentinel.storage float Sentinel component storage size, the unit is Gi. Value range [1, 1024]. (default 20)
49-
--sentinel.storage-class-name string Sentinel component storage class name
5050
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
5151
--storage-class-name string Storage class name of the data volume
5252
--tenancy string The tenancy of cluster. Legal values [SharedNode, DedicatedNode]. (default "SharedNode")
@@ -56,7 +56,7 @@ kbcli cluster create redis NAME [flags]
5656
--twemproxy.memory float twemproxy component memory, the unit is Gi. Value range [0.1, 4]. (default 0.2)
5757
--twemproxy.replicas float twemproxy component replicas Value range [1, 5]. (default 3)
5858
--use-legacy-comp-def if useLegacyCompDef is false ,cluster will be rendered by compDef rather than componentDefRef in cluster definition
59-
--version string Cluster version. (default "7.2.7")
59+
--version string Cluster version. (default "redis-7.0.6")
6060
```
6161

6262
### Options inherited from parent commands

0 commit comments

Comments
 (0)