[OSDOCS-3891]: Create the OpenShift Platform Plus product guide #49279
Conversation
openshift-ci
bot
added
the
size/XXL
tmalove
changed the title
tmalove
changed the title
openshift-ci
bot
added
the
do-not-merge/work-in-progress
kalexand-rh
left a comment
kalexand-rh
left a comment
There was a problem hiding this comment.
I have some formatting suggestions and a couple of questions. I think this is shaping up well!
architecture/opp-architecture.adoc
Outdated
There was a problem hiding this comment.
Will you make these list items use parallel structure? And I strongly suggest using the attributes that define your product names throughout the PR.
architecture/opp-architecture.adoc
Outdated
There was a problem hiding this comment.
These should be links, not xrefs. And, to keep users from bouncing between sites, please use access.redhat.com links instead of the docs.openshift ones.
Because these are all links, please incorporate them into the module.
architecture/opp-architecture.adoc
Outdated
There was a problem hiding this comment.
Because these are all links, please incorporate them directly into the modules instead.
There was a problem hiding this comment.
I suggest expanding your module titles.
There was a problem hiding this comment.
Please confirm that "Registry" be capitalized here.
There was a problem hiding this comment.
Verified on the portal and corrected.
There was a problem hiding this comment.
Do you need this file?
There was a problem hiding this comment.
Not sure why this ocp file is included in this PR. You are correct, it is not a part of this guide. I will investigate.
There was a problem hiding this comment.
@tmalove, this file is still present.
There was a problem hiding this comment.
I think this needs to be removed before merging iiuc
/remove-label merge-review-in-progress
/remove-label merge-review-needed
There was a problem hiding this comment.
You can put the link here.
There was a problem hiding this comment.
Is your second {ocp} correct?
tmalove
changed the title
sagidlow
left a comment
sagidlow
left a comment
There was a problem hiding this comment.
Just some light comments about attributes, otherwise content looks great!
architecture/opp-architecture.adoc
Outdated
There was a problem hiding this comment.
| {product-title} is a single hybrid-cloud platform for enterprises to build, deploy, run, and manage intelligent applications securely across infrastructures. It is based on Red Hat Enterprise Linux, Kubernetes, and Red Hat {ocp}, and includes the following products: | |
| {product-title} is a single hybrid-cloud platform for enterprises to build, deploy, run, and manage intelligent applications securely across infrastructures. It is based on {op-system-base-full}, Kubernetes, and Red Hat {ocp}, and includes the following products: |
architecture/opp-architecture.adoc
Outdated
There was a problem hiding this comment.
| * Red Hat Advanced Cluster Management for Kubernetes - Controls clusters and applications from a single console. | |
| * {rh-rhacm-first} for Kubernetes - Controls clusters and applications from a single console. |
There was a problem hiding this comment.
| |Red Hat Advanced Cluster Management release | |
| |{rh-rhacm-first} release |
There was a problem hiding this comment.
| To install {product-title}, install {ocp}, Red Hat Advanced Cluster Management, Quay, OpenShift Data Foundation Essentials, and Red Hat Advanced Cluster Security. See the following detailed installation information for the {product-title} products: | |
| To install {product-title}, install {ocp}, {rh-rhacm-first}, Quay, OpenShift Data Foundation Essentials, and Red Hat Advanced Cluster Security. See the following detailed installation information for the {product-title} products: |
There was a problem hiding this comment.
| IMPORTANT: You must first install {ocp}, followed by Red Hat Advanced Cluster Management. The remaining products can be installed in any order. | |
| IMPORTANT: You must first install {ocp}, followed by {rh-rhacm-first}. The remaining products can be installed in any order. |
There was a problem hiding this comment.
| . Install Red Hat Advanced Cluster Management. For detailed information, see _Installing Red Hat Advanced Cluster Management for Kubernetes_. | |
| . Install {rh-rhacm-first}. For detailed information, see _Installing Red Hat Advanced Cluster Management for Kubernetes_. |
architecture/opp-architecture.adoc
Outdated
There was a problem hiding this comment.
I would add Red Hat Advanced Cluster Security to your common-attributes.adoc file. Maybe coordinate with Kathryn and see what the best attribute would be for this? I didn't see this in the common-attributes.adoc file in OpenShift. If and when you add this to your common-attributes file just go through the whole doc and make sure you update any hardcoded referenced to "Red Hat Advanced Cluster Security" references to the attribute reference.
There was a problem hiding this comment.
You can make any attributes you need and name them whatever makes most sense! (If I were adding it, I might make it :acs:.)
architecture/opp-architecture.adoc
Outdated
There was a problem hiding this comment.
I would add Quay to your common-attributes.adoc file. I don't see Red Hat Quay as a part of the common-attributes.adoc file in the main branch. Maybe coordinate with Steven Smith and Kathryn to see if it should be added? If and when you add this to your common-attributes file just go through the whole doc and make sure you update any hardcoded referenced to "Red Hat Quay" references to the attribute reference.
architecture/opp-architecture.adoc
Outdated
There was a problem hiding this comment.
I would add Red Hat OpenShift Data Foundation to your common-attributes.adoc file. In the OpenShift main branch for common-attributes.adoc file it is listed as
:rh-storage-first: Red Hat OpenShift Data Foundation
Maybe coordinate with Kathryn to see if it should be added? If and when you add this to your common-attributes file just go through the whole doc and make sure you update any hardcoded referenced to "Red Hat OpenShift Data Foundation" references to the attribute reference.
|
🤖 Bots are busy building the preview. It will be available soon at: |
|
/label peer-review-needed |
openshift-ci
bot
added
the
peer-review-needed
jboxman-rh
left a comment
jboxman-rh
left a comment
There was a problem hiding this comment.
@tmalove, I've left some comments for your review.
Thanks for your work on this!
There was a problem hiding this comment.
@tmalove, I'd uppercase compliance.
There was a problem hiding this comment.
Do we want a single coma here? Maybe and? Not sure what kind of cache this means.
There was a problem hiding this comment.
This was a product name; I think we just rebranded this and the following bullet. Is it worth confirming?
There was a problem hiding this comment.
I wonder if this should be {product_title} as well?
There was a problem hiding this comment.
Do we want to use attributes where applicable for these link names?
There was a problem hiding this comment.
@tmalove, this file is still present.
jboxman-rh
added
peer-review-in-progress
|
/label peer-review-done |
openshift-ci
bot
added
the
peer-review-done
|
/remove-label peer-review-in-progress |
openshift-ci
bot
removed
the
peer-review-in-progress
There was a problem hiding this comment.
Should we offer a more user friendly installation method in these docs as well?
Maybe this is just too early in the process but internally we have solutions using openshift-plus policyset and Helm-Charts for doing this deployment.
Asking our customers to do 5 separate product installs for a single bundle that they have purchased just doesn't feel right. I'm curious if we are open to exploring documentation for a deployment that will be easier on the user.
There was a problem hiding this comment.
Hi @ascerra This is an item that we should discuss during the team meeting. I agree that a single deployment would be easier, seamless, and more receptive to customers and our internal teams. I will request a discussion as soon as possible.
There was a problem hiding this comment.
@ascerra We discussed this in the latest team meeting and the answer is that we will not have a universal installer; we want people to use policy sets for the installation.
There was a problem hiding this comment.
I believe having a section about minimum resource requirements specifically for OPP would go a long way to the user experience here. It took me a lot of trial and error going through all the different products documentation to finally get to a point where I was deploying these products with enough capacity on my underlying infrastructure. My experience was with AWS & Openstack, which brings up the difficulty of this ask. Would we need specifics for minimum specs for each public cloud? This would be most helpful but tough to achieve and maintain I'm sure. ACM docs attempt to do this for the big 3 here
Having something that describes the absolute minimum resource requirements for OPP to install sucessfully like we see in ODF resource requirements would be very helpful.
There was a problem hiding this comment.
Thanks for this @ascerra. This is on the list to discuss with the engineering to get in the guide soon after the first publishing. I will include you on the ODCBUGS Jira for transparency.
tmalove
force-pushed
the
opp-product-guide-osdocs-3892
branch
from
626ae25 to
e41554d
Compare
|
/label quay-eng-ack |
|
@BillDett: The label(s) In 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. |
There was a problem hiding this comment.
It looks like this was changed to rh-rhacm causing it to not show the real value in the preview when compiled.
There was a problem hiding this comment.
It looks like rh-rhacm-first was changed to rh-rhacm causing it to not show the real value in the preview when compiled.
tmalove
changed the title
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
Hi @BillDett you can apply the '/LGTM' label and that will suffice for your ack...thanks! |
|
/LGTM |
|
/label merge-review-needed |
openshift-ci
bot
added
the
merge-review-needed
jeana-redhat
added
the
merge-review-in-progress
openshift-ci
bot
removed
merge-review-in-progress
|
/LGTM |
kalexand-rh
force-pushed
the
opp-product-guide-osdocs-3892
branch
from
e41554d to
0bfd7bf
Compare
|
New changes are detected. LGTM label has been removed. |
openshift-ci
bot
added
size/L
|
OPP uses its own branch and is versionless, so no CPs are required. |
8 participants
Version(s): 4.11+
Issue: OSDOCS-3891
Link to docs preview: http://file.rdu.redhat.com/tlove/opp/architecture/opp-architecture.html#opp-architecture-compatibility-matrix_opp-architecture (Updated: 11/11)
Reviews:
Additional information: