@@ -6,7 +6,7 @@ api_metadata:
6
6
content_type : " api_reference"
7
7
description : " StorageClass 为可以动态制备 PersistentVolume 的存储类描述参数。"
8
8
title : " StorageClass"
9
- weight : 6
9
+ weight : 8
10
10
---
11
11
<!--
12
12
api_metadata:
@@ -16,14 +16,16 @@ api_metadata:
16
16
content_type: "api_reference"
17
17
description: "StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned."
18
18
title: "StorageClass"
19
- weight: 6
19
+ weight: 8
20
+ auto_generated: true
20
21
-->
21
22
22
23
` apiVersion: storage.k8s.io/v1 `
23
24
24
25
` import "k8s.io/api/storage/v1" `
25
26
26
27
## StorageClass {#StorageClass}
28
+
27
29
<!--
28
30
StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.
29
31
@@ -41,13 +43,16 @@ StorageClass 是不受名字空间作用域限制的;按照 etcd 设定的存
41
43
42
44
<!--
43
45
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
46
+
44
47
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
45
48
46
49
- **provisioner** (string), required
50
+
47
51
provisioner indicates the type of the provisioner.
48
52
49
53
- **allowVolumeExpansion** (boolean)
50
- allowVolumeExpansion shows whether the storage class allow volume expand
54
+
55
+ allowVolumeExpansion shows whether the storage class allow volume expand.
51
56
-->
52
57
- ** metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a >)
53
58
@@ -64,6 +69,7 @@ StorageClass 是不受名字空间作用域限制的;按照 etcd 设定的存
64
69
65
70
<!--
66
71
- **allowedTopologies** ([]TopologySelectorTerm)
72
+
67
73
*Atomic: will be replaced during a merge*
68
74
69
75
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.
@@ -79,50 +85,70 @@ StorageClass 是不受名字空间作用域限制的;按照 etcd 设定的存
79
85
空的 TopologySelectorTerm 列表意味着没有拓扑限制。
80
86
只有启用 VolumeScheduling 功能特性的服务器才能使用此字段。
81
87
82
- <a name =" TopologySelectorTerm " ></a >
88
+ <a name =" TopologySelectorTerm " ></a >
83
89
** 拓扑选择器条件表示标签查询的结果。
84
90
一个 null 或空的拓扑选择器条件不会匹配任何对象。各个条件的要求按逻辑与的关系来计算。
85
- 此选择器作为 NodeSelectorTerm 所提供功能的子集。此功能为 Alpha 特性,将来可能会变更。**
91
+ 此选择器作为 NodeSelectorTerm 所提供功能的子集。这是一个 Alpha 特性,将来可能会变更。**
86
92
87
- <!--
93
+ <!--
88
94
- **allowedTopologies.matchLabelExpressions** ([]TopologySelectorLabelRequirement)
95
+
96
+ *Atomic: will be replaced during a merge*
97
+
89
98
A list of topology selector requirements by labels.
99
+
90
100
<a name="TopologySelectorLabelRequirement"></a>
91
101
*A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.*
102
+ -->
103
+
104
+ - ** allowedTopologies.matchLabelExpressions** ([ ] TopologySelectorLabelRequirement)
105
+
106
+ ** 原子性:将在合并期间被替换**
107
+
108
+ 按标签设置的拓扑选择器要求的列表。
109
+
110
+ <a name =" TopologySelectorLabelRequirement " ></a >
111
+ ** 拓扑选择器要求是与给定标签匹配的一个选择器。这是一个 Alpha 特性,将来可能会变更。**
92
112
113
+ <!--
93
114
- **allowedTopologies.matchLabelExpressions.key** (string), required
115
+
94
116
The label key that the selector applies to.
117
+
95
118
- **allowedTopologies.matchLabelExpressions.values** ([]string), required
119
+
120
+ *Atomic: will be replaced during a merge*
121
+
96
122
An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
97
- -->
98
- - ** allowedTopologies.matchLabelExpressions** ([ ] TopologySelectorLabelRequirement)
123
+ -->
99
124
100
- 按标签设置的拓扑选择器要求的列表。
101
-
102
- <a name =" TopologySelectorLabelRequirement " ></a >
103
- ** 拓扑选择器要求是与给定标签匹配的一个选择器。此功能为 Alpha 特性,将来可能会变更。**
104
-
105
125
- ** allowedTopologies.matchLabelExpressions.key** (string),必需
106
126
107
127
选择器所针对的标签键。
108
-
128
+
109
129
- ** allowedTopologies.matchLabelExpressions.values** ([ ] string),必需
110
130
111
- 字符串数组。一个值必须与要选择的标签匹配。values 中的每个条目按逻辑或的关系来计算。
131
+ ** 原子性:将在合并期间被替换**
132
+
133
+ 字符串值的数组。一个值必须与要选择的标签匹配。values 中的每个条目按逻辑或的关系来计算。
112
134
113
135
<!--
114
136
- **mountOptions** ([]string)
115
137
138
+ *Atomic: will be replaced during a merge*
139
+
116
140
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.
117
141
118
142
- **parameters** (map[string]string)
143
+
119
144
parameters holds the parameters for the provisioner that should create volumes of this storage class.
120
145
-->
121
146
- ** mountOptions** ([ ] string)
122
147
123
- mountOptions 控制此存储类动态制备的 PersistentVolume 的挂载配置。
124
- (例如 [ "ro", "soft"] )。
125
- 系统对选项作检查——如果有一个选项无效,则这些 PV 的挂载将失败。
148
+ ** 原子性:将在合并期间被替换**
149
+
150
+ mountOptions 控制此存储类动态制备的 PersistentVolume 的挂载配置,例如 [ "ro", "soft"] 。
151
+ 针对此字段无合法性检查 —— 如果有一个选项无效,则这些 PV 的挂载将失败。
126
152
127
153
- ** parameters** (map[ string] string)
128
154
@@ -134,6 +160,7 @@ StorageClass 是不受名字空间作用域限制的;按照 etcd 设定的存
134
160
reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.
135
161
136
162
- **volumeBindingMode** (string)
163
+
137
164
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.
138
165
-->
139
166
- ** reclaimPolicy** (string)
@@ -147,6 +174,7 @@ StorageClass 是不受名字空间作用域限制的;按照 etcd 设定的存
147
174
只有启用 VolumeScheduling 功能特性的服务器才能使用此字段。
148
175
149
176
## StorageClassList {#StorageClassList}
177
+
150
178
<!--
151
179
StorageClassList is a collection of storage classes.
152
180
-->
@@ -160,9 +188,11 @@ StorageClassList 是存储类的集合。
160
188
161
189
<!--
162
190
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
191
+
163
192
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
164
193
165
194
- **items** ([]<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>), required
195
+
166
196
items is the list of StorageClasses
167
197
-->
168
198
- ** metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a >)
@@ -184,7 +214,9 @@ StorageClassList 是存储类的集合。
184
214
<hr >
185
215
186
216
### ` get ` 读取指定的 StorageClass
217
+
187
218
#### HTTP 请求
219
+
188
220
GET /apis/storage.k8s.io/v1/storageclasses/{name}
189
221
190
222
<!--
@@ -194,9 +226,10 @@ GET /apis/storage.k8s.io/v1/storageclasses/{name}
194
226
- **pretty** (*in query*): string
195
227
-->
196
228
#### 参数
229
+
197
230
- ** name** (** 路径参数** ): string,必需
198
231
199
- StorageClass 的名称
232
+ StorageClass 的名称。
200
233
201
234
- ** pretty** (** 查询参数** ): string
202
235
@@ -206,6 +239,7 @@ GET /apis/storage.k8s.io/v1/storageclasses/{name}
206
239
#### Response
207
240
-->
208
241
#### 响应
242
+
209
243
200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >): OK
210
244
211
245
401: Unauthorized
@@ -215,7 +249,9 @@ GET /apis/storage.k8s.io/v1/storageclasses/{name}
215
249
#### HTTP Request
216
250
-->
217
251
### ` list ` 列出或观测类别为 StorageClass 的对象
252
+
218
253
#### HTTP 请求
254
+
219
255
GET /apis/storage.k8s.io/v1/storageclasses
220
256
221
257
<!--
@@ -232,6 +268,7 @@ GET /apis/storage.k8s.io/v1/storageclasses
232
268
- **watch** (*in query*): boolean
233
269
-->
234
270
#### 参数
271
+
235
272
- ** allowWatchBookmarks** (** 查询参数** ): boolean
236
273
237
274
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a >
@@ -280,6 +317,7 @@ GET /apis/storage.k8s.io/v1/storageclasses
280
317
#### Response
281
318
-->
282
319
#### 响应
320
+
283
321
200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClassList" >}}">StorageClassList</a >): OK
284
322
285
323
401: Unauthorized
@@ -289,7 +327,9 @@ GET /apis/storage.k8s.io/v1/storageclasses
289
327
#### HTTP Request
290
328
-->
291
329
### ` create ` 创建 StorageClass
330
+
292
331
#### HTTP 请求
332
+
293
333
POST /apis/storage.k8s.io/v1/storageclasses
294
334
295
335
<!--
@@ -301,6 +341,7 @@ POST /apis/storage.k8s.io/v1/storageclasses
301
341
- **pretty** (*in query*): string
302
342
-->
303
343
#### 参数
344
+
304
345
- ** body** : <a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >,必需
305
346
306
347
- ** dryRun** (** 查询参数** ): string
@@ -323,6 +364,7 @@ POST /apis/storage.k8s.io/v1/storageclasses
323
364
#### Response
324
365
-->
325
366
#### 响应
367
+
326
368
200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >): OK
327
369
328
370
201 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >): Created
@@ -336,7 +378,9 @@ POST /apis/storage.k8s.io/v1/storageclasses
336
378
#### HTTP Request
337
379
-->
338
380
### ` update ` 替换指定的 StorageClass
381
+
339
382
#### HTTP 请求
383
+
340
384
PUT /apis/storage.k8s.io/v1/storageclasses/{name}
341
385
342
386
<!--
@@ -350,9 +394,10 @@ PUT /apis/storage.k8s.io/v1/storageclasses/{name}
350
394
- **pretty** (*in query*): string
351
395
-->
352
396
#### 参数
397
+
353
398
- ** name** (** 路径参数** ): string,必需
354
399
355
- StorageClass 的名称
400
+ StorageClass 的名称。
356
401
357
402
- ** body** : <a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >,必需
358
403
@@ -376,6 +421,7 @@ PUT /apis/storage.k8s.io/v1/storageclasses/{name}
376
421
#### Response
377
422
-->
378
423
#### 响应
424
+
379
425
200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >): OK
380
426
381
427
201 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >): Created
@@ -387,7 +433,9 @@ PUT /apis/storage.k8s.io/v1/storageclasses/{name}
387
433
#### HTTP Request
388
434
-->
389
435
### ` patch ` 部分更新指定的 StorageClass
436
+
390
437
#### HTTP 请求
438
+
391
439
PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
392
440
393
441
<!--
@@ -402,9 +450,10 @@ PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
402
450
- **pretty** (*in query*): string
403
451
-->
404
452
#### 参数
453
+
405
454
- ** name** (** 路径参数** ): string,必需
406
455
407
- StorageClass 的名称
456
+ StorageClass 的名称。
408
457
409
458
- ** body** : <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a >,必需
410
459
@@ -432,6 +481,7 @@ PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
432
481
#### Response
433
482
-->
434
483
#### 响应
484
+
435
485
200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >): OK
436
486
437
487
201 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >): Created
@@ -443,7 +493,9 @@ PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
443
493
#### HTTP Request
444
494
-->
445
495
### ` delete ` 删除 StorageClass
496
+
446
497
#### HTTP 请求
498
+
447
499
DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
448
500
449
501
<!--
@@ -457,9 +509,10 @@ DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
457
509
- **propagationPolicy** (*in query*): string
458
510
-->
459
511
#### 参数
512
+
460
513
- ** name** (** 路径参数** ): string,必需
461
514
462
- StorageClass 的名称
515
+ StorageClass 的名称。
463
516
464
517
- ** body** : <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a >
465
518
@@ -483,6 +536,7 @@ DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
483
536
#### Response
484
537
-->
485
538
#### 响应
539
+
486
540
200 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >): OK
487
541
488
542
202 (<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a >): Accepted
@@ -494,7 +548,9 @@ DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
494
548
#### HTTP Request
495
549
-->
496
550
### ` deletecollection ` 删除 StorageClass 的集合
551
+
497
552
#### HTTP 请求
553
+
498
554
DELETE /apis/storage.k8s.io/v1/storageclasses
499
555
500
556
<!--
@@ -513,6 +569,7 @@ DELETE /apis/storage.k8s.io/v1/storageclasses
513
569
- **timeoutSeconds** (*in query*): integer
514
570
-->
515
571
#### 参数
572
+
516
573
- ** body** : <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a >
517
574
518
575
- ** continue** (** 查询参数** ): string
@@ -567,6 +624,7 @@ DELETE /apis/storage.k8s.io/v1/storageclasses
567
624
#### Response
568
625
-->
569
626
#### 响应
627
+
570
628
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a >): OK
571
629
572
630
401: Unauthorized
0 commit comments