Skip to content

Commit a1cfc9f

Browse files
authored
chore: update kbcli docs (#580)
1 parent c52e7d1 commit a1cfc9f

13 files changed

Lines changed: 62 additions & 600 deletions

addons

Submodule addons updated 2202 files

docs/user_docs/cli/kbcli_addon_delete-resources-with-version.md renamed to docs/user_docs/cli/kbcli_addon_purge.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,34 @@
11
---
2-
title: kbcli addon delete-resources-with-version
2+
title: kbcli addon purge
33
---
44

5-
Delete the sub-resources of specified addon and versions
5+
Purge the sub-resources of specified addon and versions
66

77
```
8-
kbcli addon delete-resources-with-version [flags]
8+
kbcli addon purge [flags]
99
```
1010

1111
### Examples
1212

1313
```
14-
# Delete specific versions of redis addon resources
15-
kbcli addon delete-resources-with-version redis --versions=0.9.1,0.9.2
14+
# Purge specific versions of redis addon resources
15+
kbcli addon purge redis --versions=0.9.1,0.9.2
1616
17-
# Delete all unused and outdated resources of redis addon
18-
kbcli addon delete-resources-with-version redis --all-unused-versions=true
17+
# Purge all unused and outdated resources of redis addon
18+
kbcli addon purge redis --all
19+
20+
# Print the resources that would be purged, and no resource is actually purged
21+
kbcli addon purge redis --dry-run
1922
```
2023

2124
### Options
2225

2326
```
24-
--all-unused-versions If set to true, all the resources which are not currently used and not with the newest version will be deleted.
25-
-h, --help help for delete-resources-with-version
26-
--versions strings Specify the versions of resources to delete.
27+
--all If set to true, all resources will be purged, including those that are unused and not the newest version.
28+
--auto-approve Skip interactive approval before deleting
29+
--dry-run If set to true, only print the resources that would be purged, and no resource is actually purged.
30+
-h, --help help for purge
31+
--versions strings Specify the versions of resources to purge.
2732
```
2833

2934
### Options inherited from parent commands

docs/user_docs/cli/kbcli_cluster_create.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,12 @@ kbcli cluster create [ClusterType] [flags]
5959
* [kbcli cluster create kafka](kbcli_cluster_create_kafka.md) - Create a kafka cluster.
6060
* [kbcli cluster create mongodb](kbcli_cluster_create_mongodb.md) - Create a mongodb cluster.
6161
* [kbcli cluster create mysql](kbcli_cluster_create_mysql.md) - Create a mysql cluster.
62+
* [kbcli cluster create oriol](kbcli_cluster_create_oriol.md) - Create a oriol cluster.
6263
* [kbcli cluster create postgresql](kbcli_cluster_create_postgresql.md) - Create a postgresql cluster.
6364
* [kbcli cluster create qdrant](kbcli_cluster_create_qdrant.md) - Create a qdrant cluster.
6465
* [kbcli cluster create rabbitmq](kbcli_cluster_create_rabbitmq.md) - Create a rabbitmq cluster.
6566
* [kbcli cluster create redis](kbcli_cluster_create_redis.md) - Create a redis cluster.
67+
* [kbcli cluster create tidb](kbcli_cluster_create_tidb.md) - Create a tidb cluster.
6668

6769
#### Go Back to [CLI Overview](cli.md) Homepage.
6870

docs/user_docs/cli/kbcli_cluster_create_clickhouse.md

Lines changed: 0 additions & 86 deletions
This file was deleted.

docs/user_docs/cli/kbcli_cluster_create_kafak2.md renamed to docs/user_docs/cli/kbcli_cluster_create_oriol.md

Lines changed: 18 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,50 @@
11
---
2-
title: kbcli cluster create kafak2
2+
title: kbcli cluster create oriol
33
---
44

5-
Create a kafak2 cluster.
5+
Create a oriol cluster.
66

77
```
8-
kbcli cluster create kafak2 NAME [flags]
8+
kbcli cluster create oriol NAME [flags]
99
```
1010

1111
### Examples
1212

1313
```
1414
# Create a cluster with the default values
15-
kbcli cluster create kafak2
15+
kbcli cluster create oriol
1616
1717
# Create a cluster with the specified cpu, memory and storage
18-
kbcli cluster create kafak2 --cpu 1 --memory 2 --storage 10
18+
kbcli cluster create oriol --cpu 1 --memory 2 --storage 10
1919
```
2020

2121
### Options
2222

2323
```
24-
--broker-heap string Kafka broker's jvm heap setting. (default "-XshowSettings:vm -XX:MaxRAMPercentage=100 -Ddepth=64")
25-
--broker-replicas int The number of Kafka broker replicas for separated mode. Value range [1, 100]. (default 1)
26-
--controller-heap string Kafka controller's jvm heap setting for separated mode (default "-XshowSettings:vm -XX:MaxRAMPercentage=100 -Ddepth=64")
27-
--controller-replicas int The number of Kafka controller replicas for separated mode. Legal values [1, 3, 5]. (default 1)
24+
--availability-policy string The availability policy of cluster. Legal values [none, node, zone]. (default "node")
2825
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5)
29-
--disable-exporter Enable or disable monitor. (default true)
3026
--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")
3127
--edit Edit the API resource before creating
32-
-h, --help help for kafak2
28+
--etcd.cluster string The patroni dependency etcd cluster name (default "etcd")
29+
--etcd.namespace string The patroni dependency etcd cluster namespace (default "default")
30+
-h, --help help for oriol
31+
--host-network-accessible Specify whether the cluster can be accessed from within the VPC.
3332
--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)
33+
--mode string Legal values [standalone, replication]. (default "standalone")
34+
--monitor-enabled Enable or disable monitor.
3935
--node-labels stringToString Node label selector (default [])
40-
--node-port-enabled Whether NodePort service is enabled, default is false
4136
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
4237
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
38+
--publicly-accessible Specify whether the cluster can be accessed from the public internet.
4339
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
44-
--replicas int The number of Kafka broker replicas for combined mode. Legal values [1, 3, 5]. (default 1)
45-
--sasl-enable Enable authentication using SASL/PLAIN for Kafka.
46-
--storage float Data Storage size, the unit is Gi. Value range [1, 10000]. (default 10)
47-
--storage-class string The StorageClass for Kafka Data Storage.
48-
--storage-enable Enable storage for Kafka.
49-
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
40+
--replicas int Value range [1, 5]. (default 1)
41+
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
42+
--storage-class-name string Storage class name of the data volume
43+
--tenancy string The tenancy of cluster. Legal values [SharedNode, DedicatedNode]. (default "SharedNode")
5044
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
5145
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
5246
--topology-keys stringArray Topology keys for affinity
53-
--version string Cluster version. (default "kafka-3.3.2")
47+
--version string (default "orioledb-beta1")
5448
```
5549

5650
### Options inherited from parent commands

0 commit comments

Comments
 (0)