Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion addons
Submodule addons updated 1018 files
2 changes: 1 addition & 1 deletion cmd/cli/main.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright (C) 2022-2024 ApeCloud Co., Ltd
Copyright (C) 2022-2025 ApeCloud Co., Ltd

This file is part of KubeBlocks project

Expand Down
2 changes: 1 addition & 1 deletion docker/docker.mk
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
#Copyright (C) 2022-2024 ApeCloud Co., Ltd
#Copyright (C) 2022-2025 ApeCloud Co., Ltd
#
#This file is part of KubeBlocks project
#
Expand Down
51 changes: 31 additions & 20 deletions docs/user_docs/cli/kbcli_cluster_create_apecloud-mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,37 @@ kbcli cluster create apecloud-mysql NAME [flags]
### Options

```
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5)
--disable-exporter Enable or disable monitor. (default true)
--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")
--edit Edit the API resource before creating
-h, --help help for apecloud-mysql
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
--mode string Cluster topology mode. Legal values [standalone, raftGroup]. (default "standalone")
--node-labels stringToString Node label selector (default [])
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
--proxy-enabled Enable proxy or not.
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
--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)
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
--storage-class-name string Storage class name of the data volume
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
--topology-keys stringArray Topology keys for affinity
--version string Cluster version. (default "ac-mysql-8.0.30")
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5)
--disable-exporter Enable or disable monitor. (default true)
--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")
--edit Edit the API resource before creating
--etcd.local.etcdctl-api string (default "3")
--etcd.local.replicas int Value range [1, 3]. (default 3)
--etcd.local.resources.storage string (default "20Gi")
--etcd.local.service-version string (default "3.5.6")
--etcd.mode string Legal values [serviceRef, local]. (default "local")
--etcd.service-ref.cluster.component string (default "etcd")
--etcd.service-ref.cluster.credential string
--etcd.service-ref.cluster.name string
--etcd.service-ref.cluster.port string (default "client")
--etcd.service-ref.cluster.service string (default "headless")
--etcd.service-ref.namespace string (default "default")
--etcd.service-ref.service-descriptor string
-h, --help help for apecloud-mysql
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
--mode string Cluster topology mode. Legal values [standalone, raftGroup]. (default "standalone")
--node-labels stringToString Node label selector (default [])
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
--proxy-enabled Enable proxy or not.
--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)
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
--storage-class-name string Storage class name of the data volume
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
--topology-keys stringArray Topology keys for affinity
--version string MySQL Service Version. (default "8.0.30")
```

### Options inherited from parent commands
Expand Down
1 change: 0 additions & 1 deletion docs/user_docs/cli/kbcli_cluster_create_elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ kbcli cluster create elasticsearch NAME [flags]
--node-labels stringToString Node label selector (default [])
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
--replicas int The number of replicas, for single-node mode, the replicas is 1, for multi-node mode, the default replicas is 3. Value range [1, 5]. (default 1)
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
Expand Down
3 changes: 2 additions & 1 deletion docs/user_docs/cli/kbcli_cluster_create_etcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ kbcli cluster create etcd NAME [flags]
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
--node-labels stringToString Node label selector (default [])
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
--peer-service.enabled Enable peer service (no need to enable for single cluster).
--peer-service.type string Service type for etcd peers, default peer service for single cluster use headless ClusterIP. Valid option is LoadBalancer, will support NodePort in the future. Legal values [ClusterIP, LoadBalancer]. (default "LoadBalancer")
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
--replicas int The number of replicas, the default replicas is 3. Value range [1, 5]. (default 3)
--storage float Data Storage size, the unit is Gi. Value range [1, 10000]. (default 10)
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
Expand Down
64 changes: 34 additions & 30 deletions docs/user_docs/cli/kbcli_cluster_create_kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,36 +21,40 @@ kbcli cluster create kafka NAME [flags]
### Options

```
--broker-heap string Kafka broker's jvm heap setting. (default "-XshowSettings:vm -XX:MaxRAMPercentage=100 -Ddepth=64")
--broker-replicas int The number of Kafka broker replicas for separated mode. Value range [1, 100]. (default 1)
--controller-heap string Kafka controller's jvm heap setting for separated mode (default "-XshowSettings:vm -XX:MaxRAMPercentage=100 -Ddepth=64")
--controller-replicas int The number of Kafka controller replicas for separated mode. Legal values [1, 3, 5]. (default 1)
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5)
--disable-exporter Enable or disable monitor. (default true)
--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")
--edit Edit the API resource before creating
-h, --help help for kafka
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
--meta-storage float Metadata Storage size, the unit is Gi. Value range [1, 10000]. (default 5)
--meta-storage-class string The StorageClass for Kafka Metadata Storage.
--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")
--monitor-enable Enable monitor for Kafka. (default true)
--monitor-replicas int The number of Kafka monitor replicas. Value range [1, 5]. (default 1)
--node-labels stringToString Node label selector (default [])
--node-port-enabled Whether NodePort service is enabled, default is false
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
--replicas int The number of Kafka broker replicas for combined mode. Legal values [1, 3, 5]. (default 1)
--sasl-enable Enable authentication using SASL/PLAIN for Kafka.
--storage float Data Storage size, the unit is Gi. Value range [1, 10000]. (default 10)
--storage-class string The StorageClass for Kafka Data Storage.
--storage-enable Enable storage for Kafka.
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
--topology-keys stringArray Topology keys for affinity
--version string Cluster version. (default "kafka-3.3.2")
--broker-heap string Kafka broker's jvm heap setting. (default "-XshowSettings:vm -XX:MaxRAMPercentage=100 -Ddepth=64")
--broker-replicas int The number of Kafka broker replicas for separated mode. Value range [1, 100]. (default 1)
--controller-heap string Kafka controller's jvm heap setting for separated mode (default "-XshowSettings:vm -XX:MaxRAMPercentage=100 -Ddepth=64")
--controller-replicas int The number of Kafka controller replicas for separated mode. Legal values [1, 3, 5]. (default 1)
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5)
--disable-exporter Enable or disable monitor. (default true)
--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")
--edit Edit the API resource before creating
--fixed-pod-ip-enabled advertised.listeners Whether to enable fixed Pod IP mode in Kafka's advertised.listeners
-h, --help help for kafka
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
--meta-storage float Metadata Storage size, the unit is Gi. Value range [1, 10000]. (default 5)
--meta-storage-class string The StorageClass for Kafka Metadata Storage.
--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")
--monitor-enable Enable monitor for Kafka. (default true)
--monitor.limit.cpu float (default 0.5)
--monitor.limit.memory float (default 1)
--monitor.replicas int Number of replicas for the monitor component. Value range [1]. (default 1)
--monitor.request.cpu float (default 0.1)
--monitor.request.memory float (default 0.2)
--node-labels stringToString Node label selector (default [])
--node-port-enabled advertised.listeners Whether to enable NodePort mode in Kafka's advertised.listeners
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
--replicas int The number of Kafka broker replicas for combined mode. Legal values [1, 3, 5]. (default 1)
--sasl-enable Enable authentication using SASL/PLAIN for Kafka.
--storage float Data Storage size, the unit is Gi. Value range [1, 10000]. (default 10)
--storage-class string The StorageClass for Kafka Data Storage.
--storage-enable Enable storage for Kafka.
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
--topology-keys stringArray Topology keys for affinity
--version string Cluster version. (default "3.3.2")
```

### Options inherited from parent commands
Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/cli/kbcli_cluster_create_mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,20 @@ kbcli cluster create mongodb NAME [flags]
--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")
--edit Edit the API resource before creating
-h, --help help for mongodb
--hostnetwork string Legal values [enabled, disabled]. (default "enabled")
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5)
--mode string Cluster topology mode. Legal values [standalone, replicaset]. (default "standalone")
--node-labels stringToString Node label selector (default [])
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred")
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources.
--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)
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20)
--storage-class-name string Storage class name of the data volume
--tenancy string Tenancy options, one of: (SharedNode, DedicatedNode) (default "SharedNode")
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete")
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
--topology-keys stringArray Topology keys for affinity
--version string Cluster version. Legal values [7.0.12, 6.0.16, 5.0.28, 4.4.29, 4.2.24, 4.0.28]. (default "6.0.16")
--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")
```

### Options inherited from parent commands
Expand Down
Loading
Loading