From 350d346db3a83225325c91ffaf6e3934b9e44415 Mon Sep 17 00:00:00 2001 From: zhuxiujuan28 <562873187@qq.com> Date: Wed, 27 Nov 2024 17:28:21 +0800 Subject: [PATCH] translate docs Signed-off-by: zhuxiujuan28 <562873187@qq.com> --- .../01-preparations/01-supported-k8s.adoc | 10 ++++++++++ .../07-configure-opensource-storage.adoc | 18 ++++++++++++++++++ .../_index.adoc | 19 ++++++++++++++++++- 3 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/07-configure-opensource-storage.adoc diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc index fd207f4cb..6fbe428a2 100644 --- a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc +++ b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc @@ -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"] diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/07-configure-opensource-storage.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/07-configure-opensource-storage.adoc new file mode 100644 index 000000000..5ffeb469b --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/07-configure-opensource-storage.adoc @@ -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. \ No newline at end of file diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/_index.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/_index.adoc index 44e1a5a9c..867a6d0a7 100644 --- a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/_index.adoc +++ b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/_index.adoc @@ -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[] \ No newline at end of file +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. \ No newline at end of file