Skip to content

OSDOCS-9364 updated ROSA PV Storage options #70909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

@xJustin
Copy link
Contributor Author

xJustin commented Jan 29, 2024

/retest

@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jan 29, 2024

🤖 Mon Feb 05 22:12:16 - Prow CI generated the docs preview: https://70909--ocpdocs-pr.netlify.app

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 29, 2024
@xJustin xJustin force-pushed the OSDOCS-9364-ROSA-storage-options branch 4 times, most recently from 87908f8 to 3324958 Compare January 30, 2024 15:02
Copy link
Contributor

@arendej arendej left a comment

Choose a reason for hiding this comment

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

great, thank you


ifdef::openshift-rosa[]
[id="types-of-persistent-volumes_{context}"]
== Types of PVs
Copy link
Contributor

@Phaow Phaow Feb 1, 2024

Choose a reason for hiding this comment

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

For the Types of PVs we generally consider it as the volume type is Filesystem or Block . Here it seems means the csi drivers(different csi provisioners) using the title maybe a bit mislead since you also mentioned that ROSA also functions with Kubernetes Container Storage Interface (CSI) compatible volume provisioners from third-party storage vendors. We could change to e.g. Supported CSI drivers maybe better.
Ref: https://docs.openshift.com/container-platform/4.14/storage/container_storage_interface/persistent-storage-csi.html#csi-drivers-supported_persistent-storage-csi
cc to @xueli181114 @duanwei33

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Phaow I have no problem changing the title. I believe it may be more accurate to mention the CSI drivers. what about something like:
== Supported CSI drivers for PVs or something to that effect >?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hello @xJustin , seems the enterprise still use the Types of PVs, I think we could keep it firstly the enterprise doc also will do some more updates in next releases, in origin upstream docs Types of volumes maybe more clearly. Anyway we could keep it for now and update with the enterprise docs together later.
https://kubernetes.io/docs/concepts/storage/volumes/#awselasticblockstore

- AWS Elastic Block Store (EBS)
- AWS Elastic File Store (EFS)

ROSA also functions with Kubernetes Container Storage Interface (CSI) compatible volume provisioners from third-party storage vendors such as AWS FSX or Pure Storage Portworx. Red Hat does not oversee third-party provisioners or the connected CSI drivers and the vendors fully control source code, deployment, operation, and Kubernetes compatibility. These volume provisioners are considered customer-managed and the respective vendors are responsible for providing support. See the link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.html#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[Shared responsibilities for Red Hat OpenShift Service on AWS] matrix for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

From my understanding, we'd better move this description to https://70909--ocpdocs-pr.netlify.app/openshift-rosa/latest/storage/container_storage_interface/persistent-storage-csi#csi-drivers-supported_persistent-storage-csi if we want to keep consistent with the enterprise docs(keep using Types of PVs). The Types of PVs in enterprise docs specified the intree manual PVs not the CSI.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@arendej what do you think about moving the description to the CSI page and linking over to it?

@xJustin xJustin force-pushed the OSDOCS-9364-ROSA-storage-options branch 2 times, most recently from 4935af2 to eb040ec Compare February 1, 2024 15:01
@Phaow
Copy link
Contributor

Phaow commented Feb 2, 2024

LGTM

@xJustin xJustin force-pushed the OSDOCS-9364-ROSA-storage-options branch from eb040ec to ae0be86 Compare February 2, 2024 20:01
Copy link
Contributor

@arendej arendej left a comment

Choose a reason for hiding this comment

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

lgtm

@xJustin xJustin force-pushed the OSDOCS-9364-ROSA-storage-options branch from ae0be86 to a16f3e0 Compare February 5, 2024 13:34
@xJustin
Copy link
Contributor Author

xJustin commented Feb 5, 2024

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Feb 5, 2024
@skopacz1
Copy link
Contributor

skopacz1 commented Feb 5, 2024

/label peer-review-in-progress

@openshift-ci openshift-ci bot added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Feb 5, 2024
Copy link
Contributor

@skopacz1 skopacz1 left a comment

Choose a reason for hiding this comment

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

Just one comment, otherwise LGTM!

[IMPORTANT]
====
If your CSI driver is not listed in the preceding table, you must follow the installation instructions provided by your CSI storage vendor to use their supported CSI features.
====
endif::openshift-rosa[]
ifdef::openshift-rosa[]
In addition to the drivers listed in the preceding table, ROSA functions with CSI drivers from third-party storage vendors such as AWS FSX or Pure Storage Portworx. Red Hat does not oversee third-party provisioners or the connected CSI drivers and the vendors fully control source code, deployment, operation, and Kubernetes compatibility. These volume provisioners are considered customer-managed and the respective vendors are responsible for providing support. See the link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.html#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[Shared responsibilities for Red Hat OpenShift Service on AWS] matrix for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

Tiny nit - use {nbsp} in between Red and Hat so the company name is never broken up by a new line:

Suggested change
In addition to the drivers listed in the preceding table, ROSA functions with CSI drivers from third-party storage vendors such as AWS FSX or Pure Storage Portworx. Red Hat does not oversee third-party provisioners or the connected CSI drivers and the vendors fully control source code, deployment, operation, and Kubernetes compatibility. These volume provisioners are considered customer-managed and the respective vendors are responsible for providing support. See the link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.html#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[Shared responsibilities for Red Hat OpenShift Service on AWS] matrix for more information.
In addition to the drivers listed in the preceding table, ROSA functions with CSI drivers from third-party storage vendors such as AWS FSX or Pure Storage Portworx. Red Hat does not oversee third-party provisioners or the connected CSI drivers and the vendors fully control source code, deployment, operation, and Kubernetes compatibility. These volume provisioners are considered customer-managed and the respective vendors are responsible for providing support. See the link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.html#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[Shared responsibilities for Red{nbsp}Hat OpenShift Service on AWS] matrix for more information.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @skopacz1 !

@skopacz1
Copy link
Contributor

skopacz1 commented Feb 5, 2024

/remove-label peer-review-needed
/remove-label peer-review-in-progress

/label peer-review-done

@openshift-ci openshift-ci bot 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 peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Feb 5, 2024
@xJustin xJustin force-pushed the OSDOCS-9364-ROSA-storage-options branch from a16f3e0 to 5b5aacd Compare February 5, 2024 18:23
@xJustin
Copy link
Contributor Author

xJustin commented Feb 5, 2024

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Feb 5, 2024
@jeana-redhat jeana-redhat added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Feb 5, 2024
Copy link
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

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

Sorry this took me a while, it opened up a tangential question about support matrices. There's one place here you could use an attribute instead of the name written out, otherwise LGTM

/remove-label merge-review-in-progress
/remove-label merge-review-needed

[IMPORTANT]
====
If your CSI driver is not listed in the preceding table, you must follow the installation instructions provided by your CSI storage vendor to use their supported CSI features.
====
endif::openshift-rosa[]
ifdef::openshift-rosa[]
In addition to the drivers listed in the preceding table, ROSA functions with CSI drivers from third-party storage vendors such as AWS FSX or Pure Storage Portworx. Red Hat does not oversee third-party provisioners or the connected CSI drivers and the vendors fully control source code, deployment, operation, and Kubernetes compatibility. These volume provisioners are considered customer-managed and the respective vendors are responsible for providing support. See the link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.html#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[Shared responsibilities for Red{nbsp}Hat OpenShift Service on AWS] matrix for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In addition to the drivers listed in the preceding table, ROSA functions with CSI drivers from third-party storage vendors such as AWS FSX or Pure Storage Portworx. Red Hat does not oversee third-party provisioners or the connected CSI drivers and the vendors fully control source code, deployment, operation, and Kubernetes compatibility. These volume provisioners are considered customer-managed and the respective vendors are responsible for providing support. See the link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.html#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[Shared responsibilities for Red{nbsp}Hat OpenShift Service on AWS] matrix for more information.
In addition to the drivers listed in the preceding table, ROSA functions with CSI drivers from third-party storage vendors such as AWS FSX or Pure Storage Portworx. Red Hat does not oversee third-party provisioners or the connected CSI drivers and the vendors fully control source code, deployment, operation, and Kubernetes compatibility. These volume provisioners are considered customer-managed and the respective vendors are responsible for providing support. See the link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.html#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[Shared responsibilities for {product-title}] matrix for more information.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @jeana-redhat! Updated! this one is good to merge whenever you get the chance

@openshift-ci openshift-ci bot 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 Feb 5, 2024
@xJustin xJustin force-pushed the OSDOCS-9364-ROSA-storage-options branch from 5b5aacd to 81a8489 Compare February 5, 2024 22:07
Copy link

openshift-ci bot commented Feb 5, 2024

@xJustin: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

@xJustin
Copy link
Contributor Author

xJustin commented Feb 6, 2024

/label merge-review-needed

Copy link
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

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

LGTM

@jeana-redhat
Copy link
Contributor

/cherrypick enterprise-4.15

@jeana-redhat
Copy link
Contributor

/cherrypick enterprise-4.14

@jeana-redhat
Copy link
Contributor

/cherrypick enterprise-4.13

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Feb 6, 2024
@jeana-redhat jeana-redhat removed the merge-review-needed Signifies that the merge review team needs to review this PR label Feb 6, 2024
@openshift-cherrypick-robot

@jeana-redhat: new pull request created: #71243

In response to this:

/cherrypick enterprise-4.15

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-cherrypick-robot

@jeana-redhat: new pull request created: #71244

In response to this:

/cherrypick enterprise-4.14

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-cherrypick-robot

@jeana-redhat: new pull request created: #71245

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 peer-review-done Signifies that the peer review team has reviewed this PR size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants