Skip to content

Commit

Permalink
docs: sync installation and overview docs from the main branch (#8554)
Browse files Browse the repository at this point in the history
  • Loading branch information
michelle-0808 authored Nov 29, 2024
1 parent d72a42b commit ea5914a
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 7 deletions.
18 changes: 16 additions & 2 deletions docs/user_docs/installation/install-kubeblocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,22 @@ Use Helm and follow the steps below to install KubeBlocks.

Like any other resource in Kubernetes, KubeBlocks can be installed through a YAML manifest applied via `kubectl`.

1. Copy the URL of the `kubeblocks.yaml file` for the version you need from the Assets on the [KubeBlocks Release page](https://github.com/apecloud/kubeblocks/releases).
2. Replace the YAML file URL in the command below and run this command to install KubeBlocks.
1. Create dependent CRDs. Specify the version you want to install.

```bash
kubectl create -f https://github.com/apecloud/kubeblocks/releases/download/vx.y.z/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 -r '.[] | select(.prerelease == false) | .tag_name' | sort -V -r
```

2. Copy the URL of the `kubeblocks.yaml` file for the version you need from the Assets on the [KubeBlocks Release page](https://github.com/apecloud/kubeblocks/releases).
3. Replace the YAML file URL in the command below and run this command to install KubeBlocks.

```bash
kubectl create -f https://github.com/apecloud/kubeblocks/releases/download/vx.y.x/kubeblocks.yaml
Expand Down
4 changes: 1 addition & 3 deletions docs/user_docs/overview/supported-addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ sidebar_label: Supported addons

# Supported Addons

KubeBlocks uses Addons to extend support for various database engines,
And there are currently over 30 Addons available in the KubeBlocks repository.
Which can be further categorized as follows sections.
KubeBlocks uses Addons to extend support for various database engines. And there are currently over 30 Addons available in the KubeBlocks repository, which can be further categorized as follows sections.

For installing and enabling Addons, refer to install Addons [by kbcli](./../installation/install-with-kbcli/install-addons.md) or [by Helm](./../installation/install-with-helm/install-addons.md).

Expand Down
18 changes: 16 additions & 2 deletions i18n/zh-cn/user-docs/installation/install-kubeblocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,23 @@ KubeBlocks 是 Kubernetes 原生 operator,可通过 Helm、 kubectl 应用 YAM

与 Kubernetes 中的其他资源相同,KubeBlocks 也可以通过 YAML 文件和 kubectl 命令进行安装。

1. 从对应版本的 [KubeBlocks 发布列表](https://github.com/apecloud/kubeblocks/releases) 中的资产部分获取 `kubeblocks.yaml` 文件地址。
1. 创建安装所依赖的 CRDs,并指定您想要安装的版本。

```bash
kubectl create -f https://github.com/apecloud/kubeblocks/releases/download/vx.y.z/kubeblocks_crds.yaml
```

您可以通过 [KubeBlocks 发布列表](https://github.com/apecloud/kubeblocks/releases) 查看 KubeBlocks 的所有版本,包括 alpha 及 beta 版本。

也可通过执行以下命令,获取稳定版本:

```bash
curl -s "https://api.github.com/repos/apecloud/kubeblocks/releases?per_page=100&page=1" | jq -r '.[] | select(.prerelease == false) | .tag_name' | sort -V -r
```

2. 从对应版本的 [KubeBlocks 发布列表](https://github.com/apecloud/kubeblocks/releases) 中的资产部分获取 `kubeblocks.yaml` 文件地址。

2. 替换 YAML 文件地址,执行以下命令,安装 KubeBlocks。
3. 替换 YAML 文件地址,执行以下命令,安装 KubeBlocks。

```bash
kubectl create -f https://github.com/apecloud/kubeblocks/releases/download/vx.y.x/kubeblocks.yaml
Expand Down

0 comments on commit ea5914a

Please sign in to comment.