diff --git a/content/en/docs/project-user-guide/storage/volumes.md b/content/en/docs/project-user-guide/storage/volumes.md index 40c6f3ab2..9c77782f6 100644 --- a/content/en/docs/project-user-guide/storage/volumes.md +++ b/content/en/docs/project-user-guide/storage/volumes.md @@ -6,9 +6,9 @@ linkTitle: "Volumes" weight: 10310 --- -When you create an application workload in a project, you can create a [PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) (PVC) for it. A PVC allows you to create a request for storage, further provisioning persistent storage to applications. More specifically, persistent storage is managed by PersistentVolume resources. +When you create an application workload in a project, you can create a [PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) (PVC) for it. A PVC allows you to create a storage request, further provisioning persistent storage to applications. More specifically, persistent storage is managed by PersistentVolume resources. -Cluster administrators configure PersistentVolumes using storage classes. In other words, to create a PersistentVolumeClaim in a project, make sure your cluster has an available storage class. If no customized storage class is configured when you install KubeSphere, [OpenEBS](https://openebs.io/) is installed in your cluster by default to provide Local Persistent Volumes. However, it does not support dynamic volume provisioning. In a production environment, it is recommended you configure storage classes in advance to provide persistent storage services for your apps. +Cluster administrators configure PersistentVolumes using storage classes. In other words, to create a PersistentVolumeClaim in a project, your cluster must have an available storage class. If no customized storage class is configured when you install KubeSphere, [OpenEBS](https://openebs.io/) is installed in your cluster by default to provide Local Persistent Volumes. However, it does not support dynamic volume provisioning. In a production environment, it is recommended you configure storage classes in advance to provide persistent storage services for your apps. This tutorial demonstrates how to create a volume, mount a volume and use volume features from its detail page. @@ -20,18 +20,14 @@ This tutorial demonstrates how to create a volume, mount a volume and use volume ## Create a Volume -All the volumes that are created on the **Volumes** page are PersistentVolumeClaim objects. KubeSphere binds the PersistentVolumeClaim to the PersistentVolume that satisfies the request you set for the PersistentVolumeClaim, such as capacity and access mode. When you create an application workload, you can select the desired volume and mount it to your workload. +All the volumes that are created on the **Volumes** page are PersistentVolumeClaim objects. KubeSphere binds a PersistentVolumeClaim to a PersistentVolume that satisfies the request you set for the PersistentVolumeClaim, such as capacity and access mode. When you create an application workload, you can select the desired volume and mount it to your workload. -1. Log in to the web console of KubeSphere and go to a project. Click **Volumes** under **Storage** from the navigation bar, and you see all volumes that have been mounted to workloads in the project. +1. Log in to the web console of KubeSphere as `project-regular` and go to a project. Click **Volumes** under **Storage** from the navigation bar, and you see all volumes that have been mounted to workloads in the project. 2. To create a volume, click **Create** on the **Volumes** page. - ![create-volume](/images/docs/project-user-guide/volume-management/volumes/create-volume.jpg) - 3. In the dialog that appears, set a name (e.g. `demo-volume`) for the volume and click **Next**. - ![basic-volume-info](/images/docs/project-user-guide/volume-management/volumes/basic-volume-info.jpg) - {{< notice note >}} You can see the volume's manifest file in YAML format by enabling **Edit Mode** in the top right corner. KubeSphere allows you to edit the manifest file directly to create a volume. Alternatively, you can follow the steps below to create a volume via the dashboard. @@ -40,21 +36,17 @@ All the volumes that are created on the **Volumes** page are PersistentVolumeCla 4. On the **Volume Settings** page, select a method to create a volume. - ![volume-creation-method](/images/docs/project-user-guide/volume-management/volumes/volume-creation-method.jpg) - - **Create a volume by StorageClass**. You can configure storage classes both [before](../../../installing-on-linux/persistent-storage-configurations/understand-persistent-storage/) and [after](../../../cluster-administration/persistent-volume-and-storage-class/) the installation of KubeSphere. - **Create a volume by VolumeSnapshot**. To use a snapshot to create a volume, you must create a volume snapshot first. -5. Select **Create a volume by StorageClass**. For more information about how to create a volume by snapshot, see [Volume Snapshots](../volume-snapshots/). + Select **Create a volume by StorageClass** in this example. For more information about how to create a volume by snapshot, see [Volume Snapshots](../volume-snapshots/). -6. Select a storage class from the drop-down list. +5. Select a storage class from the drop-down list. This tutorial uses `csi-standard`, a standard storage class provided by QingCloud Platform. You can select your own storage class. ![select-storage-class](/images/docs/project-user-guide/volume-management/volumes/select-storage-class.jpg) -7. This tutorial uses `csi-standard`, a standard storage class provided by QingCloud Platform. You can select your own storage class. - -8. Depending on the storage class you select, you may see different access modes in this section as some PersistentVolumes only support specific access modes. In total, there are three access modes. +6. Depending on the storage class you select, you may see different access modes in this section as some PersistentVolumes only support specific access modes. In total, there are three access modes. - **ReadWriteOnce (RWO)**: The volume can be mounted as read-write by a single node. - **ReadOnlyMany (ROX)**: The volume can be mounted as read-only by many nodes. @@ -62,17 +54,13 @@ All the volumes that are created on the **Volumes** page are PersistentVolumeCla Select the desired access mode. -9. Under **Volume Capacity**, specify the size of the volume. Click **Next** to continue. +7. Under **Volume Capacity**, specify the size of the volume. Click **Next** to continue. - ![volume-finished](/images/docs/project-user-guide/volume-management/volumes/volume-finished.jpg) +8. On the **Advanced Settings** page, you can add metadata to the volume, such as **Labels** and **Annotations**. They can be used as identifiers to search for and schedule resources. -10. On the **Advanced Settings** page, you can add metadata to the volume, such as **Labels** and **Annotations**. They can be used as identifiers to search and schedule resources. +9. Click **Create** to finish creating a volume. -11. Click **Create** to finish creating a volume. - - ![volume-finish-creation](/images/docs/project-user-guide/volume-management/volumes/volume-finish-creation.jpg) - -12. A created volume displays on the **Volumes** page in a project. After it is mounted to a workload, it will turn to **Mounted** under the **Mount** column. +10. A created volume displays on the **Volumes** page in a project. After it is mounted to a workload, it will turn to **Mounted** under the **Mount** column. ![volume-status](/images/docs/project-user-guide/volume-management/volumes/volume-status.jpg) @@ -82,7 +70,7 @@ Newly-created volumes will also appear on the **Volumes** page in **Cluster Mana {{}} -13. For some volumes, you can see the status reach **Bound** from **Pending** immediately after they are created as they are provisioned dynamically. For volumes that remain the **Pending** status, they will turn to **Bound** once they are mounted to a workload. The difference is decided by the storage class of the volume. +11. For some volumes, you can see the status reach **Bound** from **Pending** immediately after they are created as they are provisioned dynamically. For volumes that remain in the **Pending** status, they will turn to **Bound** once they are mounted to a workload. The difference is decided by the storage class of the volume. ![local-pending](/images/docs/project-user-guide/volume-management/volumes/local-pending.jpg) @@ -138,7 +126,7 @@ After a volume is created, you can see detailed information of it, edit it, or l ### Edit a volume -On the detail page, you can click **Edit Info** to change its basic information. Click **More** and you can edit its YAML file or delete this volume. +On the detail page, you can click **Edit Information** to change its basic information. Click **More** and you can edit its YAML file or delete this volume. To delete a volume, make sure the volume is not mounted to any workload. To unmount a volume, go to the detail page of a workload. From the **More** drop-down list, click **Edit Config Template**. Select **Volume** from the pop-up window, and click the dustbin icon to unmount it. diff --git a/content/zh/docs/project-user-guide/storage/volumes.md b/content/zh/docs/project-user-guide/storage/volumes.md index 58c208842..467e50b8a 100644 --- a/content/zh/docs/project-user-guide/storage/volumes.md +++ b/content/zh/docs/project-user-guide/storage/volumes.md @@ -6,9 +6,9 @@ linkTitle: "存储卷" weight: 10310 --- - 在项目中创建应用负载时，您可以为应用负载创建 [PersistentVolumeClaim (PVC)](https://kubernetes.io/zh/docs/concepts/storage/persistent-volumes/)。您可以用 PVC 创建存储请求，从而进一步为应用提供持久化存储。更具体地说，PersistentVolume 资源可用于管理持久化存储。 + 在项目中创建应用负载时，您可以为应用负载创建 [PersistentVolumeClaim (PVC)](https://kubernetes.io/zh/docs/concepts/storage/persistent-volumes/)。PVC 可用于创建存储请求，从而进一步为应用提供持久化存储。更具体地说，PersistentVolume 资源可用于管理持久化存储。 -集群管理员需要用存储类型 (Storage Class) 配置 PersistentVolume。也就是说，要在项目中创建 PersistentVolumeClaim，您需要确保集群中有可用的存储类型。如果在安装 KubeSphere 时没有配置自定义存储类型，集群中将默认安装 [OpenEBS](https://openebs.io/) 以提供本地持久卷。然而，OpenEBS 不支持动态存储卷供应。在生产环境中，建议您提前配置存储类型从而为应用提供持久化存储服务。 +集群管理员需要用存储类型 (Storage Class) 配置 PersistentVolume。也就是说，要在项目中创建 PersistentVolumeClaim，您的集群中必须要有可用的存储类型。如果在安装 KubeSphere 时没有配置自定义存储类型，集群中将默认安装 [OpenEBS](https://openebs.io/) 以提供本地持久卷。然而，OpenEBS 不支持动态存储卷供应。在生产环境中，建议您提前配置存储类型从而为应用提供持久化存储服务。 本教程介绍如何创建存储卷、挂载存储卷和通过存储卷详情页面使用存储卷功能。 @@ -22,16 +22,12 @@ weight: 10310 在**存储卷**页面创建的所有存储卷都是 PersistentVolumeClaim 对象。KubeSphere 将 PersistentVolumeClaim 绑定到满足您设定的请求条件（例如容量和访问模式）的 PersistentVolume。在创建应用负载时，您可以选择所需的存储卷并将其挂载到负载。 -1. 登录 KubeSphere Web 控制台并进入项目，在左侧导航栏中点击**存储管理**下的**存储卷**。页面上显示所有已挂载至项目工作负载的存储卷。 +1. 以 `project-regular` 身份登录 KubeSphere Web 控制台并进入项目，在左侧导航栏中点击**存储管理**下的**存储卷**。页面上显示所有已挂载至项目工作负载的存储卷。 2. 在**存储卷**页面，点击**创建**以创建存储卷。 - ![create-volume](/images/docs/zh-cn/project-user-guide/volume-management/volumes/create-volume.jpg) - 3. 在弹出的对话框设置存储卷的名称（例如 `demo-volume`），然后点击**下一步**。 - ![basic-volume-info](/images/docs/zh-cn/project-user-guide/volume-management/volumes/basic-volume-info.jpg) - {{< notice note >}} 您可以在对话框右上角启用**编辑模式**来查看存储卷的 YAML 清单文件，并通过直接编辑清单文件来创建存储卷。您也可继续执行后续步骤在控制台上创建存储卷。 @@ -40,20 +36,16 @@ weight: 10310 4. 在**存储卷设置**页面，选择创建存储卷的方式。 - ![volume-creation-method](/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-creation-method.jpg) - - **通过存储类型**：您可以在 KubeSphere [安装前](../../../installing-on-linux/persistent-storage-configurations/understand-persistent-storage/)或[安装后](../../../cluster-administration/persistent-volume-and-storage-class/)配置存储类型。 + - **通过存储卷快照创建**：如需通过快照创建存储卷，您必须先创建存储卷快照。 - -5. 选择**通过存储类型**。有关通过存储卷快照创建存储卷的更多信息，请参阅[存储卷快照](../volume-snapshots/)。 - -6. 从下拉列表中选择存储类型。 + + 选择**通过存储类型**。有关通过存储卷快照创建存储卷的更多信息，请参阅[存储卷快照](../volume-snapshots/)。 +5. 从下拉列表中选择存储类型。本教程以青云QingCloud 平台提供的 `csi-standard` 标准存储类型为例。您可以根据需要选择其他存储类型。 ![select-storage-class](/images/docs/zh-cn/project-user-guide/volume-management/volumes/select-storage-class.jpg) -7. 本教程以青云QingCloud 平台提供的 `csi-standard` 标准存储类型为例。您可以根据需要选择其他存储类型。 - -8. 由于一些 PersistentVolume 只支持特定的访问模式，页面上显示的访问模式会因您选择的存储类型而不同。访问模式一共有三种： +6. 由于一些 PersistentVolume 只支持特定的访问模式，页面上显示的访问模式会因您选择的存储类型而不同。访问模式一共有三种： - **ReadWriteOnce (RWO)**：存储卷以单节点读写的形式挂载。 - **ReadOnlyMany (ROX)**：存储卷以多节点只读的形式挂载。 @@ -61,17 +53,13 @@ weight: 10310 选择所需的访问模式。 -9. 在**存储卷容量**区域设置存储卷的大小，然后点击**下一步**。 +7. 在**存储卷容量**区域设置存储卷的大小，然后点击**下一步**。 - ![volume-finished](/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-finished.jpg) +8. 在**高级设置**页面，您可以为存储卷添加元数据，例如 **Label** 和 **Annotation**。元数据可用作搜索和调度资源的标识符。 -10. 在**高级设置**页面，您可以为存储卷添加元数据，例如 **Label** 和 **Annotation**。元数据可用作搜索和调度资源的标识符。 +9. 点击**创建**完成存储卷创建。 -11. 点击**创建**完成存储卷创建。 - - ![volume-finish-creation](/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-finish-creation.jpg) - -12. 新建的存储卷会显示在项目的**存储卷**页面。存储卷挂载至工作负载后，**挂载**列会显示为**已挂载**。 +10. 新建的存储卷会显示在项目的**存储卷**页面。存储卷挂载至工作负载后，**挂载**列会显示为**已挂载**。 ![volume-status](/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-status.jpg) @@ -81,7 +69,7 @@ weight: 10310 {{}} -13. 一些存储卷是动态供应的存储卷，它们的状态会在创建后立刻从**等待中**变为**准备就绪**。其他仍处于**等待中**的存储卷会在挂载至工作负载后变为**准备就绪**。存储卷是否支持动态供应取决于其存储类型。 +11. 一些存储卷是动态供应的存储卷，它们的状态会在创建后立刻从**等待中**变为**准备就绪**。其他仍处于**等待中**的存储卷会在挂载至工作负载后变为**准备就绪**。存储卷是否支持动态供应取决于其存储类型。 ![local-pending](/images/docs/zh-cn/project-user-guide/volume-management/volumes/local-pending.jpg) diff --git a/static/images/docs/project-user-guide/volume-management/volumes/basic-volume-info.jpg b/static/images/docs/project-user-guide/volume-management/volumes/basic-volume-info.jpg deleted file mode 100644 index eca98e33e..000000000 Binary files a/static/images/docs/project-user-guide/volume-management/volumes/basic-volume-info.jpg and /dev/null differ diff --git a/static/images/docs/project-user-guide/volume-management/volumes/create-volume.jpg b/static/images/docs/project-user-guide/volume-management/volumes/create-volume.jpg deleted file mode 100644 index b6f0fde53..000000000 Binary files a/static/images/docs/project-user-guide/volume-management/volumes/create-volume.jpg and /dev/null differ diff --git a/static/images/docs/project-user-guide/volume-management/volumes/volume-creation-method.jpg b/static/images/docs/project-user-guide/volume-management/volumes/volume-creation-method.jpg deleted file mode 100644 index 11da96d45..000000000 Binary files a/static/images/docs/project-user-guide/volume-management/volumes/volume-creation-method.jpg and /dev/null differ diff --git a/static/images/docs/project-user-guide/volume-management/volumes/volume-finish-creation.jpg b/static/images/docs/project-user-guide/volume-management/volumes/volume-finish-creation.jpg deleted file mode 100644 index afc387f51..000000000 Binary files a/static/images/docs/project-user-guide/volume-management/volumes/volume-finish-creation.jpg and /dev/null differ diff --git a/static/images/docs/project-user-guide/volume-management/volumes/volume-finished.jpg b/static/images/docs/project-user-guide/volume-management/volumes/volume-finished.jpg deleted file mode 100644 index 0b7318b1b..000000000 Binary files a/static/images/docs/project-user-guide/volume-management/volumes/volume-finished.jpg and /dev/null differ diff --git a/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/basic-volume-info.jpg b/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/basic-volume-info.jpg deleted file mode 100644 index 34259d2f7..000000000 Binary files a/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/basic-volume-info.jpg and /dev/null differ diff --git a/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/create-volume.jpg b/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/create-volume.jpg deleted file mode 100644 index 11a97aad3..000000000 Binary files a/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/create-volume.jpg and /dev/null differ diff --git a/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-creation-method.jpg b/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-creation-method.jpg deleted file mode 100644 index 1ff05e020..000000000 Binary files a/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-creation-method.jpg and /dev/null differ diff --git a/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-finish-creation.jpg b/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-finish-creation.jpg deleted file mode 100644 index f327dd007..000000000 Binary files a/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-finish-creation.jpg and /dev/null differ diff --git a/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-finished.jpg b/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-finished.jpg deleted file mode 100644 index d6afa298f..000000000 Binary files a/static/images/docs/zh-cn/project-user-guide/volume-management/volumes/volume-finished.jpg and /dev/null differ