Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
:toc-title:
:imagesdir: images
:prewrap!:
:acs: Red Hat Advanced Cluster Security
:quay: Red Hat Quay
:rh-storage-essentials-first: Red Hat OpenShift Data Foundation Essentials
:rh-storage-data-foundation: Red Hat OpenShift Data Foundation
:op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
:op-system: RHCOS
:op-system-base: RHEL
Expand All @@ -19,8 +23,7 @@
:cloud-redhat-com: Red Hat OpenShift Cluster Manager
:rh-storage-first: Red Hat OpenShift Container Storage
:rh-storage: OpenShift Container Storage
:rh-rhacm-first: Red Hat Advanced Cluster Management (RHACM)
:rh-rhacm: RHACM
:rh-rhacm: Red Hat Advanced Cluster Management
:sandboxed-containers-first: OpenShift sandboxed containers
:sandboxed-containers: Sandboxed Containers Operator
:rh-virtualization-first: Red Hat Virtualization (RHV)
Expand All @@ -33,9 +36,8 @@
:ocp: OpenShift Container Platform
:olm-first: Operator Lifecycle Manager (OLM)
:olm: OLM
:ocp-supported-version: 4.5
:ocp-supported-version: 4.11
// Following variables are required for publishing using PV2
:product-title: OpenShift Platform Plus
:product-version: .1
:product-title-short: OPP

16 changes: 13 additions & 3 deletions architecture/opp-architecture.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
[id="opp-architecture"]
= {product-title} architecture
= {product-title} overview
include::_attributes/common-attributes.adoc[]
:context: opp-architecture

toc::[]

Discover {product-title} architecture and concepts.
{product-title} is a single hybrid-cloud platform for enterprises. Use it to build, deploy, run, and manage intelligent applications securely across infrastructures. It is based on {op-system-base-full}, Kubernetes, and Red Hat {ocp}. It includes the following products:

include::modules/opp-architecture-overview.adoc[leveloffset=+1]
* {rh-rhacm} for Kubernetes - Controls clusters and applications from a single console.
* {acs} for Kubernetes - Provides information about cluster security, visibility management, and security compliance.
* {quay} - Stores, builds, and deploys container images.
* {rh-storage-essentials-first} - Provides a permanent place to store data while clusters spin up and down across environments.


include::modules/opp-architecture-architecture.adoc[leveloffset=+1]
include::modules/opp-architecture-installation.adoc[leveloffset=+1]
include::modules/opp-architecture-relnotes.adoc[leveloffset=+1]
include::modules/opp-architecture-compatibility-matrix.adoc[leveloffset=+1]
include::modules/opp-architecture-support.adoc[leveloffset=+1]
Binary file added images/242_OpenShift_Plus_0422.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions modules/opp-architecture-architecture.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// Module included in the following assemblies:
//
// * architecture/opp-architecture.adoc

:_module-type: CONCEPT
[id="opp-architecture-architecture_{context}"]
= {product-title} description and architecture

{product-title} builds on the capabilities of {ocp} with the following features:

* Multi-cluster security
* Complete management capabilities
* Integrated data management
* A global container registry

{product-title} protects and manages applications across open hybrid cloud environments and application lifecycles.

image::242_OpenShift_Plus_0422.png[]

{product-title} supports these additional capabilities:

* Platform services
** Service mesh, serverless
** Builds, CI/CD pipelines
** GitOps, Distributed tracing
** Log management
** Cost management
** Vulnerability management
** Compliance

* Application services
** Languages and runtimes
** API management
** Integration
** Messaging
** Process automation

* Data services
** Databases and cache
** Data ingest and preparation
** Data analytics
** AI/ML

* Developer services
** Developer CLI/IDE
** Plug-ins and extensions
** Red Hat OpenShift Dev Spaces
** Red Hat OpenShift Local
22 changes: 22 additions & 0 deletions modules/opp-architecture-compatibility-matrix.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// Module included in the following assemblies:
//
// * architecture/opp-architecture.adoc

:_module-type: CONCEPT
[id="opp-architecture-compatibility-matrix_{context}"]
= {product-title} product release compatibility matrix

{product-title} is based on {ocp} {ocp-supported-version}. To find the verified release number for each {product-title} product, see the following information:

[cols="1,1,1,1"]
|===
|{rh-rhacm}
|{acs}
|{quay}
|{rh-storage-essentials-first}

|2.6
|3.72
|3.7
|4.11
|===
15 changes: 15 additions & 0 deletions modules/opp-architecture-installation.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Module included in the following assemblies:
//
// * architecture/opp-architecture.adoc

:_module-type: PROCEDURE
[id="opp-architecture-installation_{context}"]
= Install {product-title} products

Copy link

@ascerra ascerra Sep 22, 2022

Choose a reason for hiding this comment

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

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.

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 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.

To install {product-title}, you must install five products in a specific order. Install {ocp} first. Then, install {rh-rhacm}. It does not matter what order you install the remaining products: {quay}, {rh-storage-essentials-first}, and {acs}. See the following detailed installation information for each product:
Copy link

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@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.


* {ocp} - link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.11/html/installing/installing-preparing#supported-installation-methods-for-different-platforms[Supported installation methods for different platforms]
* {rh-rhacm} - link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.0/html/install/installing[Installing {rh-rhacm}]
* {acs} - link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_security_for_kubernetes/3.71/html/installing/install-ocp-operator[Installing {acs} for Kubernetes by using an Operator]
* {rh-storage-essentials-first} - link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.11[Deploying {rh-storage-data-foundation}]
* {quay} - link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploy_red_hat_quay_on_openshift_with_the_quay_operator/index[Deploy {quay} on OpenShift with the Quay Operator]
9 changes: 0 additions & 9 deletions modules/opp-architecture-overview.adoc

This file was deleted.

15 changes: 15 additions & 0 deletions modules/opp-architecture-relnotes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Module included in the following assemblies:
//
// * architecture/opp-architecture.adoc

:_module-type: CONCEPT
[id="opp-architecture-relnotes_{context}"]
= {product-title} product release notes

The release note information for each product is accessible from the following list:

* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.11/html/release_notes/index[{ocp}]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.6/html/release_notes/red-hat-advanced-cluster-management-for-kubernetes-release-notes[{rh-rhacm} for Kubernetes]
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/3.7/html/red_hat_quay_release_notes/index[{quay}]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_security_for_kubernetes/3.72/html/release_notes/index[{acs} for Kubernetes]
* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.11/html/4.11_release_notes/index[{rh-storage-data-foundation}]
11 changes: 11 additions & 0 deletions modules/opp-architecture-support.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// Module included in the following assemblies:
//
// * architecture/opp-architecture.adoc

:_module-type: CONCEPT
[id="opp-architecture-support_{context}"]
= Get support for {product-title}

Red Hat offers cluster administrator tools for gathering data, monitoring, and troubleshooting your cluster.

If you need assistance with your {product-title} solution, log a case in the appropriate product using its entitlement name. See the link:https://access.redhat.com/support/cases/#/case/list?query=%20orderBy%20lastModifiedDate%20desc&p=1&size=10&searchType=basic[Red Hat customer support portal] to open a support case.