OSDOCS-930 - Include section on the OpenStack Manila CSI Driver #22199

bobfuru · 2020-05-15T20:19:39Z

Work being tracked in OSDOCS-930 and OSDOCS-1117.

Storage -> Using CSI -> Using CSI OpenStack Manila
Preview link: https://osdocs-930-manila--ocpdocs.netlify.app/openshift-enterprise/latest/storage/container_storage_interface/persistent-storage-csi-manila.html

openshift-docs-preview-bot · 2020-05-15T21:11:23Z

The preview will be available shortly at:

https://OSDOCS-930-manila--ocpdocs.netlify.com/

bobfuru · 2020-05-19T18:43:55Z

@duanwei33 PTAL?

duanwei33 · 2020-05-27T05:38:50Z

@bobfuru Sorry for the delay, I think there is still some update for this feature, I list some items not align with our test:

Project name should be manila-csi instead of csi-manila
After "Installing the CSI Manila Operator" and before "Dynamically provisioning CSI Manila volumes", there is one more step to install ManilaDriver, which will create csi driver related resource and storage class (It is more like install LocalVolume in local storage), it can be installed from web or client.
In "Dynamically provisioning CSI Manila volumes", the storage class name for manila should be "csi-manila-ceph" instead of "csi-manila-nfs"
Just suggest only keep command line way in "Dynamically provisioning CSI Manila volumes" to simple the doc (Just a suggestion)
"pvc-clone.yaml" should be updated to "pvc-manila.yaml".
Not very sure the note for RWO:

Use RWO mode if you want to prevent additional Pods from being dynamically provisioned.

I can provide env with manila operator if you needed.
BTW, just wondering when the doc should be finished reviewed by QE, I know the GA date is June 18th?

duanwei33 · 2020-05-28T06:48:18Z

Hi Bob,
I checked some pr, seems something changed like namespace, install mode, driver name.
I will give another review next week after verified ON_QA bugs.

bobfuru · 2020-05-28T21:06:51Z

Hi Wei,

Thanks for the feedback. See my inline comments below...

@bobfuru Sorry for the delay, I think there is still some update for this feature, I list some items not align with our test:

That makes sense. Because I didn't have CSI Manila Operator in OLM, I was mostly guessing. :)

Project name should be manila-csi instead of csi-manila
OK, changed. Do you think we need this step? I think a default namespace is created if we leave this out.

After "Installing the CSI Manila Operator" and before "Dynamically provisioning CSI Manila volumes", there is one more step to install ManilaDriver, which will create csi driver related resource and storage class (It is more like install LocalVolume in local storage), it can be installed from web or client.

I added a section for instructions about installing ManilaDriver (or whatever name it will be called). So the Operator doesn't deploy the driver? I thought that's one of the features of CSI Operators? I'm not sure what the steps are to do this, so please fill in/comment on them as you have more details.

In "Dynamically provisioning CSI Manila volumes", the storage class name for manila should be "csi-manila-ceph" instead of "csi-manila-nfs"

Fixed.

Just suggest only keep command line way in "Dynamically provisioning CSI Manila volumes" to simple the doc (Just a suggestion)

Because we have console instructions, I'm inclined to keep those here, along with CLI.

"pvc-clone.yaml" should be updated to "pvc-manila.yaml".

Fixed!

Not very sure the note for RWO:

Use RWO mode if you want to prevent additional Pods from being dynamically provisioned.

This came from a BZ enhancement for local storage Operator install, so I thought it would also be useful context here. If you think it's incorrect, please let me know and I'll remove.

I can provide env with manila operator if you needed.

Yes, that would be most helpful, thanks!

BTW, just wondering when the doc should be finished reviewed by QE, I know the GA date is June 18th?

As of now, our Docs freeze date is June 8, but I know GA is now July 9, so we will probably have additional time for this doc to be finished with QE review. Or is June 8 even possible for you?

bobfuru · 2020-05-28T21:08:13Z

Hi Bob,
I checked some pr, seems something changed like namespace, install mode, driver name.
I will give another review next week after verified ON_QA bugs.

Perfect, thank you, @duanwei33 !! I did what I could for now based on the info I have (and no test env). Appreciate you looking now and again next week!!

bobfuru · 2020-06-01T21:09:32Z

@jeana-redhat PTAL for clarity, typos, links, etc. Thanks!

jeana-redhat

Some suggestions, mostly ISG or minimalism related. Anything I asked as a question is something I'm uncertain about just because I'm still getting up to speed - if the question is irrelevant feel free to just ignore rather than explaining so you don't get caught up in that.

storage/container_storage_interface/persistent-storage-csi-manila.adoc

modules/persistent-storage-csi-manila-operator-install.adoc

modules/persistent-storage-csi-manila-install-driver.adoc

modules/persistent-storage-csi-manila-dynamic-provisioning.adoc

jboxman · 2020-06-03T21:57:32Z

@jeana-redhat, I don't usually drive-by comment, but this is impressive peer review work and I wanted to say so!

storage/container_storage_interface/persistent-storage-csi-manila.adoc

bobfuru · 2020-06-29T15:58:51Z

Note that there is related work in #22978. Once that PR is merged, the same guidance should be applied to this PR to use {rh-openstack-first} and {rh-openstack} attributes.

Done.

modules/persistent-storage-csi-manila-install-operator.adoc

modules/persistent-storage-csi-manila-dynamic-provisioning.adoc

tombarron

I've posted remarks on a few nits or small issues, but this looks good and is very close to merge IMO.
But I think manila-csi should be included in the section dedicated to dynamic provisioning as well [1].
It could appear in the "Available dynamic provisioning plug-ins" table right after OpenStack cinder. The provisioner plug-in name is "manila.csi.openstack.org". Notes could just be a link back to the manila-csi docs that you are currently writing. There should be a "RHOSP Manila CSI object definition" section that says the Manila CSI storage classes are automatically created when the Operator and Driver are installed as covered in [link](to this section you are writing now).

[1] https://osdocs-930-manila--ocpdocs.netlify.app/openshift-enterprise/latest/storage/dynamic-provisioning.html

modules/persistent-storage-csi-manila-install-driver.adoc

bobfuru · 2020-06-30T16:58:52Z

But I think manila-csi should be included in the section dedicated to dynamic provisioning as well [1].
It could appear in the "Available dynamic provisioning plug-ins" table right after OpenStack cinder. The provisioner plug-in name is "manila.csi.openstack.org". Notes could just be a link back to the manila-csi docs that you are currently writing. There should be a "RHOSP Manila CSI object definition" section that says the Manila CSI storage classes are automatically created when the Operator and Driver are installed as covered in [link](to this section you are writing now).

Great idea! I've added CSI Manila to the plug-ins table and added a section for the object definition. As you said, this is redundant but conforms to how we've laid out the rest of the page.

Preview of this addition here: https://osdocs-930-manila--ocpdocs.netlify.app/openshift-enterprise/latest/storage/dynamic-provisioning.html#available-plug-ins_dynamic-provisioning

tombarron · 2020-06-30T17:43:14Z

LGTM, Bob. Thanks for your work on this one!

bobfuru · 2020-06-30T17:49:18Z

/cherrypick enterprise-4.5

openshift-cherrypick-robot · 2020-06-30T17:49:30Z

@bobfuru: new pull request created: #23391

In response to this:

/cherrypick enterprise-4.5

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.

xrefs aren't allowed in modules: $ grep -A1 'You must not include xrefs' modules/mod-docs-ocp-conventions.adoc You must not include xrefs in modules or create an xref to a module. You can only use xrefs to link from one assembly to another. And we can't move this module out into an assembly directory, because it is consumed from two places: $ git --no-pager grep dynamic-provisioning-available-plugins post_installation_configuration/storage-configuration.adoc:include::modules/dynamic-provisioning-available-plugins.adoc[leveloffset=+3] storage/dynamic-provisioning.adoc:include::modules/dynamic-provisioning-available-plugins.adoc[leveloffset=+1] We could: a. Trim down post_installation_configuration to just xref the storage assembly, instead of duping so much of it's content via modules. b. Drop the module and instead inline (some of) it with copy/paste in both assemblies. c. Remove the xref. With this commit, I'm going with (c), removing the xref which was added in 57961f1 ([STOR] Include section on the OpenStack Manila CSI Driver, 2020-05-12, openshift#22199).

bobfuru added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. branch/enterprise-4.5 labels May 15, 2020

bobfuru added this to the Future Release milestone May 15, 2020

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 15, 2020

bobfuru force-pushed the OSDOCS-930-manila branch 5 times, most recently from 139530e to e80aba9 Compare May 19, 2020 17:13

bobfuru force-pushed the OSDOCS-930-manila branch 2 times, most recently from ec53882 to f2c78a6 Compare May 20, 2020 14:53

bobfuru force-pushed the OSDOCS-930-manila branch 2 times, most recently from 43674a2 to ea21b50 Compare May 28, 2020 20:58

bobfuru force-pushed the OSDOCS-930-manila branch from ea21b50 to 99466b4 Compare June 3, 2020 19:07

jeana-redhat reviewed Jun 3, 2020

View reviewed changes

bobfuru added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 4, 2020

bobfuru force-pushed the OSDOCS-930-manila branch 5 times, most recently from 05c06ba to a613756 Compare June 5, 2020 19:17

bobfuru removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 5, 2020

gnufied reviewed Jun 29, 2020

View reviewed changes

storage/container_storage_interface/persistent-storage-csi-manila.adoc Outdated Show resolved Hide resolved

bobfuru force-pushed the OSDOCS-930-manila branch 3 times, most recently from ab01b7b to 46fe558 Compare June 29, 2020 15:47

bobfuru force-pushed the OSDOCS-930-manila branch from 46fe558 to 114caa6 Compare June 29, 2020 16:29

tombarron reviewed Jun 29, 2020

View reviewed changes

modules/persistent-storage-csi-manila-install-operator.adoc Outdated Show resolved Hide resolved

bobfuru force-pushed the OSDOCS-930-manila branch from 114caa6 to a024f09 Compare June 29, 2020 21:31

tombarron reviewed Jun 30, 2020

View reviewed changes

modules/persistent-storage-csi-manila-dynamic-provisioning.adoc Outdated Show resolved Hide resolved

tombarron reviewed Jun 30, 2020

View reviewed changes

modules/persistent-storage-csi-manila-install-driver.adoc Outdated Show resolved Hide resolved

bobfuru force-pushed the OSDOCS-930-manila branch 3 times, most recently from a3a9b02 to 58d48a4 Compare June 30, 2020 16:53

bobfuru force-pushed the OSDOCS-930-manila branch from 58d48a4 to 91d64af Compare June 30, 2020 17:02

[STOR] Include section on the OpenStack Manila CSI Driver

57961f1

bobfuru force-pushed the OSDOCS-930-manila branch from 91d64af to 57961f1 Compare June 30, 2020 17:30

bobfuru merged commit a95bd70 into openshift:master Jun 30, 2020

bobfuru deleted the OSDOCS-930-manila branch June 30, 2020 17:49

openshift-cherrypick-robot mentioned this pull request Jun 30, 2020

[enterprise-4.5] OSDOCS-930 - Include section on the OpenStack Manila CSI Driver #23391

Merged

vikram-redhat modified the milestones: Future Release, OCP 4.5 GA Jul 13, 2020

wking mentioned this pull request Oct 8, 2020

modules/dynamic-provisioning-available-plugins: Drop xref #26255

Merged

kalexand-rh mentioned this pull request Apr 21, 2023

IBM Power Virtual Server Block CSI Driver Operator #54711

Merged

1 task

OSDOCS-930 - Include section on the OpenStack Manila CSI Driver #22199

OSDOCS-930 - Include section on the OpenStack Manila CSI Driver #22199

Uh oh!

Conversation

bobfuru commented May 15, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-docs-preview-bot commented May 15, 2020

Uh oh!

bobfuru commented May 19, 2020

Uh oh!

duanwei33 commented May 27, 2020

Uh oh!

duanwei33 commented May 28, 2020

Uh oh!

bobfuru commented May 28, 2020

Uh oh!

bobfuru commented May 28, 2020

Uh oh!

bobfuru commented Jun 1, 2020

Uh oh!

jeana-redhat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jboxman commented Jun 3, 2020

Uh oh!

Uh oh!

bobfuru commented Jun 29, 2020

Uh oh!

Uh oh!

Uh oh!

tombarron left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bobfuru commented Jun 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tombarron commented Jun 30, 2020

Uh oh!

bobfuru commented Jun 30, 2020

Uh oh!

openshift-cherrypick-robot commented Jun 30, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

bobfuru commented May 15, 2020 •

edited

Loading

bobfuru commented Jun 30, 2020 •

edited

Loading