Skip to content

Commit

Permalink
Merge pull request #3208 from zhuxiujuan28/docs
Browse files Browse the repository at this point in the history
【Documentation】improve docs about extensions
  • Loading branch information
ks-ci-bot authored Nov 8, 2024
2 parents ae0cfc6 + ca8c3e7 commit 1cc2216
Show file tree
Hide file tree
Showing 72 changed files with 1,060 additions and 474 deletions.
Original file line number Diff line number Diff line change
@@ -1,76 +1,63 @@
// :ks_include_id: 4527bd133db04495b10cf1930a58d5f9
. **基本信息**页签,设置持久卷声明的基本信息,然后点击**下一步**
. On the **Basic Information** tab, set the basic information for the persistent volume claim, then click **Next**.
+
--
[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

|名称
|持久卷声明的名称。名称只能包含小写字母、数字和连字符(-),必须以小写字母或数字开头和结尾,最长 253 个字符。
|Name
|The name of the persistent volume claim. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 253 characters long.

|别名
|持久卷声明的别名。不同持久卷声明的别名可以相同。别名只能包含中文、字母、数字和连字符(-),不得以连字符(-)开头或结尾,最长 63 个字符。
|Alias
|The alias of the persistent volume claim. Different persistent volume claims can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-), with a maximum length of 63 characters.

|描述
|持久卷声明的描述信息。描述可包含任意字符,最长 256 个字符。
|Description
|The description of the persistent volume claim. The description can contain any characters, with a maximum of 256 characters.
|===
--

. **存储设置**页签,设置存储空间需求,然后点击**下一步**
. On the **Storage Settings** tab, set the storage space requirements, then click **Next**.
+
--
[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

// |创建方式
// |持久卷声明的创建方式。

// * **通过存储类创建**:选择当前项目中的存储类来创建持久卷声明。

// * **通过卷快照创建**:选择当前项目中的卷快照来创建持久卷声明。

// |存储类
// |用于创建持久卷声明的存储类。仅在持久卷声明创建方式为**通过存储类创建**时可用。

// |卷快照
// |用于创建持久卷声明的卷快照。仅在持久卷声明创建方式为**通过卷快照创建**时可用。

|访问模式
|Access Mode
|
include::persistentVolumeClaims-para-accessMode.adoc[]

取决于后端的存储系统,某些访问模式类型可能不可用。
Depending on the backend storage system, some access mode types may not be available.

|卷容量
|持久卷声明的对应的卷容量大小。
|Volume Capacity
|The capacity size of the volume corresponding to the persistent volume claim.
|===
--

. **高级设置**页签,设置持久卷声明的标签和注解,然后点击**创建**
. On the **Advanced Settings** tab, set the labels and annotations for the persistent volume claim, then click **Create**.
+
--
include::../workloads/createWorkload/workloads-para-Metadata.adoc[]
--

. **集群差异设置**页签,为不同集群中的持久卷声明使用不同的存储设置。
. On the **Cluster Differences** tab, use different storage settings for the persistent volume claim in different clusters.
+
--
[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

|存储类
|用于创建持久卷声明的存储类。
|Storage Class
|The storage class used to create the persistent volume claim.

|访问模式
|Access Mode
|
include::persistentVolumeClaims-para-accessMode.adoc[]

|卷容量
|通过持久卷声明模板创建的每个持久卷的容量。
|Volume Capacity
|The capacity of each persistent volume created from the persistent volume claim.
|===

持久卷声明创建完成后将显示在持久卷声明列表中。
--
After the persistent volume claim is created, it will be displayed in the persistent volume claim list.
--
Original file line number Diff line number Diff line change
@@ -1,101 +1,100 @@
// :ks_include_id: e06b7d959620413ebfcc3bfe526b03d1
. 在持久卷声明详情页面左侧的**属性**区域查看持久卷声明的资源属性。
. On the details page, view the resource attributes of the persistent volume claim in the **Attributes** area on the left.
+
--
[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

|项目
|持久卷声明所属的项目。
|Project
|The project to which the persistent volume claim belongs.

// |状态
// |Status
// |
// include::persistentVolumeClaims-para-status.adoc[]

|容量
|持久卷声明请求的存储容量大小。
|Capacity
|The storage capacity size requested by the persistent volume claim.

|访问模式
|Access Mode
|
include::persistentVolumeClaims-para-accessMode.adoc[]

|存储类
|持久卷声明请求的存储类。
|Storage Class
|The storage class requested by the persistent volume claim.

|供应者
|Provisioner
|
include::../persistentVolumes/persistentVolumes-para-provisioner.adoc[]

// |持久卷
// |与持久卷声明绑定的持久卷。
// |Persistent Volume
// |The persistent volume bound to the persistent volume claim.

|创建时间
|持久卷声明的创建时间。
|Creation Time
|The creation time of the persistent volume claim.

|创建者
|创建持久卷声明的用户。如果该字段的值为空,则表明持久卷声明由系统自动创建。
|Creator
|The user who created the persistent volume claim. If this field is empty, it indicates that the persistent volume claim was created automatically by the system.
|===
--

. 在持久卷声明详情页面右侧的**资源状态**页签查看持久卷声明对应持久卷的资源用量。
. On the details page, view the resource usage of the persistent volume corresponding to the persistent volume claim in the **Resource Status** tab on the right.
+
--
[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

|持久卷
|显示持久卷的已使用容量百分比、剩余容量大小和总容量大小。

|Inode 用量
|显示指定时间范围内的集群 Inode 使用量百分比。
|Persistent Volume
|Displays the used capacity percentage, remaining capacity size, and total capacity size of the persistent volume.

|Inode Usage
|Displays the Inode usage percentage of the cluster within the specified time range.
|===
--

. 在持久卷声明详情页面右侧的**挂载信息**页签查看持久卷声明对应持久卷的已挂载容器组。
. On the details page, view the pods that have mounted the persistent volume corresponding to the persistent volume claim in the **Mount Information** tab on the right.
+
--
// include::../nodes/nodes-para-podList.adoc[]

点击image:/images/ks-qkcp/zh/icons/chevron-down.svg["chevron-down",18,18]可查看容器组中运行的容器的信息。
Click image:/images/ks-qkcp/zh/icons/chevron-down.svg["chevron-down",18,18] to view the information of the containers running in the pod.
--

. 在持久卷声明详情页面右侧点击**元数据**页签查看持久卷声明的标签和注解。
. On the persistent volume claim details page, click the **Metadata** tab on the right to view the labels and annotations of the persistent volume claim.

. 在持久卷声明详情页面右侧点击**事件**页签查看持久卷声明的事件。
. On the persistent volume claim details page, click the **Events** tab on the right to view events related to the persistent volume claim.
+
--
include::../clusterManagement-para-eventsTab.adoc[]
--

// . 在持久卷声明详情页面右侧的**快照**页签查看持久卷声明对应持久卷的快照。
// . On the persistent volume claim details page, view the snapshots of the persistent volume corresponding to the persistent volume claim in the **Snapshots** tab on the right.
// +
// --

// [%header,cols="1a,4a"]
// |===
// |参数 |描述
// |Parameter |Description

// |名称
// |快照的名称、别名和快照类。
// |Name
// |The name, alias, and snapshot class of the snapshot.

// |状态
// |快照的状态。
// |Status
// |The status of the snapshot.

// * **创建中**:快照正在创建中。
// * **Creating**: The snapshot is being created.

// * **创建失败**:快照创建失败。
// * **Creation Failed**: The snapshot creation failed.

// * **创建成功**:快照创建成功。
// * **Creation Succeeded**: The snapshot creation succeeded.

// * **删除中**:正在删除快照。
// * **Deleting**: The snapshot is being deleted.

// |容量
// |快照的容量大小。
// |Capacity
// |The capacity size of the snapshot.

// |创建时间
// |快照的创建时间。
// |Creation Time
// |The creation time of the snapshot.
// |===
// --
// --
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,13 @@ ifndef::kubefed[]
|The Persistent Volume bound to the Persistent Volume Claim.
endif::[]

|Mount Status
|Whether the Persistent Volume associated with the Persistent Volume Claim is already mounted to a container.

|Access Mode
|
include::persistentVolumeClaims-para-accessMode.adoc[]

|Mount Status
|Whether the Persistent Volume associated with the Persistent Volume Claim is already mounted to a container.

|Creation Time
|The creation time of the Persistent Volume Claim.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
// :ks_include_id: 5e0c07e44f1440999412a1ec7581f173
. **编辑项目配额**对话框,设置项目资源预留和资源上限。
. In the **Edit Project Quotas** dialog, set the resource requests and resource limits.
+
--

[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

|CPU 预留
|项目中所有容器 CPU 预留总和的最大值,单位为核。
|CPU Requests
|The maximum sum of CPU reservations for all containers in the project, in cores.

|CPU 上限
|项目中所有容器 CPU 上限总和的最大值,单位为核。
|CPU Limit
|The maximum sum of CPU limits for all containers in the project, in cores.

|内存预留
|项目中所有容器内存预留总和的最大值,单位为 GiB
|Memory Requests
|The maximum sum of memory reservations for all containers in the project, in GiB.

|内存上限
|项目中所有容器内存上限总和的最大值,单位为 GiB
|Memory Limit
|The maximum sum of memory limits for all containers in the project, in GiB.

|GPU 类型
|项目中容器所能使用的 GPU 类型。目前仅支持设置 NVIDIA GPU
|GPU Type
|The type of GPU that containers in the project can use. Currently, only NVIDIA GPU is supported.

|GPU 上限
|项目中所有容器可以使用的 GPU 数量上限,单位为 GPU。
|GPU Limit
|The maximum number of GPUs that all containers in the project can use, in GPUs.
|===
--

. **编辑项目配额**对话框的**存储资源配额**区域,设置存储资源总量和存储类关联资源。
. In the **Edit Project Quotas** dialog, set the total storage resources and storage class-related resources in the **Storage Resource Quotas** area.

. **编辑项目配额**对话框的**应用资源配额**区域,设置项目的应用资源数量上限,然后点击**确定**
. In the **Edit Project Quotas** dialog, set the maximum number of application resources for the project in the **Application Resource Quotas** area, then click **OK**.
+
--
* 您可以设置项目中容器组、部署、有状态副本集、持久卷声明、服务、应用路由、保密字典和配置字典的数量上限。
* You can set the maximum number of pods, deployments, statefulsets, persistent volume claims, services, ingresses, secrets, and configmaps in the project.

* 点击**添加**可以设置多种应用资源的数量上限。
--
* Click **Add** to set the maximum number for multiple application resources.
--
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
// :ks_include_id: a53d1d6e1dd4460e8fc6ff4476b08e2c
. 在保密字典详情页面左侧的**属性**区域查看保密字典的资源属性。
. On the details page, view the resource attributes of the Secret in the **Attributes** area on the left.
+
--
[%header,cols="1a,4a"]
|===
|参数 |描述
|Parameter |Description

// |集群
// |保密字典所属的集群。
// |Cluster
// |The cluster to which the secret belongs.

|项目
|保密字典所属的项目。
|Project
|The project to which the secret belongs.

|类型
|Type
|
include::secrets-para-type.adoc[]

|创建时间
|保密字典的创建时间。
|Creation Time
|The creation time of the secret.

|更新时间
|保密字典的更新时间。
|Update Time
|The update time of the secret.

|创建者
|创建保密字典的用户。
|Creator
|The user who created the secret.

|===
--

. 在保密字典右侧的**数据**页签查看保密字典存储的键值对数据。
. On the right side of the details page, view the key-value data stored in the Secret in the **Data** tab.
+
--
// Note
include::../../../../_ks_components-en/admonitions/tip.adoc[]

保密字典使用 Base64 数据编码。在**数据**页签右上角点击image:/images/ks-qkcp/zh/icons/eye-closed.svg[eye,18,18]/image:/images/ks-qkcp/zh/icons/eye.svg[eye-closed,18,18]可显示/隐藏数据明文。
The Secret uses Base64 data encoding. Click image:/images/ks-qkcp/zh/icons/eye-closed.svg[eye,18,18]/image:/images/ks-qkcp/zh/icons/eye.svg[eye-closed,18,18] in the top-right corner of the **Data** tab to show/hide the plaintext data.

include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
--
--
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// :ks_include_id: b4d12ee4d7d748a4915f6f72d47fa1d7
本节介绍如何管理配置资源。
This section describes how to manage configuration resources.

{ks_product-en}支持管理以下两类配置资源:
{ks_product-en} supports managing the following two types of configuration resources:

* 保密字典:包含 Base64 编码的键值对,用于存储密码、令牌、密钥等保密数据。
* Secret: Contains Base64-encoded key-value pairs used to store confidential data such as passwords, tokens, and keys.
* 配置字典:包含明文键值对,用于存储普通配置数据。
* ConfigMap: Contains plaintext key-value pairs used to store general configuration data.
Loading

0 comments on commit 1cc2216

Please sign in to comment.