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 d818359
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 6 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
10 changes: 8 additions & 2 deletions docs/user_docs/installation/install-with-kbcli/install-kbcli.md
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.
By default, kbcli installs the latest release version. However, if you already have a running KubeBlocks instance, you need to install a matching version of kbcli.

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 example, if your existing KubeBlocks deployment is v0.8.3, you should install kbcli v0.8.3 instead of a higher version like v0.9.0, as mismatched versions may lead to errors.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,23 @@ If you want to install KubeBlocks with a specified version, follow the steps bel
```bash
kbcli kubeblocks list-versions
```

To include alpha and beta releases, use:
```bash
kbcli kb list-versions --devel --limit=100
```

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

```bash
kbcli kubeblocks install --version=x.x.x
```

:::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.
By default, when installing KubeBlocks, kbcli installs the corresponding version of KubeBlocks. It's important to ensure the major versions of kbcli and KubeBlocks are the same, if you specify a different version explicitly here.
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 example, you can install kbcli v0.8.1 with KubeBlocks v0.8.3, but using mismatched major versions, such as kbcli v0.8.1 with KubeBlocks v0.9.0, may lead to errors.
:::
Expand Down

0 comments on commit d818359

Please sign in to comment.