Skip to content

Commit

Permalink
docs: fix conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
TalktoCrystal authored and michelle-0808 committed Dec 21, 2023
1 parent cc70f78 commit 0df2a94
Show file tree
Hide file tree
Showing 10 changed files with 85 additions and 64 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ KubeBlocks is kubernetes-native, you can use Helm to install it.
:::note

If you install KubeBlocks with Helm, to uninstall it, you have to use Helm too.

Make sure you have [kubectl](https://kubernetes.io/docs/tasks/tools/) and [Helm](https://helm.sh/docs/intro/install/) installed.
:::


Expand Down Expand Up @@ -46,39 +46,58 @@ If you install KubeBlocks with Helm, to uninstall it, you have to use Helm too.
</table>

## Installation steps

**Use Helm to install KubeBlocks**

Run the following command:

```bash
helm repo add kubeblocks https://apecloud.github.io/helm-charts
helm repo update
helm install kubeblocks kubeblocks/kubeblocks \
--namespace kb-system --create-namespace
````
```

If you want to install KubeBlocks with custom tolerations, you can use the following command:

```bash
helm install kubeblocks kubeblocks/kubeblocks \
--namespace kb-system --create-namespace \
--set-json 'tolerations=[ { "key": "control-plane-taint", "operator": "Equal", "effect": "NoSchedule", "value": "true" } ]' \
--set-json 'dataPlane.tolerations=[{ "key": "data-plane-taint", "operator": "Equal", "effect": "NoSchedule", "value": "true" } ]'
```

If you want to install KubeBlocks with a specified version, follow the steps below.

1. View the available versions in [KubeBlocks Release](https://github.com/apecloud/kubeblocks/releases/).
2. Specify a version with `--version` and run the command below.

```bash
helm install kubeblocks kubeblocks/kubeblocks \
--namespace kb-system --create-namespace --version="x.x.x"
```

:::note

By default, the latest release version is installed.

:::

## Verify KubeBlocks installation

Run the following command to check whether KubeBlocks is installed successfully.

```bash
kubectl get pods --all-namespaces -l "app.kubernetes.io/instance=kubeblocks" -w
NAME READY STATUS RESTARTS AGE
kubeblocks-846b8878d9-q8g2w 1/1 Running 0 98s
kubectl -n kb-system get pods
```

If the operator pods are all `Running`, KubeBlocks has been installed successfully. You can cancel the above command by typing `Ctrl+C`.
***Result***

:::note

Clusters installed through `helm` need to be deleted using `helm` to avoid resource residue.
If the KubeBlocks Workloads are all ready, KubeBlocks has been installed successfully.

:::
```bash
NAME READY STATUS RESTARTS AGE
kb-addon-snapshot-controller-649f8b9949-2wzzk 1/1 Running 2 (24m ago) 147d
kubeblocks-dataprotection-f6dbdbf7f-5fdr9 1/1 Running 2 (24m ago) 147d
kubeblocks-6497f7947-mc7vc 1/1 Running 2 (24m ago) 147d
```
2 changes: 2 additions & 0 deletions docs/user_docs/installation/uninstall-kbcli-and-kubeblocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ kbcli kubeblocks uninstall

<TabItem value="helm" label="helm" default>

Delete all the clusters and resources created before performing the following command, otherwise the uninstallation may not be successful.

```bash
helm uninstall kubeblocks --namespace kb-system
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ kbcli cluster list kafka
Use `kbcli cluster volume-expand` command, configure the resources required and enter the cluster name again to expand the volume.

```bash
kbcli cluster volume-expand --storage=30G --component-names=kafka --volume-claim-templates=data kafka
kbcli cluster volume-expand --storage=30G --components=kafka --volume-claim-templates=data kafka
```

- `--component-names` describes the component name for volume expansion.
- `--components` describes the component name for volume expansion.
- `--volume-claim-templates` describes the VolumeClaimTemplate names in components.
- `--storage` describes the volume storage size.

Expand Down
14 changes: 7 additions & 7 deletions docs/user_docs/kubeblocks-for-kafka/cluster-management/scale.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 3
sidebar_label: Scale
---

# Scale a Kafka cluster
# Scale for a Kafka cluster

You can scale a Kafka cluster in two ways, vertical scaling and horizontal scaling.

Expand Down Expand Up @@ -146,12 +146,12 @@ Horizontal scaling changes the amount of pods. For example, you can apply horizo
- You are not recommended to perform horizontal scaling on the controller node, including the controller node both in combined mode and separated node.
- When scaling in horizontally, you must know the topic partition storage. If the topic has only one replication, data loss may caused when you scale in broker.
```bash
kbcli cluster list
>
NAME NAMESPACE CLUSTER-DEFINITION VERSION TERMINATION-POLICY STATUS CREATED-TIME
ivy85 default kafka kafka-3.3.2 Delete Running Jul 19,2023 18:01 UTC+0800
```
```bash
kbcli cluster list
>
NAME NAMESPACE CLUSTER-DEFINITION VERSION TERMINATION-POLICY STATUS CREATED-TIME
ivy85 default kafka kafka-3.3.2 Delete Running Jul 19,2023 18:01 UTC+0800
```
### Steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ kbcli cluster list mongodb-cluster
Use `kbcli cluster volume-expand` command, configure the resources required and enter the cluster name again to expand the volume.

```bash
kbcli cluster volume-expand --storage=30G --component-names=mongodb --volume-claim-templates=data mongodb-cluster
kbcli cluster volume-expand --storage=30G --components=mongodb --volume-claim-templates=data mongodb-cluster
>
OpsRequest mongodb-cluster-volumeexpansion-gcfzp created successfully, you can view the progress:
kbcli cluster describe-ops mongodb-cluster-volumeexpansion-gcfzp -n default
```

- `--component-names` describes the component name for volume expansion.
- `--components` describes the component name for volume expansion.
- `--volume-claim-templates` describes the VolumeClaimTemplate names in components.
- `--storage` describes the volume storage size.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ For Linux and macOS, you can edit configuration files by vi. For Windows, you ca

If there are multiple components in a cluster, use `--component` to specify a component.

::
:::

2. View the status of the parameter configuration.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The example below takes configuring `max_connections` and `innodb_buffer_pool_si
Name: mysql-cluster-reconfiguring-z2wvn NameSpace: default Cluster: mysql-cluster Type: Reconfiguring

Command:
kbcli cluster configure mysql-cluster --component-names=mysql --template-name=mysql-consensusset-config --config-file=my.cnf --set innodb_buffer_pool_size=512M --set max_connections=600
kbcli cluster configure mysql-cluster --components=mysql --template-name=mysql-consensusset-config --config-file=my.cnf --set innodb_buffer_pool_size=512M --set max_connections=600

Status:
Start Time: Mar 13,2023 02:55 UTC+0800
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 2
sidebar_label: Scale
---

# Scale for PostgreSQL
# Scale for a PostgreSQL cluster

Currently, only vertical scaling for PostgreSQL is supported.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,56 +25,56 @@ kbcli cluster list pulsar

Configure the values of `--components`, `--volume-claim-templates`, and `--storage`, and run the command below to expand the volume.

:::note
:::note

Expand volume for `journal` first. `ledger` volume expansion must be performed after the `journal` volume expansion.
Expand volume for `journal` first. `ledger` volume expansion must be performed after the `journal` volume expansion.

:::
:::

- Expand volume for `journal`.
- Expand volume for `journal`.

```bash
kbcli cluster volume-expand pulsar --storage=40Gi --components=bookies -t journal
```
```bash
kbcli cluster volume-expand pulsar --storage=40Gi --components=bookies -t journal
```

- `--components` describes the component name for volume expansion.
- `--volume-claim-templates` describes the VolumeClaimTemplate names in components.
- `--storage` describes the volume storage size.
- `--components` describes the component name for volume expansion.
- `--volume-claim-templates` describes the VolumeClaimTemplate names in components.
- `--storage` describes the volume storage size.

- Expand volume for `ledger`.
- Expand volume for `ledger`.

```bash
kbcli cluster volume-expand pulsar --storage=200Gi --components=bookies -t ledgers
```
```bash
kbcli cluster volume-expand pulsar --storage=200Gi --components=bookies -t ledgers
```

**Option 2.** Create an OpsRequest
**Option 2.** Create an OpsRequest

Change the value of storage according to your need and run the command below to expand the volume of a cluster.
Change the value of storage according to your need and run the command below to expand the volume of a cluster.

```bash
kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
generateName: pulsar-volume-expand-
spec:
clusterRef: pulsar
type: VolumeExpansion
volumeExpansion:
- componentName: bookies
volumeClaimTemplates:
- name: ledgers
storage: "200Gi"
- name: journal
storage: "40Gi"
EOF
```
```bash
kubectl apply -f - <<EOF
apiVersion: apps.kubeblocks.io/v1alpha1
kind: OpsRequest
metadata:
generateName: pulsar-volume-expand-
spec:
clusterRef: pulsar
type: VolumeExpansion
volumeExpansion:
- componentName: bookies
volumeClaimTemplates:
- name: ledgers
storage: "200Gi"
- name: journal
storage: "40Gi"
EOF
```

**Option 3.** Edit cluster with `kubectl`.
**Option 3.** Edit cluster with `kubectl`.

```bash
kubectl edit cluster pulsar
```
```bash
kubectl edit cluster pulsar
```

2. Validate the volume expansion operation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_label: Manage Vector Databases with KubeBlocks

The popularity of generative AI (Generative AI) has aroused widespread attention and completely ignited the vector database (Vector Database) market. KubeBlocks supports the management of vector databases, such as Qdrant, Milvus, and Weaviate.
In this chapter, we take Qdrant as an example to show how to manage vector databases with KubeBlocks.
Before you start, [Install KubeBlocks](./../installation/install-with-helm/) and `kbcli`.
Before you start, [install KubeBlocks](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md) and `kbcli`.

## Create a cluster

Expand Down

0 comments on commit 0df2a94

Please sign in to comment.