Add documentation of PV/PVC.storageClassName #2686

jsafrane · 2017-03-03T12:15:02Z

In 1.6, we move from storage.k8s.io/v1beta1 to storage.k8s.io/v1 and from annotation volume.beta.kubernetes.io/storage-class to storageClassName attribute. Both v1beta1 API and the old annotation are still working for some transition period and it will be removed in future (Kubernetes 1.8 at the earliest).

@kubernetes/sig-storage-misc

This change is

jeffvance · 2017-03-03T17:11:47Z

docs/user-guide/persistent-volumes/index.md

 PVs of that default. Specifying a default `StorageClass` is done by setting the
-annotation `storageclass.beta.kubernetes.io/is-default-class` equal to "true" in
+annotation `storageclass.kubernetes.io/is-default-class` equal to "true" in
 a `StorageClass` object. If the administrator does not specify a default, the
 cluster responds to PVC creation as if the admission plugin were turned off. If
 more than one default is specified, the admission plugin forbids the creation of
 all PVCs.


What if the PVC specifices an existing storage class? What if the PVC does not define storage class at all? Will the claims still fail if >1 default has been configured?

What if the PVC specifices an existing storage class?

".. the administrator may specify a default StorageClass. All PVCs that have no storageClassName can be bound only to PVs of that default. " - i.e., PVCs that require a specific class are not affected by this admission plugin.

What if the PVC does not define storage class at all?
"All PVCs that have no storageClassName can be bound only to PVs of that default. " - i.e., PVCs that do not define a class are can be bound only to PVs of the default storage class. And PVC will fail here if there are two or more default storage classes.

@jsafrane my comment above was in reference to: if some-condition then "the admission plugin forbids the creation of all PVCs". I was listing a couple of scenarios where I wanted to know if the statment remains true.

jeffvance · 2017-03-03T17:19:42Z

Look good.

chenopis · 2017-03-03T21:44:19Z

@jsafrane I'm assuming this needs to go out w/ the 1.6 docs release, right? If so, I will tag it as such and move it to the release-1.6 branch.

chenopis

Minor typo and grammar suggestions.

chenopis · 2017-03-03T21:46:09Z

docs/user-guide/persistent-volumes/index.md


-In the future after beta, the `volume.beta.kubernetes.io/storage-class`
-annotation will become an attribute.
+In the past, annotation `volume.beta.kubernetes.io/storage-class` was used instead


Grammar -- add 'the' before 'annotation': "In the past, the annotation volume.beta.kubernetes.io/storage-class"

chenopis · 2017-03-03T21:47:24Z

docs/user-guide/persistent-volumes/index.md

-In the future after beta, the `volume.beta.kubernetes.io/storage-class`
-annotation will become an attribute.
+In the past, annotation `volume.beta.kubernetes.io/storage-class` was used instead
+of `storageClassName` attribute. This annotation is still working, however


Grammar -- add 'the' after 'of': "...of the storageClassName attribute."

chenopis · 2017-03-03T21:50:01Z

docs/user-guide/persistent-volumes/index.md

-annotation will become an attribute.
+In the past, annotation `volume.beta.kubernetes.io/storage-class` was used instead
+of `storageClassName` attribute. This annotation is still working, however
+it won't be supported in a future Kubernetes release.


Suggestion: "...it will become fully deprecated in a future Kubernetes release."

chenopis · 2017-03-03T21:50:32Z

docs/user-guide/persistent-volumes/index.md

@@ -266,38 +265,39 @@ All of the requirements, from both `matchLabels` and `matchExpressions` are ANDe
 ### Class

 A claim can request a particular class by specifying the name of a
-`StorageClass`using the annotation `volume.beta.kubernetes.io/storage-class`.
-Only PVs of the requested class, ones with the same annotation as the PVC, can
+`StorageClass`using the attribute `storageClassName`.


typo: add a space before 'using'

chenopis · 2017-03-03T21:51:43Z

docs/user-guide/persistent-volumes/index.md

-have no class. In this case the PVCs that have no annotation are treated the
-same way as PVCs that have their annotation set to `""`.
+`StorageClass`. All PVCs that have no `storageClassName` can be bound only to PVs that
+have no class. In this case the PVCs that have no `storageClassName` are treated the


grammar: add comma after "In this case"

chenopis · 2017-03-03T21:53:01Z

docs/user-guide/persistent-volumes/index.md


 When a PVC specifies a `selector` in addition to requesting a `StorageClass`,
 the requirements are ANDed together: only a PV of the requested class and with
 the requested labels may be bound to the PVC. Note that currently, a PVC with a
 non-empty `selector` can't have a PV dynamically provisioned for it.

-In the future after beta, the `volume.beta.kubernetes.io/storage-class`
-annotation will become an attribute.
+In the past, annotation `volume.beta.kubernetes.io/storage-class` was used instead


Grammar -- add 'the' before 'annotation': "In the past, the annotation volume.beta.kubernetes.io/storage-class"

chenopis · 2017-03-03T21:53:36Z

docs/user-guide/persistent-volumes/index.md

-In the future after beta, the `volume.beta.kubernetes.io/storage-class`
-annotation will become an attribute.
+In the past, annotation `volume.beta.kubernetes.io/storage-class` was used instead
+of `storageClassName` attribute. This annotation is still working, however


Grammar -- add 'the' after 'of': "...of the storageClassName attribute."

jsafrane · 2017-03-06T08:37:23Z

Thanks a lot for grammar remarks! + rebased on top of release-1.6

chenopis · 2017-03-06T18:04:12Z

@jsafrane Great, thanks! Everything looks good. If we're not waiting on anything else, I can merge this.

jsafrane · 2017-03-07T11:26:27Z

cc @kubernetes/feature-reviewers to follow the process. This is documentation update for kubernetes/enhancements#36

chenopis · 2017-03-07T21:41:41Z

@jsafrane So, is it okay if I merge this PR now? The kubernetes:release-1.6 branch won't be published until k8s v1.6 is released.

jsafrane · 2017-03-08T07:13:26Z

@chenopis, yes, please merge this. Thanks!

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 3, 2017

k8s-github-robot assigned saad-ali Mar 3, 2017

jeffvance reviewed Mar 3, 2017

View reviewed changes

chenopis suggested changes Mar 3, 2017

View reviewed changes

chenopis added the Docs Review: Open Issues label Mar 3, 2017

Add documentation of PV/PVC.storageClassName

ed35f9a

jsafrane force-pushed the add-storageclassname branch from 367cf13 to aea3c77 Compare March 6, 2017 08:36

jsafrane changed the base branch from master to release-1.6 March 6, 2017 08:38

chenopis approved these changes Mar 6, 2017

View reviewed changes

chenopis added Docs LGTM and removed Docs Review: Open Issues labels Mar 6, 2017

chenopis added this to the 1.6 milestone Mar 6, 2017

chenopis added the Tech Review LGTM label Mar 6, 2017

childsb mentioned this pull request Mar 7, 2017

Configurable Dynamic Provisioning aka StorageClass kubernetes/enhancements#36

Closed

23 tasks

jsafrane mentioned this pull request Mar 9, 2017

Adds documentation for Dell EMC ScaleIO volume plugin #2741

Merged

jsafrane force-pushed the add-storageclassname branch from aea3c77 to ed35f9a Compare March 9, 2017 09:40

chenopis merged commit 146af29 into kubernetes:release-1.6 Mar 14, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation of PV/PVC.storageClassName #2686

Add documentation of PV/PVC.storageClassName #2686

jsafrane commented Mar 3, 2017 •

edited by k8s-reviewable

jeffvance Mar 3, 2017

jsafrane Mar 6, 2017

jeffvance Mar 6, 2017 •

edited

jeffvance commented Mar 3, 2017

chenopis commented Mar 3, 2017

chenopis left a comment

chenopis Mar 3, 2017

jsafrane Mar 6, 2017

chenopis Mar 3, 2017

jsafrane Mar 6, 2017

chenopis Mar 3, 2017

jsafrane Mar 6, 2017

chenopis Mar 3, 2017

jsafrane Mar 6, 2017

chenopis Mar 3, 2017

jsafrane Mar 6, 2017

chenopis Mar 3, 2017

jsafrane Mar 6, 2017

chenopis Mar 3, 2017

jsafrane Mar 6, 2017

jsafrane commented Mar 6, 2017

chenopis commented Mar 6, 2017

jsafrane commented Mar 7, 2017

chenopis commented Mar 7, 2017

jsafrane commented Mar 8, 2017

Add documentation of PV/PVC.storageClassName #2686

Add documentation of PV/PVC.storageClassName #2686

Conversation

jsafrane commented Mar 3, 2017 • edited by k8s-reviewable

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeffvance Mar 6, 2017 • edited

Choose a reason for hiding this comment

jeffvance commented Mar 3, 2017

chenopis commented Mar 3, 2017

chenopis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsafrane commented Mar 6, 2017

chenopis commented Mar 6, 2017

jsafrane commented Mar 7, 2017

chenopis commented Mar 7, 2017

jsafrane commented Mar 8, 2017

jsafrane commented Mar 3, 2017 •

edited by k8s-reviewable

jeffvance Mar 6, 2017 •

edited