Skip to content

Commit

Permalink
docs: add rabbitmq docs and update other related docs (#8149)
Browse files Browse the repository at this point in the history
  • Loading branch information
michelle-0808 authored Sep 19, 2024
1 parent 49e726e commit fccd4ba
Show file tree
Hide file tree
Showing 23 changed files with 692 additions and 139 deletions.
Binary file added docs/img/kubeblocks-architecture-ha.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ After deploying KubeBlocks, you can use it to create various databases such as M
- [MongoDB](./../kubeblocks-for-mongodb/cluster-management/create-and-connect-to-a-mongodb-cluster.md)
- [Kafka](./../kubeblocks-for-kafka/cluster-management/create-a-kafka-cluster.md)
- [Pulsar](./../kubeblocks-for-pulsar/cluster-management/create-pulsar-cluster-on-kubeblocks.md)
- RabbitMQ
- [RabbitMQ](./../kubeblocks-for-rabbitmq/manage-rabbitmq.md)
- [Elasticsearch](./../kubeblocks-for-elasticsearch/manage-elasticsearch.md)
- [StarRocks](./../kubeblocks-for-starrocks/manage-starrocks.md)
- [Milvus](./../kubeblocks-for-milvus/manage-milvus.md)
Expand Down
85 changes: 85 additions & 0 deletions docs/user_docs/installation/install-with-kbcli/install-addons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: Install Addons
description: Install KubeBlocks Addons
keywords: [kbcli, kubeblocks, addons, install]
sidebar_position: 3
sidebar_label: Install Addons
---

# Install Addons

## Use the index to install an addon

With the release of KubeBlocks v0.8.0, addons are decoupled from KubeBlocks and some addons are not installed by default. If you want to use these addons, add addons first by index.

The official index repo is [KubeBlocks index](https://github.com/apecloud/block-index). The code of all addons is maintained in the [KubeBlocks addon repo](https://github.com/apecloud/kubeblocks-addons).

1. View the index.

kbcli creates an index named `kubeblocks` by default and you can check whether this index is created by running `kbcli addon index list`.

```bash
kbcli addon index list
>
INDEX URL
kubeblocks https://github.com/apecloud/block-index.git
```

If the list is empty or you want to add your index, you can add the index manually by using `kbcli addon index add <index-name> <source>`. For example,

```bash
kbcli addon index add kubeblocks https://github.com/apecloud/block-index.git
```

If you are not sure whether the kubeblocks index is the latest version, you can update it.

```bash
kbcli addon index update kubeblocks
```

2. (Optional) Search whether the addon exists in the index.

```bash
kbcli addon search mariadb
>
ADDON VERSION INDEX
mariadb 0.7.0 kubeblocks
```

3. Install the addon.

If there are multiple index sources and versions for an addon, you can specify them by adding flags. The system installs the latest version in the `kubeblocks` index by default.

```bash
kbcli addon install mariadb --index kubeblocks --version 0.7.0
```

**What's next**
After the addon is installed, you can list and enable it.
## List addons
To list supported addons, run `kbcli addon list` command.
## Enable/Disable addons
To manually enable or disable addons, follow the steps below.
***Steps:***
1. To enable an addon, use `kbcli addon enable`.
***Example***
```bash
kbcli addon enable snapshot-controller
```
To disable an addon, use `kbcli addon disable`.
2. List the addons again to check whether it is enabled.
```bash
kbcli addon list
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Uninstall kbcli and KubeBlocks
description: Handle exception and uninstall kbcli and KubeBlocks
keywords: [kbcli, kubeblocks, exception, uninstall]
sidebar_position: 5
sidebar_position: 4
sidebar_label: Uninstall KubeBlocks and kbcli
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This tutorial shows how to create and connect to an ApeCloud MySQL cluster.

* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md).
* [Install KubeBlocks by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md).
* Make sure the ApeCloud MySQL addon is enabled. If this addon is not enabled, [enable it](./../../overview/supported-addons.md#use-addons) first.
* Make sure the ApeCloud MySQL addon is enabled. If this addon is not enabled, [enable it](./../../installation/install-with-kbcli/install-addons.md#enabledisable-addons) first.

```bash
kbcli addon list
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ It is recommended to use kbcli to create an ApeCloud MySQL Proxy Cluster.

1. Enable the etcd addon and create an etcd cluster.

1. Install and enable the etcd addon. You need to install the etcd addon first since the etcd addon is not installed by default. Refer to [User addons](./../../overview/supported-addons.md#use-addons) for details.
1. Install and enable the etcd addon. You need to install the etcd addon first since the etcd addon is not installed by default. Refer to [Addons installation tutorial](./../../installation/install-with-kbcli/install-addons.md) for details.

```bash
# 1. Check whether the KubeBlocks addon index is added
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ KubeBlocks supports the management of Elasticsearch.

- [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md).
- [Install KubeBlocks](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md).
- [Install and enable the elasticsearch addon](./../overview/supported-addons.md#use-addons).
- [Install and enable the elasticsearch addon](./../installation/install-with-kbcli/install-addons.md).

## Create a cluster

Expand Down Expand Up @@ -112,7 +112,7 @@ curl http://127.0.0.1:9200/_cat/nodes?v

For the testing environment, you can run the command below to open the Grafana monitor web page.

1. View all built-in addons and make sure the monitoring addons are enabled. If the monitoring addons are not enabled, [enable these addons](./../overview/supported-addons.md#use-addons) first.
1. View all built-in addons and make sure the monitoring addons are enabled. If the monitoring addons are not enabled, [enable these addons](./../installation/install-with-kbcli/install-addons.md#enabledisable-addons) first.

```bash
# View all addons supported
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This document shows how to create a Kafka cluster.

* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md).
* [Install KubeBlocks](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md).
* Make sure kafka addon is enabled with `kbcli addon list`. If this addon is not enabled, [enable it](./../../overview/supported-addons.md#use-addons) first.
* Make sure kafka addon is enabled with `kbcli addon list`. If this addon is not enabled, [enable it](./../../installation/install-with-kbcli/install-addons.md) first.

```bash
kbcli addon list
Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/kubeblocks-for-milvus/manage-milvus.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ KubeBlocks supports the management of Milvus.

- [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md).
- [Install KubeBlocks](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md).
- [Install and enable the milvus addon](./../overview/supported-addons.md#use-addons).
- [Install and enable the milvus addon](./../installation/install-with-kbcli/install-addons.md).

## Create a cluster

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This tutorial shows how to create and connect to a MongoDB cluster.

* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md).
* [Install KubeBlocks](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md).
* Make sure the MongoDB addon is enabled. If this addon is not enabled, [enable it](./../../overview/supported-addons.md#use-addons) first.
* Make sure the MongoDB addon is enabled. If this addon is not enabled, [enable it](./../../installation/install-with-kbcli/install-addons.md) first.

```bash
kbcli addon list
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This tutorial shows how to create and connect to a MySQL cluster.

* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md).
* [Install KubeBlocks by kbcli](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md).
* Make sure the MySQL addon is enabled. If this addon is not enabled, [enable it](./../../overview/supported-addons.md#use-addons) first.
* Make sure the MySQL addon is enabled. If this addon is not enabled, [enable it](./../../installation/install-with-kbcli/install-addons.md) first.

```bash
kbcli addon list
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This tutorial shows how to create and connect to a PostgreSQL cluster.

* [Install kbcli](./../../installation/install-with-kbcli/install-kbcli.md).
* [Install KubeBlocks](./../../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md).
* Make sure the PostgreSQL addon is enabled. If this addon is not enabled, [enable it](./../../overview/supported-addons.md#use-addons) first.
* Make sure the PostgreSQL addon is enabled. If this addon is not enabled, [enable it](./../../installation/install-with-kbcli/install-addons.md) first.

```bash
kbcli addon list
Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/kubeblocks-for-qdrant/manage-qdrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ KubeBlocks supports the management of Qdrant.

- [Install kbcli](./../installation/install-with-kbcli/install-kbcli.md).
- [Install KubeBlocks](./../installation/install-with-kbcli/install-kubeblocks-with-kbcli.md).
- [Install and enable the qdrant addon](./../overview/supported-addons.md#use-addons).
- [Install and enable the qdrant addon](./../installation/install-with-kbcli/install-addons.md).

## Create a cluster

Expand Down Expand Up @@ -106,7 +106,7 @@ If your cluster is on AWS, install the AWS Load Balancer Controller first.

For the testing environment, you can run the command below to open the Grafana monitor web page.

1. View all built-in addons and make sure the monitoring addons are enabled. If the monitoring addons are not enabled, [enable these addons](./../overview/supported-addons.md#use-addons) first.
1. View all built-in addons and make sure the monitoring addons are enabled. If the monitoring addons are not enabled, [enable these addons](./../installation/install-with-kbcli/install-addons.md) first.

```bash
# View all addons supported
Expand Down
4 changes: 4 additions & 0 deletions docs/user_docs/kubeblocks-for-rabbitmq/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
position: 21
label: KubeBlocks for RabbitMQ
collapsible: true
collapsed: true
Loading

0 comments on commit fccd4ba

Please sign in to comment.