IBM Power Virtual Server Block CSI Driver Operator #54711
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| :_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::[] | ||
|
|
||
| [id="persistent-storage-csi-ibm-powervs-block-introduction_{context}"] | ||
| == Introduction | ||
|
|
||
| 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. | ||
|
|
||
| [id="persistent-storage-csi-ibm-powervs-block-overview_{context}"] | ||
| == Overview | ||
|
Contributor
There was a problem hiding this comment. This needs an
Contributor
Author
There was a problem hiding this comment. Added an [id=] block before Overview. |
||
|
|
||
| {product-title} can provision persistent volumes (PVs) by using the Container Storage Interface (CSI) driver for {ibmpowerProductName} Virtual Server Block Storage. | ||
|
|
||
|
alishaIBM marked this conversation as resolved.
Outdated
|
||
| :FeatureName: {ibmpowerProductName} Virtual Server Block CSI Driver Operator | ||
| include::snippets/technology-preview.adoc[leveloffset=+1] | ||
|
Contributor
Author
There was a problem hiding this comment. Added Technology Preview Note. FYI : @manojnkumar @Madhan-SWE @kelbrown20 |
||
|
|
||
| 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 helpful when working with a CSI Operator and driver. | ||
|
|
||
| To create CSI-provisioned PVs that mount to {ibmpowerProductName} Virtual Server Block storage assets, {product-title} installs the {ibmpowerProductName} Virtual Server Block CSI Driver Operator and the {ibmpowerProductName} Virtual Server Block CSI driver by default in the `openshift-cluster-csi-drivers` namespace. | ||
|
|
||
| * 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. | ||
|
alishaIBM marked this conversation as resolved.
Outdated
|
||
|
|
||
| * The _{ibmpowerProductName} Virtual Server Block CSI driver_ allows you to create and mount {ibmpowerProductName} Virtual Server Block PVs. | ||
|
|
||
| include::modules/persistent-storage-csi-about.adoc[leveloffset=+1] | ||
|
|
||
| [role="_additional-resources"] | ||
| .Additional resources | ||
| * xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes] | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The assembly needs an introduction: https://redhat-documentation.github.io/modular-docs/#assembly-guidelines
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc: @maxwelldb @alishaIBM
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added new content (without GitHub links).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kelbrown20 @kalexand-rh could you please review the PR content ? Thanks.