Skip to content

Commit

Permalink
docs: add how to get kbcli and kb version in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
weicao committed Sep 26, 2024
1 parent 2b414ae commit 755f7f6
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,13 @@ Use Helm and follow the steps below to install KubeBlocks.
```bash
kubectl create -f https://github.com/apecloud/kubeblocks/releases/download/vx.x.x/kubeblocks_crds.yaml
```
You can view all versions of kubeblocks, including alpha and beta releases, on the [kubeblocks releases list](https://github.com/apecloud/kubeblocks/releases).

To get stable releases, use this command:
```bash
curl -s "https://api.github.com/repos/apecloud/kubeblocks/releases?per_page=100&page=1" | jq '.[] | select(.prerelease == false) | .tag_name'
```


2. Add the KubeBlocks Helm repo.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,18 @@ You can install kbcli with `curl` or `brew`.
```bash
curl -fsSL https://kubeblocks.io/installer/install_cli.sh | bash -s x.x.x
```
You can view all versions of kbcli, including alpha and beta releases, on the [kbcli releases list](https://github.com/apecloud/kbcli/releases).

To get stable releases, use this command:
```bash
curl -s "https://api.github.com/repos/apecloud/kbcli/releases?per_page=100&page=1" | jq '.[] | select(.prerelease == false) | .tag_name'
```

:::note

By default, kbcli installs the latest release version and then when installing KubeBlocks, kbcli installs the matched version. Ensure that the major versions of kbcli and KubeBlocks match.

For instance, you can install kbcli v0.6.1 and KubeBlocks v0.6.3, but mismatched versions like kbcli v0.5.0 and KubeBlocks v0.6.0 may result in errors.
For instance, you can install kbcli v0.8.1 and KubeBlocks v0.8.3, but mismatched versions like kbcli v0.8.1 and KubeBlocks v0.9.0 may result in errors.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,20 @@ If you want to install KubeBlocks with a specified version, follow the steps bel
kbcli kubeblocks install --version=x.x.x
```

You can view all stable releases of KubeBlocks with the command:
```bash
kbcli kb list-versions
```
To include alpha and beta releases, use:
```bash
kbcli kb list-versions --devel --limit=100
```

:::note

By default, kbcli installs the latest release version and then when installing KubeBlocks, kbcli installs the matched version. Ensure that the major versions of kbcli and KubeBlocks match.

For instance, you can install kbcli v0.6.1 and KubeBlocks v0.6.3, but mismatched versions like kbcli v0.5.0 and KubeBlocks v0.6.0 may result in errors.
For instance, you can install kbcli v0.8.1 and KubeBlocks v0.8.3, but mismatched versions like kbcli v0.8.1 and KubeBlocks v0.9.0 may result in errors.

:::

Expand Down

0 comments on commit 755f7f6

Please sign in to comment.