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
  •  
  •  
  •  
9 changes: 9 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,16 @@ BRANCH ?= main
.PHONY: sync-kbcli-docs
sync-kbcli-docs: ## Sync kbcli docs, call scripts/sync-kbcli-docs.sh
@./scripts/sync-kbcli-docs.sh $(BRANCH)

# sync KubeBlocks API reference docs
KUBEBLOCKS_API_DOCS_BRANCH ?= main
.PHONY: sync-api-docs
sync-api-docs: ## Sync KubeBlocks API reference docs
@./scripts/sync-kubeblocks-api-docs.sh $(KUBEBLOCKS_API_DOCS_BRANCH)
$(YARN) format-md-to-mdx
$(YARN) format-api-reference-docs



# spell check
SPELLCHECK_VERSION ?= 0.54.0
Expand Down
4 changes: 4 additions & 0 deletions docs/en/preview/cli/kbcli_cluster_create_kafka.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ kbcli cluster create kafka NAME [flags]
--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.
--sasl-scram-enable Enable authentication using SASL/SCRAM for Kafka.
--sasl.enable Enable SASL authentication.
--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")
--sasl.mechanisms stringArray Legal values [PLAIN, SCRAM-SHA-256, SCRAM-SHA-512].
--sasl.use-kb-build-in-sasl Whether to use the built-in SASL server callback handler. (default true)
--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.
Expand Down
1 change: 0 additions & 1 deletion docs/en/preview/cli/kbcli_cluster_create_mongodb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ kbcli cluster create mongodb NAME [flags]
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, 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 [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")
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/en/preview/cli/kbcli_cluster_create_mysql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ kbcli cluster create mysql NAME [flags]
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"'
--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")
--topology-keys stringArray Topology keys for affinity
--version string MySQL version Legal values [8.0.39, 8.0.38, 8.0.37, 8.0.36, 8.4.2, 8.4.1, 8.4.0, 5.7.44]. (default "8.0.39")
--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")
```

### Options inherited from parent commands
Expand Down
1 change: 1 addition & 0 deletions docs/en/preview/cli/kbcli_cluster_custom-ops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ kbcli cluster custom-ops OpsDef --cluster <clusterName> <your custom params> [fl
* [kbcli cluster custom-ops kafka-quota](kbcli_cluster_custom-ops_kafka-quota.md) - Create a custom ops with opsDef kafka-quota
* [kbcli cluster custom-ops kafka-topic](kbcli_cluster_custom-ops_kafka-topic.md) - Create a custom ops with opsDef kafka-topic
* [kbcli cluster custom-ops kafka-user-acl](kbcli_cluster_custom-ops_kafka-user-acl.md) - Create a custom ops with opsDef kafka-user-acl
* [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
* [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
* [kbcli cluster custom-ops redis-cluster-rebalance](kbcli_cluster_custom-ops_redis-cluster-rebalance.md) - Create a custom ops with opsDef redis-cluster-rebalance
* [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
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: kbcli cluster custom-ops mongodb-shard-toggle-balancer
---

Create a custom ops with opsDef mongodb-shard-toggle-balancer

```
kbcli cluster custom-ops mongodb-shard-toggle-balancer <ClusterName> [flags]
```

### Examples

```
# Create a mongodb-shard-toggle-balancer ops
kbcli cluster custom-ops mongodb-shard-toggle-balancer <clusterName> --component <componentName>
```

### Options

```
--auto-approve Skip interactive approval before promote the instance
--component string Specify the component name of the cluster. if not specified, using the first component which referenced the defined componentDefinition.
--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
--enable-balancer Enable or disable the balancer.
(default true)
--force skip the pre-checks of the opsRequest to run the opsRequest forcibly
-h, --help help for mongodb-shard-toggle-balancer
--name string OpsRequest name. if not specified, it will be randomly generated
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml)
--ttlSecondsAfterSucceed int Time to live after the OpsRequest succeed
```

### Options inherited from parent commands

```
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--as-uid string UID to impersonate for the operation.
--cache-dir string Default cache directory (default "$HOME/.kube/cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--disable-compression If true, opt-out of response compression for all requests to the server
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
--match-server-version Require server version to match client version
-n, --namespace string If present, the namespace scope for this CLI request
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
-s, --server string The address and port of the Kubernetes API server
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
```

### SEE ALSO

* [kbcli cluster custom-ops](kbcli_cluster_custom-ops.md) -

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

4 changes: 2 additions & 2 deletions docs/en/preview/kubeblocks-for-elasticsearch/01-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ KubeBlocks Elasticsearch Addon supports these Elasticsearch versions:
| Major Version | Supported Minor Versions |
|---------------|--------------------------------|
| 6.x | 6.8.23 |
| 7.x | 7.10.1,7.8.1,7.7.1 |
| 7.x | 7.10.2,7.10.1,7.8.1,7.7.1 |
| 8.x | 8.15.5,8.8.2,8.1.3 |


The list of supported versions can be found by following command:
```
```bash
kubectl get cmpv elasticsearch
```
20 changes: 14 additions & 6 deletions docs/en/preview/kubeblocks-for-elasticsearch/02-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ If the add-on isn't enabled, choose an installation method:
# Update helm repo
helm repo update
# Search available Add-on versions
helm search repo kubeblocks/elasticsearch --versions
helm search repo kubeblocks-addons/elasticsearch --versions
# Install your desired version (replace <VERSION> with your chosen version)
helm upgrade -i kb-addon-elasticsearch kubeblocks-addons/elasticsearch --version <VERSION> -n kb-system
```
Expand Down Expand Up @@ -110,7 +110,7 @@ Always verify that the Elasticsearch Add-on version matches your KubeBlocks majo

:::

## Deploy a Elasticsearch Cluster
## Deploy a Elasticsearch Single-Node Cluster

For development and testing purposes, you can deploy a single-node cluster where one node handles all roles.

Expand Down Expand Up @@ -159,9 +159,17 @@ spec:

For more API fields and descriptions, refer to the [API Reference](../user_docs/references/api-reference/cluster).


:::tip

More example manifests and setups for Elasticsearch, including multi-node clusters, custom configurations, and advanced scenarios, can be found in the [official KubeBlocks Add-ons Elasticsearch examples directory](https://github.com/apecloud/kubeblocks-addons/tree/main/examples/elasticsearch).

:::


## Verify Cluster Status

When deploying a Elasticsearch Cluster with 1 replicas:
When deploying a Elasticsearch Single-Node Cluster:

Confirm successful deployment by checking:

Expand Down Expand Up @@ -222,7 +230,7 @@ Show cluster events: kbcli cluster list-events -n demo es-singlenode
</Tabs>


## Stop the Elasticsearch Cluster
## Stop the Elasticsearch Single-Node Cluster

Stopping a cluster temporarily suspends operations while preserving all data and configuration:

Expand Down Expand Up @@ -261,7 +269,7 @@ Stopping a cluster temporarily suspends operations while preserving all data and
</TabItem>
</Tabs>

## Start the Elasticsearch Cluster
## Start the Elasticsearch Single-Node Cluster

Restarting a stopped cluster resumes operations with all data and configuration intact.

Expand Down Expand Up @@ -299,7 +307,7 @@ Restarting a stopped cluster resumes operations with all data and configuration
</Tabs>


## Delete Elasticsearch Cluster
## Delete Elasticsearch Single-Node Cluster

Choose carefully based on your data retention needs:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ There are five components in Milvus Cluster. To get the list of components,
kubectl get cluster -n demo es-multinode -oyaml | yq '.spec.componentSpecs[].name'
```

Expected Output:
Example Output:
```text
dit
master
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Verify the updated resources by inspecting the cluster configuration or Pod deta
kbcli cluster describe es-multinode -n demo
```

Expected Output:
Example Output:
```bash
Resources Allocation:
COMPONENT INSTANCE-TEMPLATE CPU(REQUEST/LIMIT) MEMORY(REQUEST/LIMIT) STORAGE-SIZE STORAGE-CLASS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ Verify the updated cluster configuration:
```bash
kbcli cluster describe es-multinode -n demo
```
Expected Output:
Example Output:
```bash
Resources Allocation:
COMPONENT INSTANCE-TEMPLATE CPU(REQUEST/LIMIT) MEMORY(REQUEST/LIMIT) STORAGE-SIZE STORAGE-CLASS
Expand All @@ -216,7 +216,7 @@ Confirm PVC resizing completion:
```bash
kubectl get pvc -l app.kubernetes.io/instance=es-multinode,apps.kubeblocks.io/component-name=data -n demo
```
Expected Output:
Example Output:
```bash
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS
data-es-multinode-data-0 Bound pvc-uuid 30Gi RWO <STORAGE_CLASS_NAME>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Check all components are running:
kubectl get pods -n monitoring
```

Expected Output:
Example Output:
```bash
NAME READY STATUS RESTARTS AGE
alertmanager-prometheus-kube-prometheus-alertmanager-0 2/2 Running 0 114s
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Monitor the cluster status until it transitions to the Running state:
kubectl get cluster es-multinode -n demo -w
```

Expected Output:
Example Output:

```bash
NAME CLUSTER-DEFINITION TERMINATION-POLICY STATUS AGE
Expand All @@ -17,7 +17,7 @@ Check the pod status and roles:
kubectl get pods -l app.kubernetes.io/instance=es-multinode -n demo
```

Expected Output:
Example Output:
```bash
NAME READY STATUS RESTARTS AGE
es-multinode-data-0 4/4 Running 0 6m21s
Expand Down
14 changes: 10 additions & 4 deletions docs/en/preview/kubeblocks-for-kafka/01-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,13 @@ KubeBlocks simplifies Kafka operations with comprehensive lifecycle management:

KubeBlocks Kafka Addon supports these Kafka versions:

| Major Version | Supported Minor Versions |
|---------------|--------------------------------|
| 3.x | 3.3.2 |
| 2.x | 2.7.0 |
| Major Version | Minor Versions |
|---------------|--------------------------------------|
| 3.x | 3.9.0, 3.8.1, 3.7.1, 3.3.2 |
| 2.x | 2.8.2, 2.7.0 |

The list of supported versions can be found by following command:

```bash
kubectl get cmpv kafka-broker
```
Loading