Update documentation for vSphere Persistent Volume support #5465

BaluDontu · 2017-09-15T00:09:07Z

Update documentation for vSphere persistent volume support inside kubernetes.

This change is

BaluDontu · 2017-09-15T00:10:22Z

@steveperry-53 can you please take a look at it and merge if everything looks good.

k8sio-netlify-preview-bot · 2017-09-15T00:11:08Z

Deploy preview ready!

Built with commit 4a24de1

https://deploy-preview-5465--kubernetes-io-master-staging.netlify.com

BaluDontu · 2017-09-15T18:11:09Z

@Bradamant3 can you please take a look at it and merge if everything looks good.

thockin · 2017-09-25T18:45:27Z

@Bradamant3 Can you take a look at this?

msau42 · 2017-09-25T20:44:11Z

docs/concepts/storage/persistent-volumes.md


-2. Create a persistent volume with a disk format on a user specified datastore.
+    2. Create a persistent volume with a disk format on a user specified datastore.


Should be "Create a StorageClass"?

Does this second example also encompass the 1st? Can you combine the two?

Also this second example should be "Create a StorageClass" too

msau42 · 2017-09-25T20:45:59Z

docs/concepts/storage/persistent-volumes.md

-    datastore: VSANDatastore
-```
+       -   `diskformat`: `thin`, `zeroedthick` and `eagerzeroedthick`. Default: `"thin"`.
+       -   `datastore`: The user can also specify the datastore in the Storageclass. The volume will be created on the datastore specified in the storage class which in this case is `VSANDatastore`. This field is optional. If not specified as in previous YAML description, the volume will be created on the datastore specified in the vsphere config file used to initialize the vSphere Cloud Provider.


StorageClass

If the datastore is not specified, then the volume will be....

vSphere

msau42 · 2017-09-25T20:49:06Z

docs/concepts/storage/persistent-volumes.md

-```
+        One of the most important features of vSphere for Storage Management is Policy based Management. Storage Policy Based Management (SPBM) is a storage policy framework that provides a single unified control plane across a broad range of data services and storage solutions. SPBM enables vSphere administrators to overcome upfront storage provisioning challenges, such as capacity planning, differentiated service levels and managing capacity headroom
+
+        As we discussed in previously StorageClass specifies provisioner and parameters. And using these parameters you can define the policy for that particular PV which will be dynamically provisioned.


I think these two lines can be replaced with: "The SPBM policies can be specified in the StorageClass using the storagePolicyName parameter". And then show an example.

Fixed. For the example, I don't want to give right here rather would want to point to our documentation. This way we don't need to modify at multiple places.

BaluDontu · 2017-09-25T21:23:15Z

@msau42 : I made the changes as per your review comments. Please take a look.

chenopis

Please fix the formatting issues and minor grammar suggestions.

chenopis · 2017-09-25T22:31:31Z

docs/concepts/storage/persistent-volumes.md

-  cacheReservation: "20"
-  datastore: VSANDatastore
-```
+        One of the most important features of vSphere for Storage Management is Policy based Management. Storage Policy Based Management (SPBM) is a storage policy framework that provides a single unified control plane across a broad range of data services and storage solutions. SPBM enables vSphere administrators to overcome upfront storage provisioning challenges, such as capacity planning, differentiated service levels and managing capacity headroom


In the first sentence, "policy based management" should all be in lowercase since it's not a particular name. The capitalization in the second sentence is okay because SPBM is the name of the framework.

chenopis · 2017-09-25T22:32:13Z

docs/concepts/storage/persistent-volumes.md

-    datastore: VSANDatastore
-```
+       -   `diskformat`: `thin`, `zeroedthick` and `eagerzeroedthick`. Default: `"thin"`.
+       -   `datastore`: The user can also specify the datastore in the StorageClass. The volume will be created on the datastore specified in the storage class which in this case is `VSANDatastore`. This field is optional. If the datastore is not specified, then the volume will be created on the datastore specified in the vSphere config file used to initialize the vSphere Cloud Provider.


add a comma: "...class, which in this case is `VSANDatastore`."

chenopis · 2017-09-25T22:35:28Z

docs/concepts/storage/persistent-volumes.md

@@ -573,68 +573,51 @@ parameters:

 #### vSphere

-1. Create a persistent volume with a user specified disk format.
+   1. Create a StorageClass with a user specified disk format.


The bullet formatting is now messed up. See https://deploy-preview-5465--kubernetes-io-master-staging.netlify.com/docs/concepts/storage/persistent-volumes/#vsphere

Do not indent the bullet numbers.

chenopis · 2017-09-25T22:39:20Z

docs/concepts/storage/persistent-volumes.md

-    diskformat: zeroedthick
-    datastore: VSANDatastore
-```
+       -   `diskformat`: `thin`, `zeroedthick` and `eagerzeroedthick`. Default: `"thin"`.


Are these unordered bullets under the second bullet point? You probably need to fix the formatting for this.

chenopis · 2017-09-25T22:40:06Z

docs/concepts/storage/persistent-volumes.md


-    vSphere Infrastructure(VI) administrator can specify storage requirements for applications in terms of storage capabilities while creating a storage class inside Kubernetes. Please note that while creating a StorageClass, administrator should specify storage capability names used in the table above as these names might differ from the ones used by VSAN. For example - Number of disk stripes per object is referred to as stripeWidth in VSAN documentation however vSphere Cloud Provider uses a friendly name diskStripes.
+        Vsphere Infrastructure(VI) Admins will have the ability to specify custom Virtual SAN Storage Capabilities during dynamic volume provisioning. You can now define storage requirements, such as performance and availability, in the form of storage capabilities during dynamic volume provisioning. The storage capability requirements are converted into a Virtual SAN policy which are then pushed down to the Virtual SAN layer when a persistent volume (virtual disk) is being created. The virtual disk is distributed across the Virtual SAN datastore to meet the requirements.


add a space: "Vsphere Infrastructure (VI) Admins will..."

chenopis · 2017-09-26T20:28:32Z

@BaluDontu @thockin Is this supposed to be in the 1.8 release?

BaluDontu · 2017-09-29T21:27:01Z

@chenopis : I hope it looks good now. I have verified from the preview under files changed - https://github.com/BaluDontu/kubernetes.github.io/blob/d981be88bedd6e9014f8731e633aa370672191fc/docs/concepts/storage/persistent-volumes.md and it looks good.

I want this change to be in master and 1.8 release.

msau42 · 2017-09-29T21:37:32Z

lgtm from tech

chenopis · 2017-10-02T22:26:18Z

@BaluDontu The formatting still doesn't look right when you check the preview: https://deploy-preview-5465--kubernetes-io-master-staging.netlify.com/docs/concepts/storage/persistent-volumes/#vsphere

chenopis · 2017-10-02T22:27:03Z

@BaluDontu If you check the "Allow maintainers to edit" checkbox, I can fix it for you.

BaluDontu · 2017-10-02T22:31:09Z

@chenopis : I have enabled the checkbox. You can fix it.

However its quite confusing that https://github.com/BaluDontu/kubernetes.github.io/blob/d981be88bedd6e9014f8731e633aa370672191fc/docs/concepts/storage/persistent-volumes.md and preview doesn't show the same. The file https://github.com/BaluDontu/kubernetes.github.io/blob/d981be88bedd6e9014f8731e633aa370672191fc/docs/concepts/storage/persistent-volumes.md shows correct formatting for me.

Should we have to wait for preview link to check for formatting issues?

chenopis · 2017-10-02T23:00:49Z

@BaluDontu Yeah, unfortunately, the GitHub rendering is not the same as the actual website rendering, so it's best to check the Netlify preview. You can always use the link provided in the comment from the k8sio-netlify-preview-bot (see image below). And that gets updated if you add commits.

…hub.io into format-example-code * 'master' of https://github.com/kubernetes/kubernetes.github.io: Remove broken link (kubernetes#5726) unified style (kubernetes#5725) Fixes in style and more on CDK (kubernetes#5292) Use code style for inline code and commands (kubernetes#5724) Fix link. (kubernetes#5723) Update distribute-credentials-secure.md (kubernetes#5169) Update documentation for vSphere Persistent Volume support (kubernetes#5465) Update _redirects Update scale-intro.html Update cluster-management.md (kubernetes#4980) ingress grammar/spelling updates (kubernetes#5721) Fix an incorrect flag in configure-upgrade-etcd.md (kubernetes#5304) Updated PR template for GH workaround (kubernetes#5719) separate commands from output (kubernetes#5718) explain how to enable heapster on minikube (kubernetes#5710)

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 15, 2017

k8s-github-robot assigned Bradamant3 Sep 15, 2017

BaluDontu mentioned this pull request Sep 15, 2017

Update documentation in Kubernetes repo to point to our new documentation. vmware-archive/kubernetes-archived#260

Closed

thockin added this to the 1.8 milestone Sep 25, 2017

thockin assigned chenopis Sep 25, 2017

msau42 reviewed Sep 25, 2017

View reviewed changes

BaluDontu force-pushed the vSphereDocsFix branch from 4863899 to 67d2028 Compare September 25, 2017 21:22

Update vSphere Persistent Volumes section

67d2028

chenopis suggested changes Sep 25, 2017

View reviewed changes

chenopis added the Docs Review: Open Issues label Sep 25, 2017

chenopis assigned steveperry-53 and unassigned Bradamant3 Sep 26, 2017

Update documentation for vSphere Persistent Volume support

d981be8

steveperry-53 added the Tech Review LGTM label Oct 2, 2017

chenopis added 3 commits October 2, 2017 16:03

fix list formatting

ed29513

tweak formatting

b6cc61b

still more tweaks

c14d5b1

remove unnecessary bullets

4a24de1

chenopis added Docs LGTM and removed Docs Review: Open Issues labels Oct 2, 2017

chenopis approved these changes Oct 2, 2017

View reviewed changes

chenopis merged commit cb4a6dc into kubernetes:master Oct 2, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update documentation for vSphere Persistent Volume support #5465

Update documentation for vSphere Persistent Volume support #5465

BaluDontu commented Sep 15, 2017 •

edited by k8s-reviewable

Loading

BaluDontu commented Sep 15, 2017

k8sio-netlify-preview-bot commented Sep 15, 2017 •

edited

Loading

BaluDontu commented Sep 15, 2017

thockin commented Sep 25, 2017

msau42 Sep 25, 2017

BaluDontu Sep 25, 2017

msau42 Sep 25, 2017

msau42 Sep 25, 2017

msau42 Sep 25, 2017

BaluDontu Sep 25, 2017

msau42 Sep 25, 2017

BaluDontu Sep 25, 2017

BaluDontu commented Sep 25, 2017

chenopis left a comment

chenopis Sep 25, 2017

BaluDontu Sep 29, 2017

chenopis Sep 25, 2017

BaluDontu Sep 29, 2017

chenopis Sep 25, 2017

chenopis Sep 25, 2017

chenopis Sep 25, 2017

BaluDontu Sep 29, 2017

chenopis commented Sep 26, 2017

BaluDontu commented Sep 29, 2017 •

edited

Loading

msau42 commented Sep 29, 2017 •

edited

Loading

chenopis commented Oct 2, 2017

chenopis commented Oct 2, 2017

BaluDontu commented Oct 2, 2017

chenopis commented Oct 2, 2017


		2. Create a persistent volume with a disk format on a user specified datastore.
		2. Create a persistent volume with a disk format on a user specified datastore.


		vSphere Infrastructure(VI) administrator can specify storage requirements for applications in terms of storage capabilities while creating a storage class inside Kubernetes. Please note that while creating a StorageClass, administrator should specify storage capability names used in the table above as these names might differ from the ones used by VSAN. For example - Number of disk stripes per object is referred to as stripeWidth in VSAN documentation however vSphere Cloud Provider uses a friendly name diskStripes.
		Vsphere Infrastructure(VI) Admins will have the ability to specify custom Virtual SAN Storage Capabilities during dynamic volume provisioning. You can now define storage requirements, such as performance and availability, in the form of storage capabilities during dynamic volume provisioning. The storage capability requirements are converted into a Virtual SAN policy which are then pushed down to the Virtual SAN layer when a persistent volume (virtual disk) is being created. The virtual disk is distributed across the Virtual SAN datastore to meet the requirements.

Update documentation for vSphere Persistent Volume support #5465

Update documentation for vSphere Persistent Volume support #5465

Conversation

BaluDontu commented Sep 15, 2017 • edited by k8s-reviewable Loading

BaluDontu commented Sep 15, 2017

k8sio-netlify-preview-bot commented Sep 15, 2017 • edited Loading

BaluDontu commented Sep 15, 2017

thockin commented Sep 25, 2017

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

BaluDontu commented Sep 25, 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

chenopis commented Sep 26, 2017

BaluDontu commented Sep 29, 2017 • edited Loading

msau42 commented Sep 29, 2017 • edited Loading

chenopis commented Oct 2, 2017

chenopis commented Oct 2, 2017

BaluDontu commented Oct 2, 2017

chenopis commented Oct 2, 2017

BaluDontu commented Sep 15, 2017 •

edited by k8s-reviewable

Loading

k8sio-netlify-preview-bot commented Sep 15, 2017 •

edited

Loading

BaluDontu commented Sep 29, 2017 •

edited

Loading

msau42 commented Sep 29, 2017 •

edited

Loading