Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add how to get kbcli and kb version in docs #8213

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommend to use this pipe | jq -r '.[] | select(.prerelease == false) | .tag_name' | sort -V for better result.

$ curl -s "https://api.github.com/repos/apecloud/kubeblocks/releases?per_page=100&page=1" | jq -r '.[] | select(.prerelease == false) | .tag_name' | sort -V
v0.5.1
v0.5.2
v0.5.3
v0.6.0
v0.6.1
v0.6.2
v0.6.3
v0.6.4
v0.7.0
v0.7.1
v0.7.2
v0.8.0
v0.8.1
v0.8.2
v0.8.3
v0.8.4
v0.9.0

```

:::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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change to "install KubeBlocks v0.8.3 with kbcli v0.8.1"?


:::

Expand Down
Loading