Add section on storage classes to PV doc #1064

wongma7 · 2016-08-19T19:31:54Z

For kubernetes/kubernetes#29006 & kubernetes/enhancements#36

~~edit: oops, reopening against 1.4 :)~~

This change is

saad-ali · 2016-08-19T20:39:05Z

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

@@ -20,6 +20,19 @@ A `PersistentVolume` (PV) is a piece of networked storage in the cluster that ha

 A `PersistentVolumeClaim` (PVC) is a request for storage by a user.  It is similar to a pod.  Pods consume node resources and PVCs consume PV resources.  Pods can request specific levels of resources (CPU and Memory).  Claims can request specific size and access modes (e.g, can be mounted once read/write or many times read-only).

+Administrators often need to offer and provision a variety of 


These paragraphs seem out of place. Maybe a better transition from the previously ideas would help?

Maybe intro with:

While PersistentVolumeClaims allow a user to consume abstract storage resources, it is common that users need PersistentVolumes with varying properties, such as performance, for different problems. Cluster administrators need to be able to offer a variety of PersistentVolumes that differ in more ways than just size and access modes, without exposing users to the details of how those volumes are implemented. For these needs there is the StorageClass resource.

thockin · 2016-08-19T21:53:34Z

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

+
+### Provisioner
+Storage classes have a provisioner that determines what volume plugin is used 
+for provisioning PVs. This field must be specified. The available provisioner 


During beta, the available...

jsafrane · 2016-08-22T11:08:54Z

IMO, StorageClasses and PVCs and PVs are more entangled together than it was before and the page should reflect it. E.g. chapter Provisioning should mention both static and dynamic provisioning and how class on PVC influences that, especially that pvc.class="" effectively disables dynamic provisioning.
https://github.com/wongma7/kubernetes.github.io/blob/c53a3272499650027498d58b9d645789edf6cea0/docs/user-guide/persistent-volumes/index.md#provisioning

Chapter Persistent Volumes should mention also class attribute/annotation
https://github.com/wongma7/kubernetes.github.io/blob/c53a3272499650027498d58b9d645789edf6cea0/docs/user-guide/persistent-volumes/index.md#persistent-volumes

Chapter PersistentVolumeClaims should mention also class attribute/annotation
https://github.com/wongma7/kubernetes.github.io/blob/c53a3272499650027498d58b9d645789edf6cea0/docs/user-guide/persistent-volumes/index.md#persistentvolumeclaims
(and you can put description of the admission controller here).

jsafrane · 2016-08-22T11:53:39Z

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

+```
+
+* `type`: `io1`, `gp2`, `sc1`, `st1`. See AWS docs for details. Default: `gp2`. 
+* `zone`: AWS zone. If not specified, a random zone in the same region as 


actually, it's not "random zone in the same region", it's "a random zone where this Kubernetes cluster has a node". I'll update kubernetes/examples/experimental/persistent-volume-provisioning.

@jsafrane is this the same for gce?

wongma7 · 2016-08-23T04:02:51Z

I moved the defaulting but kept a little sentence under StorageClasses. Is it redundant given that the linked section is right above it?

Still need to talk about dynamic provisioning throughout the page, as you say...I think right now it feels like it's an afterthought at the bottom of the page.

(just wondering is spec.class going to be a mandatory field?)

also in case this gets missed: I added this sentence 'This means that the PVs those PVCs would normally be bound to, the PVs that have no class (no annotation or annotation equal to ""), cannot be bound to any PVC. ' this is true and worth saying, right?

edit: sorry for the weird commits

jsafrane · 2016-08-23T08:48:03Z

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

+be bound to the PVC.
+
+PVCs don't necessarily have to request a class, they can omit the annotation or
+set it to `""`. The cluster treats PVCs that don't request a class differently


It's slightly more complicated.

Missing class annotation in PVC means "I don't care about the class" and defaulting in the admission controller happens, i.e. the user gets the default class.

If there is no default storage class set or the admission controller is not running, a classless PV is then requested (see below).

Class annotation set to "" means that the PVC requests PV with class="" or missing annotation, i.e. a classless PV. That's the only way to get a PV with no/empty class.

jsafrane · 2016-08-24T11:30:55Z

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

+can only be bound to PVs with no class (no annotation or one set equal to
+`""`). A PVC with no annotation is not quite the same and is treated differently
+by the cluster depending on whether the
+[`SimpleDefaultStorageClassForPVC` admission controller](docs/admin/admission-controllers/#simpledefaultstorageclassforpvc)


it's now DefaultStorageClass. And it's not "admission controller", but officially it is "admission plugin"

jsafrane · 2016-08-24T11:43:13Z

@wongma7, great work so far, now it looks much better than before. I have only couple of comments above.

thockin · 2016-08-24T17:32:55Z

Admission controller got merged - please update this PR

jsafrane · 2016-08-25T07:08:49Z

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

+  iopsPerGB: "10"
+```
+
+* `type`: `io1`, `gp2`, `sc1`, `st1`. See AWS docs for details. Default: `gp2`.


we need a huge link to AWS docs (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) is necessary, rules about available sizes and types (and IOPS) are quite complicated.

wongma7 · 2016-08-25T17:32:20Z

I added this sentence: Volumes that were dynamically provisioned are always deleted. So does gluster now also support delete reclaim policy?

nvm, I see kubernetes/kubernetes#31243

jsafrane · 2016-08-26T12:21:35Z

I am satisfied with the current version

@wongma7, please rebase to master
@saad-ali @thockin PTAL

thockin · 2016-08-26T19:27:10Z

@jaredbhatti @devin-donnelly @kubernetes/docs

devin-donnelly · 2016-08-26T22:01:21Z

This looks more or less fine from a docs standpoint.

This reverts commit 086c65a, reversing changes made to e802d51.

Signed-off-by: William Morgan <william@buoyant.io>

googlebot added the cla: yes label Aug 19, 2016

wongma7 force-pushed the storage-class branch 3 times, most recently from ecc7d33 to 2ab60ac Compare August 19, 2016 19:35

wongma7 changed the base branch from master to release-1.4 August 19, 2016 19:36

wongma7 changed the base branch from release-1.4 to master August 19, 2016 19:37

k8s-github-robot assigned saad-ali Aug 19, 2016

wongma7 closed this Aug 19, 2016

wongma7 reopened this Aug 19, 2016

saad-ali reviewed Aug 19, 2016
View reviewed changes

saad-ali assigned jsafrane and thockin Aug 19, 2016

thockin reviewed Aug 19, 2016
View reviewed changes

jsafrane reviewed Aug 22, 2016
View reviewed changes

jsafrane reviewed Aug 23, 2016
View reviewed changes

This was referenced Aug 24, 2016

Add documentation about DefaultStorageClass plugin. #1087

Closed

Add admission controller for default storage class. kubernetes/kubernetes#30900

Merged

jsafrane reviewed Aug 24, 2016
View reviewed changes

jsafrane reviewed Aug 25, 2016
View reviewed changes

wongma7 added 11 commits August 26, 2016 10:08

Add section on storage classes to PV doc

91d0988

Intro

0c5b27f

default behaviour bit

d704186

add class sections

676a4f1

if ac turned off description

12c3921

make admission controller bit clearer

edbac93

fix admission controller bit

4e486e9

dynamic provisioning in lifecycle section

3e0e58b

trailing whitespace

8593aa4

copy latest paremeters section from examples readme

1c8bc66

more feedback

8ecd91b

wongma7 force-pushed the storage-class branch from 25bc346 to 8ecd91b Compare August 26, 2016 14:11

thockin added the Tech Review LGTM label Aug 26, 2016

devin-donnelly added the Docs LGTM label Aug 26, 2016

devin-donnelly merged commit 086c65a into kubernetes:master Aug 26, 2016

childsb mentioned this pull request Sep 2, 2016

Configurable Dynamic Provisioning aka StorageClass kubernetes/enhancements#36

Closed

23 tasks

wongma7 added a commit to wongma7/kubernetes.github.io that referenced this pull request Sep 14, 2016

Revert "Merge pull request kubernetes#1064 from wongma7/storage-class"

34e5aac

This reverts commit 086c65a, reversing changes made to e802d51.

wongma7 added a commit to wongma7/kubernetes.github.io that referenced this pull request Sep 14, 2016

Revert "Merge pull request kubernetes#1064 from wongma7/storage-class"

5099afc

This reverts commit 086c65a, reversing changes made to e802d51.

wongma7 mentioned this pull request Sep 16, 2016

Storage class 1.4 docs #1243

Merged

mikutas pushed a commit to mikutas/k8s-website that referenced this pull request Sep 22, 2022

update galera replication instructions (kubernetes#1064)

a0bbd74

Signed-off-by: William Morgan <william@buoyant.io>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add section on storage classes to PV doc #1064

Add section on storage classes to PV doc #1064

wongma7 commented Aug 19, 2016 •

edited

Loading

saad-ali Aug 19, 2016

thockin Aug 19, 2016

thockin Aug 19, 2016

jsafrane commented Aug 22, 2016

jsafrane Aug 22, 2016

wongma7 Aug 23, 2016

wongma7 commented Aug 23, 2016 •

edited

Loading

jsafrane Aug 23, 2016

jsafrane Aug 24, 2016

jsafrane commented Aug 24, 2016

thockin commented Aug 24, 2016

jsafrane Aug 25, 2016

wongma7 commented Aug 25, 2016 •

edited

Loading

jsafrane commented Aug 26, 2016

thockin commented Aug 26, 2016

devin-donnelly commented Aug 26, 2016

		@@ -20,6 +20,19 @@ A `PersistentVolume` (PV) is a piece of networked storage in the cluster that ha

		A `PersistentVolumeClaim` (PVC) is a request for storage by a user. It is similar to a pod. Pods consume node resources and PVCs consume PV resources. Pods can request specific levels of resources (CPU and Memory). Claims can request specific size and access modes (e.g, can be mounted once read/write or many times read-only).

		Administrators often need to offer and provision a variety of

Add section on storage classes to PV doc #1064

Add section on storage classes to PV doc #1064

Conversation

wongma7 commented Aug 19, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsafrane commented Aug 22, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wongma7 commented Aug 23, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsafrane commented Aug 24, 2016

thockin commented Aug 24, 2016

Choose a reason for hiding this comment

wongma7 commented Aug 25, 2016 • edited Loading

jsafrane commented Aug 26, 2016

thockin commented Aug 26, 2016

devin-donnelly commented Aug 26, 2016

wongma7 commented Aug 19, 2016 •

edited

Loading

wongma7 commented Aug 23, 2016 •

edited

Loading

wongma7 commented Aug 25, 2016 •

edited

Loading