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

【documentation】 更新存储系统相关文档 #3218

Merged
merged 9 commits into from
Dec 9, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ This section introduces the environment requirements for {ks_product-en}.
|CPU: 8 cores, Memory: 16 GB, Disk: 200 GB
|===

== Storage Requirements

* A default storage class must be available in the cluster.
+
--
Storage classes define a class of storage volumes that containers can use. If you did not set up an external persistent storage system during the installation of {ks_product-en}, {ks_product-en} will use the local storage system of the cluster nodes as the persistent storage system and automatically create the corresponding **local** storage class. If you are using an external persistent storage system, you need to install a storage plugin for the KubeSphere cluster and create storage classes to define the classes of storage volumes that can be used. For information on how to install storage plugins, please contact your storage system provider. For information on how to install the storage plugin, contact your storage system provider or refer to link:../04-configure-external-persistent-storage[Configure External Persistent Storage].
--

* The various components of {ks_product-en} only require the storage system to support creating and deleting persistent volume claims (PVCs) and do not rely on advanced capabilities such as expansion, cloning, and snapshots.

== Dependency Requirements

[%header,cols="1a,4a,4a"]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "Configure Open-Source Storage Systems"
keywords: "Kubernetes, KubeSphere, installation, preparation, persistent storage, open-source storage, Ceph, GlusterFS, OpenEBS, Longhorn"
description: "Learn how to configure open-source storage systems for KubeSphere clusters in production environments."
weight: 07
---

KubeSphere supports many third-party open-source storage systems, **including but not limited to**:

* link:https://github.com/ceph/ceph-csi[Ceph CSI]

* link:https://docs.gluster.org/en/latest/[GlusterFS]

* link:https://openebs.io/[OpenEBS]

* link:https://longhorn.io/[Longhorn]

{ks_product-en} does not provide installation packages for third-party open-source storage systems. Please download and install them from the official websites of the storage systems.
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,21 @@ include::../../../../../_ks_components-en/admonitions/note.adoc[]

The configuration of external persistent storage for KubeSphere is only supported in scenarios where Kubernetes and KubeSphere are installed together. If you install KubeSphere on an existing Kubernetes cluster, KubeSphere will use the existing persistent storage configuration of the Kubernetes cluster.

include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[]
include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[]

== How to Install Storage Systems

When link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[installing {ks_product-en}], different storage systems can be installed as plugins. KubeKey will create a configuration file (default is `config-sample.yaml`) that contains all the necessary parameters to define different resources, including storage plugins. To have KubeKey install these storage systems as expected, you must provide the necessary configurations for these storage systems to KubeKey.

Generally, there are two ways to have KubeKey apply the configuration of the storage systems.

. Directly input the necessary parameters under the `addons` field in `config-sample.yaml`.
. Create a separate configuration file for the plugin, listing all necessary parameters, and configure the file path in `config-sample.yaml` so that KubeKey can reference the path during the installation process.

For more information, see link:https://github.com/kubesphere/kubekey/blob/master/docs/addons.md[Plugins].

== Default Storage Class

* KubeKey supports installing different storage plugins and storage classes. Regardless of which storage system you install, you can specify whether it should be set as the default storage class in its configuration file.

* If you install multiple storage plugins, only one of them can be set as the default storage class. Otherwise, KubeKey will not be able to identify which storage class to use.
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,17 @@ weight: 01
|CPU:8 核,内存:16 GB,硬盘:200 GB
|===

== 存储要求

* 集群中必须存在一个可用的默认存储类。
+
--
存储类定义了可供容器使用的一类存储卷。如果您在安装{ks_product_both}时未设置外部持久化存储系统,{ks_product_right}将使用集群节点的本地存储系统作为持久化存储系统,并自动创建对应的 **local** 存储类。如果使用外部持久化存储系统,您需要为{ks_product_both}集群安装存储插件,并创建存储类以定义可供使用的存储卷类型。有关如何安装存储插件,请联系您的存储系统提供商或参阅link:../04-configure-external-persistent-storage[配置外部持久化存储]。
--

* {ks_product_right}的各个组件只需要存储系统提供创建、删除持久卷声明(PVC)的能力,不依赖扩容、克隆、快照等高级能力。


== 依赖项要求

[%header,cols="1a,4a,4a"]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "配置开源存储系统"
keywords: "Kubernetes, KubeSphere, 安装, 准备, 持久化存储, 开源存储, Ceph, GlusterFS, OpenEBS, Longhorn"
description: "介绍如何在生产环境中为 KubeSphere 集群配置开源存储系统。"
weight: 07
---

KubeSphere 支持众多第三方开源存储系统,**包括但不限于**:

* link:https://github.com/ceph/ceph-csi[Ceph CSI]

* link:https://docs.gluster.org/en/latest/[GlusterFS]

* link:https://openebs.io/[OpenEBS]

* link:https://longhorn.io/[Longhorn]

{ks_product_right}不提供第三方开源存储系统的安装包,请到存储系统的官方网站下载安装。
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,20 @@ include::../../../../../_ks_components/admonitions/note.adoc[]
{ks_product_right}外部持久化存储配置仅支持同时安装 Kubernetes 和{ks_product_both}的场景。如果您在现有的 Kubernetes 集群上安装{ks_product_left},{ks_product_right}安装完成后将使用 Kubernetes 集群现有的持久化存储配置。

include::../../../../../_ks_components/admonitions/admonEnd.adoc[]

== 如何安装存储系统

link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装{ks_product_both}]时,可以安装不同的存储系统作为插件。KubeKey 会为集群创建一个配置文件(默认为 `config-sample.yaml`),其中包含定义不同资源(包括存储插件)的全部必要参数。若要让 KubeKey 以预期的方式来安装这些存储系统,就必须为 KubeKey 提供这些存储系统的必要配置。

通常,有两种方法能使 KubeKey 应用即将安装的存储系统的配置。

. 直接在 `config-sample.yaml` 中的 `addons` 字段下输入必要的参数。
. 为插件创建一个单独的配置文件,列出所有必要的参数,并在 `config-sample.yaml` 中提供文件的路径,以便 KubeKey 在安装过程中引用该路径。

有关更多信息,请参见link:https://github.com/kubesphere/kubekey/blob/master/docs/addons.md[插件]。

== 默认存储类

* KubeKey 支持安装不同的存储插件和存储类型。无论您要安装哪种存储系统,都可以在其配置文件中指定是否设为默认存储类。

* 如果打算安装多个存储插件,那么只能将其中一个设置为默认存储类。否则,KubeKey 将无法识别使用哪种存储类型。