Skip to content

Commit

Permalink
[zh] Sync config-and-storage-resources/storage-class-v1.md
Browse files Browse the repository at this point in the history
  • Loading branch information
windsonsea committed Oct 6, 2024
1 parent 0f0ee83 commit 6bf10e8
Showing 1 changed file with 80 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "StorageClass 为可以动态制备 PersistentVolume 的存储类描述参数。"
title: "StorageClass"
weight: 6
weight: 8
---
<!--
api_metadata:
Expand All @@ -16,14 +16,16 @@ api_metadata:
content_type: "api_reference"
description: "StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned."
title: "StorageClass"
weight: 6
weight: 8
auto_generated: true
-->

`apiVersion: storage.k8s.io/v1`

`import "k8s.io/api/storage/v1"`

## StorageClass {#StorageClass}

<!--
StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.
Expand All @@ -41,13 +43,16 @@ StorageClass 是不受名字空间作用域限制的;按照 etcd 设定的存

<!--
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **provisioner** (string), required
provisioner indicates the type of the provisioner.
- **allowVolumeExpansion** (boolean)
allowVolumeExpansion shows whether the storage class allow volume expand
allowVolumeExpansion shows whether the storage class allow volume expand.
-->
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)

Expand All @@ -64,6 +69,7 @@ StorageClass 是不受名字空间作用域限制的;按照 etcd 设定的存

<!--
- **allowedTopologies** ([]TopologySelectorTerm)
*Atomic: will be replaced during a merge*
allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
Expand All @@ -79,50 +85,70 @@ StorageClass 是不受名字空间作用域限制的;按照 etcd 设定的存
空的 TopologySelectorTerm 列表意味着没有拓扑限制。
只有启用 VolumeScheduling 功能特性的服务器才能使用此字段。

<a name="TopologySelectorTerm"></a>
<a name="TopologySelectorTerm"></a>
**拓扑选择器条件表示标签查询的结果。
一个 null 或空的拓扑选择器条件不会匹配任何对象。各个条件的要求按逻辑与的关系来计算。
此选择器作为 NodeSelectorTerm 所提供功能的子集。此功能为 Alpha 特性,将来可能会变更。**
此选择器作为 NodeSelectorTerm 所提供功能的子集。这是一个 Alpha 特性,将来可能会变更。**

<!--
<!--
- **allowedTopologies.matchLabelExpressions** ([]TopologySelectorLabelRequirement)
*Atomic: will be replaced during a merge*
A list of topology selector requirements by labels.
<a name="TopologySelectorLabelRequirement"></a>
*A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.*
-->

- **allowedTopologies.matchLabelExpressions** ([]TopologySelectorLabelRequirement)

**原子性:将在合并期间被替换**

按标签设置的拓扑选择器要求的列表。

<a name="TopologySelectorLabelRequirement"></a>
**拓扑选择器要求是与给定标签匹配的一个选择器。这是一个 Alpha 特性,将来可能会变更。**

<!--
- **allowedTopologies.matchLabelExpressions.key** (string), required
The label key that the selector applies to.
- **allowedTopologies.matchLabelExpressions.values** ([]string), required
*Atomic: will be replaced during a merge*
An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
-->
- **allowedTopologies.matchLabelExpressions** ([]TopologySelectorLabelRequirement)
-->

按标签设置的拓扑选择器要求的列表。

<a name="TopologySelectorLabelRequirement"></a>
**拓扑选择器要求是与给定标签匹配的一个选择器。此功能为 Alpha 特性,将来可能会变更。**

- **allowedTopologies.matchLabelExpressions.key** (string),必需

选择器所针对的标签键。

- **allowedTopologies.matchLabelExpressions.values** ([]string),必需

字符串数组。一个值必须与要选择的标签匹配。values 中的每个条目按逻辑或的关系来计算。
**原子性:将在合并期间被替换**

字符串值的数组。一个值必须与要选择的标签匹配。values 中的每个条目按逻辑或的关系来计算。

<!--
- **mountOptions** ([]string)
*Atomic: will be replaced during a merge*
mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
- **parameters** (map[string]string)
parameters holds the parameters for the provisioner that should create volumes of this storage class.
-->
- **mountOptions** ([]string)

mountOptions 控制此存储类动态制备的 PersistentVolume 的挂载配置。
(例如 ["ro", "soft"])。
系统对选项作检查——如果有一个选项无效,则这些 PV 的挂载将失败。
**原子性:将在合并期间被替换**

mountOptions 控制此存储类动态制备的 PersistentVolume 的挂载配置,例如 ["ro", "soft"]
针对此字段无合法性检查 —— 如果有一个选项无效,则这些 PV 的挂载将失败。

- **parameters** (map[string]string)

Expand All @@ -134,6 +160,7 @@ StorageClass 是不受名字空间作用域限制的;按照 etcd 设定的存
reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.
- **volumeBindingMode** (string)
volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.
-->
- **reclaimPolicy** (string)
Expand All @@ -147,6 +174,7 @@ StorageClass 是不受名字空间作用域限制的;按照 etcd 设定的存
只有启用 VolumeScheduling 功能特性的服务器才能使用此字段。

## StorageClassList {#StorageClassList}

<!--
StorageClassList is a collection of storage classes.
-->
Expand All @@ -160,9 +188,11 @@ StorageClassList 是存储类的集合。

<!--
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>), required
items is the list of StorageClasses
-->
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
Expand All @@ -184,7 +214,9 @@ StorageClassList 是存储类的集合。
<hr>

### `get` 读取指定的 StorageClass

#### HTTP 请求

GET /apis/storage.k8s.io/v1/storageclasses/{name}

<!--
Expand All @@ -194,9 +226,10 @@ GET /apis/storage.k8s.io/v1/storageclasses/{name}
- **pretty** (*in query*): string
-->
#### 参数

- **name** (**路径参数**): string,必需

StorageClass 的名称
StorageClass 的名称

- **pretty** (**查询参数**): string

Expand All @@ -206,6 +239,7 @@ GET /apis/storage.k8s.io/v1/storageclasses/{name}
#### Response
-->
#### 响应

200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>): OK

401: Unauthorized
Expand All @@ -215,7 +249,9 @@ GET /apis/storage.k8s.io/v1/storageclasses/{name}
#### HTTP Request
-->
### `list` 列出或观测类别为 StorageClass 的对象

#### HTTP 请求

GET /apis/storage.k8s.io/v1/storageclasses

<!--
Expand All @@ -232,6 +268,7 @@ GET /apis/storage.k8s.io/v1/storageclasses
- **watch** (*in query*): boolean
-->
#### 参数

- **allowWatchBookmarks** (**查询参数**): boolean

<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a>
Expand Down Expand Up @@ -280,6 +317,7 @@ GET /apis/storage.k8s.io/v1/storageclasses
#### Response
-->
#### 响应

200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClassList" >}}">StorageClassList</a>): OK

401: Unauthorized
Expand All @@ -289,7 +327,9 @@ GET /apis/storage.k8s.io/v1/storageclasses
#### HTTP Request
-->
### `create` 创建 StorageClass

#### HTTP 请求

POST /apis/storage.k8s.io/v1/storageclasses

<!--
Expand All @@ -301,6 +341,7 @@ POST /apis/storage.k8s.io/v1/storageclasses
- **pretty** (*in query*): string
-->
#### 参数

- **body**: <a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>,必需

- **dryRun** (**查询参数**): string
Expand All @@ -323,6 +364,7 @@ POST /apis/storage.k8s.io/v1/storageclasses
#### Response
-->
#### 响应

200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>): OK

201 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>): Created
Expand All @@ -336,7 +378,9 @@ POST /apis/storage.k8s.io/v1/storageclasses
#### HTTP Request
-->
### `update` 替换指定的 StorageClass

#### HTTP 请求

PUT /apis/storage.k8s.io/v1/storageclasses/{name}

<!--
Expand All @@ -350,9 +394,10 @@ PUT /apis/storage.k8s.io/v1/storageclasses/{name}
- **pretty** (*in query*): string
-->
#### 参数

- **name** (**路径参数**): string,必需

StorageClass 的名称
StorageClass 的名称

- **body**: <a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>,必需

Expand All @@ -376,6 +421,7 @@ PUT /apis/storage.k8s.io/v1/storageclasses/{name}
#### Response
-->
#### 响应

200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>): OK

201 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>): Created
Expand All @@ -387,7 +433,9 @@ PUT /apis/storage.k8s.io/v1/storageclasses/{name}
#### HTTP Request
-->
### `patch` 部分更新指定的 StorageClass

#### HTTP 请求

PATCH /apis/storage.k8s.io/v1/storageclasses/{name}

<!--
Expand All @@ -402,9 +450,10 @@ PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
- **pretty** (*in query*): string
-->
#### 参数

- **name** (**路径参数**): string,必需

StorageClass 的名称
StorageClass 的名称

- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>,必需

Expand Down Expand Up @@ -432,6 +481,7 @@ PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
#### Response
-->
#### 响应

200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>): OK

201 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>): Created
Expand All @@ -443,7 +493,9 @@ PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
#### HTTP Request
-->
### `delete` 删除 StorageClass

#### HTTP 请求

DELETE /apis/storage.k8s.io/v1/storageclasses/{name}

<!--
Expand All @@ -457,9 +509,10 @@ DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
- **propagationPolicy** (*in query*): string
-->
#### 参数

- **name** (**路径参数**): string,必需

StorageClass 的名称
StorageClass 的名称

- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>

Expand All @@ -483,6 +536,7 @@ DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
#### Response
-->
#### 响应

200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>): OK

202 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>): Accepted
Expand All @@ -494,7 +548,9 @@ DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
#### HTTP Request
-->
### `deletecollection` 删除 StorageClass 的集合

#### HTTP 请求

DELETE /apis/storage.k8s.io/v1/storageclasses

<!--
Expand All @@ -513,6 +569,7 @@ DELETE /apis/storage.k8s.io/v1/storageclasses
- **timeoutSeconds** (*in query*): integer
-->
#### 参数

- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>

- **continue** (**查询参数**): string
Expand Down Expand Up @@ -567,6 +624,7 @@ DELETE /apis/storage.k8s.io/v1/storageclasses
#### Response
-->
#### 响应

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK

401: Unauthorized

0 comments on commit 6bf10e8

Please sign in to comment.