Add new topic for expanding PV size #8124

ghost · 2018-03-14T15:59:01Z

@gnufied @qinpingli PTAL and update as needed. This content was pulled from kubernetes/community#657 and https://kubernetes.io/docs/concepts/storage/persistent-volumes/#expanding-persistent-volumes-claims.

Trello card: https://trello.com/c/e0Awnt9f/771-document-resize-perform-cloudprovider-resize-in-controller

qinpingli · 2018-03-15T03:31:13Z

dev_guide/expanding_persistent_volumes.adoc

s/pvc.spec.resources.requests/pvc.spec.resources.requests.storage/

This is shop talk, i dont think its relevant to the end user.

vikram-redhat · 2018-03-16T01:53:48Z

@openshift/team-documentation - PTAL.

ahardin-rh · 2018-03-16T13:31:36Z

dev_guide/expanding_persistent_volumes.adoc

Then, the controller applies
(also there may be an extra space between "the" and "controller")

I wouldn't mention any of the 'internal workings' of this, it will confuse the user.. (no controller, no attributes on PVC objects, nothing on how it works.. this should only show the UX..

ahardin-rh · 2018-03-16T13:34:17Z

dev_guide/expanding_persistent_volumes.adoc

Would boil this down to say that the PVC status will reflect that the resize is happening (the rest is not end user friendly)

ahardin-rh · 2018-03-16T13:35:18Z

dev_guide/expanding_persistent_volumes.adoc

goroutine? Should this be 2 separate words? Not sure what this is.

this should not include discussion of the internals except where they are visible to the user (no mention of controller, goroutine, etc..)

ahardin-rh · 2018-03-16T13:36:36Z

dev_guide/expanding_persistent_volumes.adoc

s/plugin/plug-in

shouldn't mention 'goroutine" and i'd clarrify level-based / edge-based.. thats too shop-talky for end user.

ahardin-rh · 2018-03-16T13:37:16Z

dev_guide/expanding_persistent_volumes.adoc

s/plugin/plug-in (a few instances here and across the page)

Shop talk not for end user.

ahardin-rh · 2018-03-16T13:39:25Z

dev_guide/expanding_persistent_volumes.adoc

Should the content under "Depending on the volume type" be taken out of the nested list format? I guess it just depends on how it looks when built.

Would only mention the user visible parts here, not controller.. would also re-phrase to remove shop talk.

ahardin-rh · 2018-03-16T13:40:25Z

dev_guide/expanding_persistent_volumes.adoc

possible extra space before `pvc.Status.Conditions

Would simplify to only UX and omit the flow/details.

ahardin-rh · 2018-03-16T13:41:09Z

dev_guide/expanding_persistent_volumes.adoc

Would remove all shop talk here too. "Once a pod is schedule, the node (avoid kubelet in OSE docs) performs the file system resize is sufficient.

ahardin-rh · 2018-03-16T13:42:38Z

dev_guide/expanding_persistent_volumes.adoc

s/loops/cycles (maybe?)

`volume_expand_controller`'s

ahardin-rh · 2018-03-16T13:43:07Z

dev_guide/expanding_persistent_volumes.adoc

more shop talk, mention of API or how the controller works should be avoided.

ahardin-rh · 2018-03-16T13:43:51Z

dev_guide/expanding_persistent_volumes.adoc

`true`

plug-in

This is in shop-talk form. It should explain specifically how the feature gate works in OSE (where to add the flag etc..)

ahardin-rh · 2018-03-16T13:44:15Z

dev_guide/expanding_persistent_volumes.adoc

ahardin-rh · 2018-03-16T13:46:40Z

dev_guide/expanding_persistent_volumes.adoc

remove "aforementioned"

s/users can/you can
s/their/your

ahardin-rh · 2018-03-16T13:52:11Z

This topic needs to be added to the _topic_map.yml file so that it builds as part of the doc set. That will also allow you to run asciibinder build to preview the content before we publish. 🌟

gnufied · 2018-03-16T15:03:33Z

dev_guide/expanding_persistent_volumes.adoc

I am still not convinced why should Openshift documentation talk about Kubernetes version. We are introducing Volume expansion as a tech. preview in 3.9, that is what we should document. cc @childsb

+1 with @gnufied .... Everything should be in the context of OSE.

gnufied · 2018-03-16T15:08:31Z

dev_guide/expanding_persistent_volumes.adoc

Lets add a new section for Expanding volume types with file system. Such as - EBS, GCE-PD, Cinder and RBD. That section should clearly document 2 step process.

Step 1: Edit your PVC to have new size. User should wait for PVC to have condition PersistentVolumeClaimFileSystemResizePending
Step 2: User can describe the PVC and when the PVC has condition PersistentVolumeClaimFileSystemResizePending then user can (re-)start a pod to finish file system resize of volume on node.

gnufied · 2018-03-16T15:09:50Z

dev_guide/expanding_persistent_volumes.adoc

It appears that we are documenting internals of Volume Expand Controller here. There is no harm in doing that but the top section of this documentation should start with "How to Expand PVCs". Not with how volume expansion works.

We shouldn't have this, only the UX.. it will confuse users.

childsb · 2018-03-16T15:14:56Z

dev_guide/expanding_persistent_volumes.adoc

should only show the UX (user wont know what volume plugin based api call means)

childsb · 2018-03-16T15:28:12Z

I left lots of line item comments, but I dont think these docs have the correct audience... The upstream Kube docs are aimed at platform vendors and deeply technical tire kickers.. Some of the value-add of OSE is making kube user-friendly and much of that is the human-readable/non-geek docs

The end-user shouldn't be exposed to any internals, only the UX they will have.. Docs shouldn't mention of kube, or any implementation details, only how to enable & use the feature, or how errors are reported to user. Components should be framed in the context of OSE and use end-user friendly terms..

ghost · 2018-03-16T20:24:30Z

@childsb Should we just use the information in the release notes draft?

http://file.rdu.redhat.com/%7Eahardin/03132018/ocp-3-9-release-notes/release_notes/ocp_3_9_release_notes.html#ocp-39-pv-resize

http://file.rdu.redhat.com/%7Eahardin/03132018/ocp-3-9-release-notes/release_notes/ocp_3_9_release_notes.html#ocp-39-end-to-end-online-expansion-resize-for-cns-glusterfs-pvs

childsb · 2018-03-16T20:49:18Z

@tmorriso-rh Yes that's probably good. Maybe add where the error on failure is visible.

@gnufied does this feature need to be enabled in 3.9 to use, or is on by default? Are there any extra deployment/setup steps?

ghost · 2018-03-19T14:59:48Z

@childsb @gnufied PTAL at the updated file. Thanks.

qinpingli · 2018-03-27T03:32:24Z

Now, according the content of the PR, seems it should be linked to here: https://github.com/openshift/openshift-docs/tree/master/install_config/persistent_storage

ghost · 2018-03-28T21:19:26Z

@aheslin Ali, can you review this PR to determine where this content should be placed? It's currently targeted for the developer guide. If you need additional details, please see the comments on this Trello card: https://trello.com/c/GdqaM5R3/531-resize-perform-cloudprovider-resize-in-controller

gnufied · 2018-04-02T16:46:00Z

looks good to me from technical point of view. Assigning to @ahardin-rh for further approval.

gnufied · 2018-04-02T16:46:16Z

/lgtm

gnufied · 2018-04-02T16:46:36Z

/assign @ahardin-rh

ghost · 2018-04-03T17:44:08Z

Bump.

@aheslin Ali, can you review this PR to determine where this content should be placed? It's currently targeted for the developer guide. If you need additional details, please see the comments on this Trello card: https://trello.com/c/GdqaM5R3/531-resize-perform-cloudprovider-resize-in-controller

@ahardin-rh Ashley, can you review the link to the Admission Controllers topic? Should this be for 3.7 or 3.9?

ahardin-rh · 2018-04-03T17:50:59Z

dev_guide/expanding_persistent_volumes.adoc

@tmorriso-rh This path should be:

xref:../architecture/additional_concepts/admission_controllers.adoc#architecture-additional-concepts-admission-controllers[Admission Controllers]

It is also good to run asciibinder build and test the links in your preview build

openshift-ci-robot · 2018-04-03T18:11:07Z

New changes are detected. LGTM label has been removed.

ghost · 2018-04-04T17:27:11Z

@gnufied Before merging, can you please verify if this also applies to 3.10, dedicated, or online? Thanks.

gnufied · 2018-04-04T18:01:59Z

@tmorriso-rh it should apply to 3.10 as well. And since online is mostly managed cluster, I am not sure yet if we are going to enable resizing feature in the cluster. I would for now, abstain from making this part of openshift online docs.

ghost · 2018-04-05T01:35:29Z

/cherrypick enterprise-3.9

openshift-cherrypick-robot · 2018-04-05T01:35:35Z

@tmorriso-rh: new pull request created: #8602

In response to this:

/cherrypick enterprise-3.9

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

ghost · 2018-04-05T01:36:03Z

/cherrypick enterprise-3.10

openshift-cherrypick-robot · 2018-04-05T01:36:12Z

@tmorriso-rh: new pull request created: #8603

In response to this:

/cherrypick enterprise-3.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

ghost added branch/enterprise-3.9 peer-review-needed Signifies that the peer review team needs to review this PR labels Mar 14, 2018

openshift-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 14, 2018

ghost added this to the Next Release milestone Mar 14, 2018

qinpingli reviewed Mar 15, 2018

View reviewed changes

ahardin-rh reviewed Mar 16, 2018

View reviewed changes

dev_guide/expanding_persistent_volumes.adoc Outdated

Copy link

Contributor

ahardin-rh Mar 16, 2018 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/loops/cycles (maybe?)

`volume_expand_controller`'s

ahardin-rh reviewed Mar 16, 2018

View reviewed changes

dev_guide/expanding_persistent_volumes.adoc Outdated

Copy link

Contributor

ahardin-rh Mar 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

`true`

ahardin-rh reviewed Mar 16, 2018

View reviewed changes

dev_guide/expanding_persistent_volumes.adoc Outdated

Copy link

Contributor

ahardin-rh Mar 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove "aforementioned"

s/users can/you can
s/their/your

ahardin-rh added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Mar 16, 2018

ahardin-rh modified the milestones: Next Release, Future Release Mar 16, 2018

gnufied reviewed Mar 16, 2018

View reviewed changes

childsb reviewed Mar 16, 2018

View reviewed changes

dev_guide/expanding_persistent_volumes.adoc Outdated

Copy link

childsb Mar 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should only show the UX (user wont know what volume plugin based api call means)

openshift-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 29, 2018

openshift-ci-robot assigned gnufied Apr 2, 2018

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 2, 2018

openshift-ci-robot assigned ahardin-rh Apr 2, 2018

ahardin-rh reviewed Apr 3, 2018

View reviewed changes

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Apr 3, 2018

ghost added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Apr 3, 2018

ghost added the branch/enterprise-3.10 label Apr 4, 2018

Add new topic for expanding PV size

9b14f99

ghost modified the milestones: Future Release, Next Release Apr 5, 2018

ghost merged commit 3a2e64c into openshift:master Apr 5, 2018

openshift-cherrypick-robot mentioned this pull request Apr 5, 2018

[enterprise-3.9] Add new topic for expanding PV size #8602

Merged

openshift-cherrypick-robot mentioned this pull request Apr 5, 2018

[enterprise-3.10] Add new topic for expanding PV size #8603

Merged

mburke5678 mentioned this pull request Dec 13, 2018

Expanding Persistent Volumes - Removing unnecessary configuration steps. #13104

Closed

This pull request was closed.

Add new topic for expanding PV size #8124

Add new topic for expanding PV size #8124

Uh oh!

Conversation

ghost commented Mar 14, 2018 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qinpingli Mar 15, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vikram-redhat commented Mar 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ahardin-rh Mar 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ahardin-rh commented Mar 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

childsb commented Mar 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Mar 14, 2018 •

edited by ghost

Loading

qinpingli Mar 15, 2018 •

edited

Loading

ahardin-rh Mar 16, 2018 •

edited

Loading

childsb commented Mar 16, 2018 •

edited

Loading