-
Notifications
You must be signed in to change notification settings - Fork 176
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add rabbitmq docs and update other related docs (#8149)
- Loading branch information
1 parent
49e726e
commit fccd4ba
Showing
23 changed files
with
692 additions
and
139 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
85 changes: 85 additions & 0 deletions
85
docs/user_docs/installation/install-with-kbcli/install-addons.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
position: 21 | ||
label: KubeBlocks for RabbitMQ | ||
collapsible: true | ||
collapsed: true |
Oops, something went wrong.