IBM Power Virtual Server Block CSI Driver Operator #54711

alishaIBM · 2023-01-16T10:29:25Z

Version(s) : 4.13

Issue :
Documentation - Add PowerVS Block CSI Driver Operator to cluster storage operator
IPI for PowerVS Documentation

Links to docs preview :
https://54711--docspreview.netlify.app/openshift-enterprise/latest/storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.html
https://54711--docspreview.netlify.app/openshift-enterprise/latest/storage/container_storage_interface/persistent-storage-csi.html#csi-drivers-supported_persistent-storage-csi

QE review:

QE has approved this change.

Additional information :
Draft doc : https://docs.google.com/document/d/1JgFhp3Aer_EoKvJV1Je3-y7trJ8crNYmDLMvN-Pd9dU/edit#

ocpdocs-previewbot · 2023-01-16T10:52:50Z

🤖 Updated build preview is available at:
https://54711--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/15969

alishaIBM · 2023-01-16T11:15:43Z

/assign @Madhan-SWE

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc

modules/persistent-storage-csi-drivers-supported.adoc

_topic_maps/_topic_map.yml

modules/persistent-storage-csi-drivers-supported.adoc

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc

alishaIBM · 2023-03-20T06:16:12Z

@Madhan-SWE ,
I have incorporated the changes. Request you to review and provide QE approval. Thanks.

Madhan-SWE · 2023-03-21T05:28:12Z

/lgtm

alishaIBM · 2023-03-21T06:09:18Z

/label peer-review-needed

kelbrown20

Hello! Great work! Just some small questions and considerations with formating. Thank you!

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc

alishaIBM · 2023-03-31T16:49:08Z

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc

+{product-title} is capable of provisioning persistent volumes (PVs) using the Container Storage Interface (CSI) driver for {ibmpowerProductName} Virtual Server Block Storage.
+
+:FeatureName: {ibmpowerProductName} Virtual Server Block CSI Driver Operator
+include::snippets/technology-preview.adoc[leveloffset=+1]


Added Technology Preview Note. FYI : @manojnkumar @Madhan-SWE @kelbrown20

alishaIBM · 2023-04-04T14:09:19Z

/label merge-review-needed

maxwelldb

Made some suggestions as part of merge review. Feel free to re-add the label when you're ready.

maxwelldb · 2023-04-04T18:22:48Z

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc

The assembly needs an introduction: https://redhat-documentation.github.io/modular-docs/#assembly-guidelines

This documentation follows the same format as every other csi driver operator in the OpenShift docs.
Ref: https://docs.openshift.com/container-platform/4.8/storage/container_storage_interface/persistent-storage-csi-gcp-pd.html

Do we need to put additional introduction info?

cc: @maxwelldb @alishaIBM

@Madhan-SWE I'd say that those docs should also follow the format in our guidelines. Can't explain why they don't. There could be an exception for these assemblies, but I don't have a great way to find that out.

e: I'm not on a review squad this week, so I'm sure someone will pick this up shortly.

@maxwelldb thanks for the update.

@kelbrown20 @maxwelldb could you please point us to the right person who can take a look at above. Thanks.
cc : @jaypoulz

@kalexand-rh could you please confirm if we can have external repositories in the intro ( as mentioned in above comment by @Madhan-SWE ).
The links are :
https://github.com/openshift/ibm-powervs-block-csi-driver
https://github.com/openshift/ibm-powervs-block-csi-driver-operator
https://github.com/openshift/library-go/
https://github.com/openshift/cluster-storage-operator
https://docs.providers.openshift.org/container-storage-interface-driver/

@sferich888, since these are all within the openshift org, are you ok with them? Or are there specific requirements you'd like to be confirmed first?

We should not link to GitHub no matter where the content is.

If we are providing a link for a purpose then the content of that link should be documented in our docs.

Most of these looks like references (to whit I have to ask the value of the reference), shot of providing a breadcrumb trail.

Added new content (without GitHub links).

@kelbrown20 @kalexand-rh could you please review the PR content ? Thanks.

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc

maxwelldb · 2023-04-04T18:26:53Z

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc

+:FeatureName: {ibmpowerProductName} Virtual Server Block CSI Driver Operator
+include::snippets/technology-preview.adoc[leveloffset=+1]
+
+Familiarity with xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] and xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[configuring CSI volumes] is recommended when working with a CSI Operator and driver.


⚠️ ISG: Could revise to eliminate passive voice and use of "recommended."

replaced "recommended" with "helpful"

maxwelldb · 2023-04-04T18:31:51Z

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc

+
+* The _{ibmpowerProductName} Virtual Server Block CSI Driver Operator_ provides two storage classes named `ibm-powervs-tier1` (default), and `ibm-powervs-tier3` for different tiers that you can use to create persistent volume claims (PVCs). The {ibmpowerProductName} Virtual Server Block CSI Driver Operator supports dynamic volume provisioning by allowing storage volumes to be created on demand, eliminating the need for cluster administrators to pre-provision storage.
+
+* The _{ibmpowerProductName} Virtual Server Block CSI driver_ enables you to create and mount {ibmpowerProductName} Virtual Server Block PVs.


⚠️ ISG: Anthropomorphization in "enables".

replaced "enables" with "allows"

alishaIBM · 2023-05-08T18:56:35Z

/label merge-review-needed

sheriff-rh

Looks good Alisha! I have a couple of observations before we can merge.

sheriff-rh · 2023-05-09T13:48:11Z

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc

+
+toc::[]
+
+:_content-type: CONCEPT


According to our guidelines, the content-type needs to be on line 1. Also, this needs to be ASSEMBLY not CONCEPT.

removed :
:_content-type: CONCEPT

@sheriff-rh please check if correct. Thanks.

@alishaIBM content-type needs to be on line 1 and it needs to be ASSEMBLY type:

:_content-type: ASSEMBLY [id="persistent-storage-csi-ibm-powervs-block"] = {ibmpowerProductName} Virtual Server Block CSI Driver Operator include::_attributes/common-attributes.adoc[] :context: persistent-storage-csi-ibm-powervs-block toc::[]

@sheriff-rh
Incorporated above suggestion. Thanks.

sheriff-rh · 2023-05-09T13:48:31Z

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc

+
+The IBM Power Virtual Server Block CSI Driver will be installed through IBM Power Virtual Server Block CSI Driver Operator and the operator is based on libarary-go. The OpenShift library-go is a collection of functions that allow us to build OpenShift operators easily. Most of the functionality of a CSI driver operator is already available there. The IBM Power Virtual Server Block CSI Driver Operator is installed by the cluster-storage-operator. The Cluster-storage-operator installs the IBM Power Virtual Server Block CSI Driver Operator if the Platform type is Power Virtual Servers.
+
+== Overview


This needs an [id=] block before Overview.

Added an [id=] block before Overview.

alishaIBM · 2023-05-10T07:24:58Z

@sheriff-rh I have addressed the comments. Request you to please review the same. Thanks.

openshift-ci · 2023-05-10T12:37:40Z

@ocpdocs-previewbot: user ocpdocs-previewbot is not trusted for pull request #54711

sheriff-rh

Feedback incorporated, LGTM! Merging.

sheriff-rh · 2023-05-10T12:39:39Z

/cherrypick enterprise-4.13

openshift-cherrypick-robot · 2023-05-10T12:40:26Z

@sheriff-rh: new pull request created: #59786

Details

In response to this:

/cherrypick enterprise-4.13

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.

openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 16, 2023

alishaIBM force-pushed the csi branch from 75f04c7 to 65949fb Compare January 16, 2023 10:42

alishaIBM force-pushed the csi branch from 65949fb to 5117f9d Compare January 16, 2023 11:04

openshift-ci bot assigned Madhan-SWE Jan 16, 2023

Madhan-SWE reviewed Jan 19, 2023

View reviewed changes

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc Outdated Show resolved Hide resolved

Madhan-SWE reviewed Jan 19, 2023

View reviewed changes

modules/persistent-storage-csi-drivers-supported.adoc Outdated Show resolved Hide resolved

alishaIBM force-pushed the csi branch from 5117f9d to 3e462f9 Compare January 19, 2023 12:48

Madhan-SWE reviewed Feb 15, 2023

View reviewed changes

_topic_maps/_topic_map.yml Outdated Show resolved Hide resolved

Madhan-SWE reviewed Feb 15, 2023

View reviewed changes

modules/persistent-storage-csi-drivers-supported.adoc Outdated Show resolved Hide resolved

Madhan-SWE reviewed Feb 15, 2023

View reviewed changes

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc Outdated Show resolved Hide resolved

Madhan-SWE reviewed Feb 15, 2023

View reviewed changes

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc Outdated Show resolved Hide resolved

Madhan-SWE reviewed Feb 15, 2023

View reviewed changes

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc Outdated Show resolved Hide resolved

Madhan-SWE reviewed Feb 15, 2023

View reviewed changes

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc Outdated Show resolved Hide resolved

alishaIBM changed the title ~~[WIP] IBM Power VS Block CSI Driver Operator~~ [WIP] IBM Power Virtual Server Block CSI Driver Operator Mar 1, 2023

alishaIBM force-pushed the csi branch 2 times, most recently from 4e8ecdb to 25f994e Compare March 1, 2023 08:55

alishaIBM force-pushed the csi branch 2 times, most recently from cce02a6 to ebbcf34 Compare March 20, 2023 06:06

alishaIBM changed the title ~~[WIP] IBM Power Virtual Server Block CSI Driver Operator~~ IBM Power Virtual Server Block CSI Driver Operator Mar 20, 2023

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 20, 2023

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 21, 2023

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Mar 21, 2023

kelbrown20 added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Mar 21, 2023

kelbrown20 reviewed Mar 21, 2023

View reviewed changes

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc Show resolved Hide resolved

storage/container_storage_interface/persistent-storage-csi-ibm-powervs-block.adoc Show resolved Hide resolved

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 31, 2023

alishaIBM commented Mar 31, 2023

View reviewed changes

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Apr 4, 2023

maxwelldb added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Apr 4, 2023

maxwelldb self-requested a review April 4, 2023 18:03

maxwelldb reviewed Apr 4, 2023

View reviewed changes

maxwelldb removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Apr 4, 2023

alishaIBM force-pushed the csi branch 2 times, most recently from 1e47e1b to 3ea9be6 Compare April 7, 2023 15:21

alishaIBM force-pushed the csi branch 2 times, most recently from 263e5f6 to 4407778 Compare May 8, 2023 15:07

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label May 8, 2023

sheriff-rh added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels May 9, 2023

sheriff-rh reviewed May 9, 2023

View reviewed changes

sheriff-rh removed the merge-review-in-progress Signifies that the merge review team is reviewing this PR label May 9, 2023

alishaIBM force-pushed the csi branch 2 times, most recently from 3e2452f to 2a99d89 Compare May 10, 2023 07:12

IBM Power VS Block CSI Driver Operator

e23f9de

alishaIBM force-pushed the csi branch from 2a99d89 to e23f9de Compare May 10, 2023 12:23

sheriff-rh reviewed May 10, 2023

View reviewed changes

sheriff-rh merged commit 3c0c573 into openshift:main May 10, 2023

openshift-cherrypick-robot mentioned this pull request May 10, 2023

[enterprise-4.13] IBM Power Virtual Server Block CSI Driver Operator #59786

Merged


		* The _{ibmpowerProductName} Virtual Server Block CSI Driver Operator_ provides two storage classes named `ibm-powervs-tier1` (default), and `ibm-powervs-tier3` for different tiers that you can use to create persistent volume claims (PVCs). The {ibmpowerProductName} Virtual Server Block CSI Driver Operator supports dynamic volume provisioning by allowing storage volumes to be created on demand, eliminating the need for cluster administrators to pre-provision storage.

		* The _{ibmpowerProductName} Virtual Server Block CSI driver_ enables you to create and mount {ibmpowerProductName} Virtual Server Block PVs.


		The IBM Power Virtual Server Block CSI Driver will be installed through IBM Power Virtual Server Block CSI Driver Operator and the operator is based on libarary-go. The OpenShift library-go is a collection of functions that allow us to build OpenShift operators easily. Most of the functionality of a CSI driver operator is already available there. The IBM Power Virtual Server Block CSI Driver Operator is installed by the cluster-storage-operator. The Cluster-storage-operator installs the IBM Power Virtual Server Block CSI Driver Operator if the Platform type is Power Virtual Servers.

		== Overview

IBM Power Virtual Server Block CSI Driver Operator #54711

IBM Power Virtual Server Block CSI Driver Operator #54711

Uh oh!

Conversation

alishaIBM commented Jan 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Jan 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alishaIBM commented Jan 16, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alishaIBM commented Mar 20, 2023

Uh oh!

Madhan-SWE commented Mar 21, 2023

Uh oh!

alishaIBM commented Mar 21, 2023

Uh oh!

kelbrown20 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alishaIBM commented Apr 4, 2023

Uh oh!

maxwelldb left a comment

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!

Madhan-SWE Apr 20, 2023 • 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!

maxwelldb Apr 20, 2023 • 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!

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!

alishaIBM commented May 8, 2023

Uh oh!

sheriff-rh left a comment

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!

alishaIBM commented Jan 16, 2023 •

edited

Loading

ocpdocs-previewbot commented Jan 16, 2023 •

edited

Loading

Madhan-SWE Apr 20, 2023 •

edited

Loading

maxwelldb Apr 20, 2023 •

edited

Loading