IBM Power Virtual Server Block CSI Driver Operator#54711
IBM Power Virtual Server Block CSI Driver Operator#54711sheriff-rh merged 1 commit intoopenshift:mainfrom
Conversation
openshift-ci
Bot
added
do-not-merge/work-in-progress
|
🤖 Updated build preview is available at: Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/15969 |
|
/assign @Madhan-SWE |
alishaIBM
changed the title
alishaIBM
force-pushed
the
csi
branch
2 times, most recently
from
4e8ecdb to
25f994e
Compare
alishaIBM
force-pushed
the
csi
branch
2 times, most recently
from
cce02a6 to
ebbcf34
Compare
|
@Madhan-SWE , |
alishaIBM
changed the title
openshift-ci
Bot
removed
the
do-not-merge/work-in-progress
|
/lgtm |
|
/label peer-review-needed |
openshift-ci
Bot
added
the
peer-review-needed
kelbrown20
added
the
peer-review-in-progress
kelbrown20
left a comment
kelbrown20
left a comment
There was a problem hiding this comment.
Hello! Great work! Just some small questions and considerations with formating. Thank you!
openshift-ci
Bot
added
the
size/M
| {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] |
There was a problem hiding this comment.
Added Technology Preview Note. FYI : @manojnkumar @Madhan-SWE @kelbrown20
|
/label merge-review-needed |
openshift-ci
Bot
added
the
merge-review-needed
maxwelldb
added
the
merge-review-in-progress
maxwelldb
left a comment
maxwelldb
left a comment
There was a problem hiding this comment.
Made some suggestions as part of merge review. Feel free to re-add the label when you're ready.
There was a problem hiding this comment.
The assembly needs an introduction: https://redhat-documentation.github.io/modular-docs/#assembly-guidelines
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
@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
There was a problem hiding this comment.
@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/
There was a problem hiding this comment.
@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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Added new content (without GitHub links).
There was a problem hiding this comment.
@kelbrown20 @kalexand-rh could you please review the PR content ? Thanks.
| :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. |
There was a problem hiding this comment.
There was a problem hiding this comment.
replaced "recommended" with "helpful"
|
|
||
| * 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. |
There was a problem hiding this comment.
There was a problem hiding this comment.
replaced "enables" with "allows"
maxwelldb
removed
merge-review-in-progress
alishaIBM
force-pushed
the
csi
branch
2 times, most recently
from
1e47e1b to
3ea9be6
Compare
alishaIBM
force-pushed
the
csi
branch
2 times, most recently
from
263e5f6 to
4407778
Compare
|
/label merge-review-needed |
openshift-ci
Bot
added
the
merge-review-needed
sheriff-rh
added
merge-review-in-progress
sheriff-rh
left a comment
sheriff-rh
left a comment
There was a problem hiding this comment.
Looks good Alisha! I have a couple of observations before we can merge.
|
|
||
| toc::[] | ||
|
|
||
| :_content-type: CONCEPT |
There was a problem hiding this comment.
According to our guidelines, the content-type needs to be on line 1. Also, this needs to be ASSEMBLY not CONCEPT.
There was a problem hiding this comment.
removed :
:_content-type: CONCEPT
@sheriff-rh please check if correct. Thanks.
There was a problem hiding this comment.
@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::[]
There was a problem hiding this comment.
@sheriff-rh
Incorporated above suggestion. Thanks.
|
|
||
| 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 |
There was a problem hiding this comment.
This needs an [id=] block before Overview.
There was a problem hiding this comment.
Added an [id=] block before Overview.
sheriff-rh
removed
the
merge-review-in-progress
alishaIBM
force-pushed
the
csi
branch
2 times, most recently
from
3e2452f to
2a99d89
Compare
|
@sheriff-rh I have addressed the comments. Request you to please review the same. Thanks. |
|
@ocpdocs-previewbot: user ocpdocs-previewbot is not trusted for pull request #54711 |
sheriff-rh
left a comment
sheriff-rh
left a comment
There was a problem hiding this comment.
Feedback incorporated, LGTM! Merging.
|
/cherrypick enterprise-4.13 |
|
@sheriff-rh: new pull request created: #59786 DetailsIn response to this:
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. |
10 participants
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:
Additional information :
Draft doc : https://docs.google.com/document/d/1JgFhp3Aer_EoKvJV1Je3-y7trJ8crNYmDLMvN-Pd9dU/edit#