Skip to content

Commit a0cc998

Browse files
authored
Merge pull request kubernetes#47552 from windsonsea/volaty
Clean up storage/volume-attributes-classes.md
2 parents 249b57b + eb90de8 commit a0cc998

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

content/en/docs/concepts/storage/volume-attributes-classes.md

+19-18
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,16 @@ Kubernetes itself is un-opinionated about what these classes represent.
2323
This is a beta feature and disabled by default.
2424

2525
If you want to test the feature whilst it's beta, you need to enable the `VolumeAttributesClass`
26-
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) for the kube-controller-manager and the kube-apiserver. You use the `--feature-gates` command line argument:
26+
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) for the kube-controller-manager
27+
and the kube-apiserver. You use the `--feature-gates` command line argument:
2728

2829
```
2930
--feature-gates="...,VolumeAttributesClass=true"
3031
```
3132

32-
You will also have to enable the `storage.k8s.io/v1beta1` API group through the `kube-apiserver` [runtime-config](https://kubernetes.io/docs/tasks/administer-cluster/enable-disable-api/). You use the following command line argument:
33+
You will also have to enable the `storage.k8s.io/v1beta1` API group through the
34+
`kube-apiserver` [runtime-config](https://kubernetes.io/docs/tasks/administer-cluster/enable-disable-api/).
35+
You use the following command line argument:
3336

3437
```
3538
--runtime-config=storage.k8s.io/v1beta1=true
@@ -49,7 +52,6 @@ The name of a VolumeAttributesClass object is significant and is how users can r
4952
Administrators set the name and other parameters of a class when first creating VolumeAttributesClass objects.
5053
While the name of a VolumeAttributesClass object in a `PersistentVolumeClaim` is mutable, the parameters in an existing class are immutable.
5154

52-
5355
```yaml
5456
apiVersion: storage.k8s.io/v1beta1
5557
kind: VolumeAttributesClass
@@ -61,24 +63,27 @@ parameters:
6163
provisioned-throughput: "50"
6264
```
6365
64-
6566
### Provisioner
6667
67-
Each VolumeAttributesClass has a provisioner that determines what volume plugin is used for provisioning PVs. The field `driverName` must be specified.
68+
Each VolumeAttributesClass has a provisioner that determines what volume plugin is used for
69+
provisioning PVs. The field `driverName` must be specified.
6870

69-
The feature support for VolumeAttributesClass is implemented in [kubernetes-csi/external-provisioner](https://github.com/kubernetes-csi/external-provisioner).
71+
The feature support for VolumeAttributesClass is implemented in
72+
[kubernetes-csi/external-provisioner](https://github.com/kubernetes-csi/external-provisioner).
7073

71-
You are not restricted to specifying the [kubernetes-csi/external-provisioner](https://github.com/kubernetes-csi/external-provisioner). You can also run and specify external provisioners,
74+
You are not restricted to specifying the [kubernetes-csi/external-provisioner](https://github.com/kubernetes-csi/external-provisioner).
75+
You can also run and specify external provisioners,
7276
which are independent programs that follow a specification defined by Kubernetes.
7377
Authors of external provisioners have full discretion over where their code lives, how
74-
the provisioner is shipped, how it needs to be run, what volume plugin it uses, etc.
75-
78+
the provisioner is shipped, how it needs to be run, what volume plugin it uses, etc.
7679

7780
### Resizer
7881

79-
Each VolumeAttributesClass has a resizer that determines what volume plugin is used for modifying PVs. The field `driverName` must be specified.
82+
Each VolumeAttributesClass has a resizer that determines what volume plugin is used
83+
for modifying PVs. The field `driverName` must be specified.
8084

81-
The modifying volume feature support for VolumeAttributesClass is implemented in [kubernetes-csi/external-resizer](https://github.com/kubernetes-csi/external-resizer).
85+
The modifying volume feature support for VolumeAttributesClass is implemented in
86+
[kubernetes-csi/external-resizer](https://github.com/kubernetes-csi/external-resizer).
8287

8388
For example, an existing PersistentVolumeClaim is using a VolumeAttributesClass named silver:
8489

@@ -95,7 +100,6 @@ spec:
95100

96101
A new VolumeAttributesClass gold is available in the cluster:
97102

98-
99103
```yaml
100104
apiVersion: storage.k8s.io/v1beta1
101105
kind: VolumeAttributesClass
@@ -107,10 +111,8 @@ parameters:
107111
throughput: "60"
108112
```
109113

110-
111114
The end user can update the PVC with the new VolumeAttributesClass gold and apply:
112115

113-
114116
```yaml
115117
apiVersion: v1
116118
kind: PersistentVolumeClaim
@@ -122,15 +124,14 @@ spec:
122124
123125
```
124126

125-
126127
## Parameters
127128

128129
VolumeAttributeClasses have parameters that describe volumes belonging to them. Different parameters may be accepted
129130
depending on the provisioner or the resizer. For example, the value `4000`, for the parameter `iops`,
130-
and the parameter `throughput` are specific to GCE PD.
131+
and the parameter `throughput` are specific to GCE PD.
131132
When a parameter is omitted, the default is used at volume provisioning.
132-
If a user apply the PVC with a different VolumeAttributesClass with omitted parameters, the default value of
133-
the parameters may be used depends on the CSI driver implementation.
133+
If a user applies the PVC with a different VolumeAttributesClass with omitted parameters, the default value of
134+
the parameters may be used depending on the CSI driver implementation.
134135
Please refer to the related CSI driver documentation for more details.
135136

136137
There can be at most 512 parameters defined for a VolumeAttributesClass.

0 commit comments

Comments
 (0)