From 420404063c1f741ddfe5c8890f1e859288e1287d Mon Sep 17 00:00:00 2001 From: EricPonvelle Date: Fri, 24 Oct 2025 16:55:40 -0500 Subject: [PATCH] OSDOCS-16524: Updated ROSA Architecture for DITA compliance --- .vale.ini | 6 +- modules/rosa-architecture-topics.adoc | 34 +++ modules/rosa-cluster-admin-topics.adoc | 36 +++ modules/rosa-developer-topics.adoc | 28 ++ modules/rosa-getting-started-learn.adoc | 8 + modules/rosa-key-features.adoc | 20 ++ modules/rosa-next-steps-cluster.adoc | 8 + rosa_architecture/about-hcp.adoc | 245 +----------------- .../cloud-experts-rosa-hcp-sts-explained.adoc | 2 + rosa_architecture/index.adoc | 5 + .../learn_more_about_openshift.adoc | 2 + rosa_architecture/legal-notice.adoc | 2 + .../rosa-admission-plug-ins.adoc | 5 +- .../rosa-architecture-models.adoc | 2 + rosa_architecture/rosa-oidc-overview.adoc | 6 +- .../rosa-sts-about-iam-resources.adoc | 15 +- rosa_architecture/rosa-understanding.adoc | 9 +- .../rosa-hcp-instance-types.adoc | 4 +- .../rosa-hcp-life-cycle.adoc | 1 + .../rosa-hcp-service-definition.adoc | 1 + .../rosa-instance-types.adoc | 3 +- .../rosa-life-cycle.adoc | 1 + .../rosa-policy-process-security.adoc | 3 +- .../rosa-policy-responsibility-matrix.adoc | 1 + .../rosa-policy-understand-availability.adoc | 3 +- .../rosa-service-definition.adoc | 3 +- .../rosa-sre-access.adoc | 3 +- 27 files changed, 195 insertions(+), 261 deletions(-) create mode 100644 modules/rosa-architecture-topics.adoc create mode 100644 modules/rosa-cluster-admin-topics.adoc create mode 100644 modules/rosa-developer-topics.adoc create mode 100644 modules/rosa-getting-started-learn.adoc create mode 100644 modules/rosa-key-features.adoc create mode 100644 modules/rosa-next-steps-cluster.adoc diff --git a/.vale.ini b/.vale.ini index 65f3d56548d2..7f21caaddb14 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,14 +1,14 @@ StylesPath = .vale/styles -MinAlertLevel = suggestion +MinAlertLevel = warning Packages = RedHat, AsciiDoc, OpenShiftAsciiDoc, https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip Vocab = OpenShiftDocs # Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files -[[!.]*.adoc] -BasedOnStyles = RedHat, AsciiDoc, OpenShiftAsciiDoc +[*.adoc] +BasedOnStyles = AsciiDocDITA # Disabling rules (NO) RedHat.ReleaseNotes = NO diff --git a/modules/rosa-architecture-topics.adoc b/modules/rosa-architecture-topics.adoc new file mode 100644 index 000000000000..6133a2895d88 --- /dev/null +++ b/modules/rosa-architecture-topics.adoc @@ -0,0 +1,34 @@ +// Module included in the following assemblies: +// +// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc +:_mod-docs-content-type: CONCEPT +[id="architect_{context}"] += Architect +[options="header",cols="3*"] +|=== +| Learn about {rosa-title} |Plan {rosa-title} deployment |Additional resources + +| +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/architecture/architecture-overview#architecture-overview[Architecture overview] +| +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/backup_and_restore/oadp-application-backup-and-restore[Back up and restore] +| +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/introduction_to_rosa/policies-and-service-definition#rosa-hcp-life-cycle[{product-title} life cycle] +| +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/architecture/rosa-architecture-models#rosa-architecture-models[{product-title} architecture] + +| +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/introduction_to_rosa/policies-and-service-definition#rosa-policy-process-security[Understanding process and security] + +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/introduction_to_rosa/policies-and-service-definition[{product-title} service definition] + +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/introduction_to_rosa/policies-and-service-definition#rosa-hcp-life-cycle[Updates lifecycle] +| + +| +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/support/support-overview#support-overview[Getting support] + +| +| +| link:https://red.ht/rosa-roadmap[ROSA roadmap] +|=== \ No newline at end of file diff --git a/modules/rosa-cluster-admin-topics.adoc b/modules/rosa-cluster-admin-topics.adoc new file mode 100644 index 000000000000..5531c06dd4b2 --- /dev/null +++ b/modules/rosa-cluster-admin-topics.adoc @@ -0,0 +1,36 @@ +// Module included in the following assemblies: +// +// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc +:_mod-docs-content-type: CONCEPT +[id="cluster-administrator_{context}"] += Cluster Administrator +[options="header",cols="4*"] +|=== +|Learn about {product-title} |Deploy {product-title} |Manage {product-title} |Additional resources +//Row 1 +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws_classic_architecture/4/html/architecture/rosa-architecture-models#rosa-architecture-models[{product-title} architecture] +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/install_clusters/rosa-hcp-sts-creating-a-cluster-quickly[Installing {product-title}] +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/logging/about-logging[Logging] +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/support/index#rosa-troubleshooting-installing_rosa-troubleshooting-installations[Getting Support] +//Row 2 +|link:https://learn.openshift.com/?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[OpenShift Interactive Learning Portal] +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/storage/index#storage-overview[Storage] +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/monitoring/index#about-monitoring[About {product-title} monitoring] + +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/introduction_to_rosa/index#rosa-hcp-life-cycle[{product-title} life cycle] + +link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/introduction_to_rosa/policies-and-service-definition#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[{product-title} responsibility matrix] + +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/backup_and_restore/oadp-application-backup-and-restore#oadp-introduction[Back up and restore] + +//Row 3 +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/introduction_to_rosa/rosa-hcp-about-iam-resources[About IAM resources] +|link:https://red.ht/rosa-roadmap[{product-title} roadmap] +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/introduction_to_rosa/policies-and-service-definition#about-availability-for-rosa[About availability] + + +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/upgrading/index#rosa-hcp-upgrading[Upgrading] +| +| + +|=== \ No newline at end of file diff --git a/modules/rosa-developer-topics.adoc b/modules/rosa-developer-topics.adoc new file mode 100644 index 000000000000..11c299677669 --- /dev/null +++ b/modules/rosa-developer-topics.adoc @@ -0,0 +1,28 @@ +// Module included in the following assemblies: +// +// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc +:_mod-docs-content-type: CONCEPT +[id="rosa-developer-topics_{context}"] += Developer + +[options="header",cols="3*"] +|=== +|Learn about application development in {product-title} |Deploy applications |Additional resources + +|link:https://developers.redhat.com/[Red{nbsp}Hat Developers site] +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/building_applications/building-applications-overview#building-applications-overview[Building applications overview] +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/support/support-overview#support-overview[Getting support] + +|link:https://developers.redhat.com/products/openshift-dev-spaces/overview[{openshift-dev-spaces-productname} (formerly Red{nbsp}Hat CodeReady Workspaces)] +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/operators/operators-overview#operators-overview[Operators overview] +|link:https://red.ht/rosa-roadmap[{product-title} roadmap] +| + +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/images/overview-of-images#overview-of-images[Images] +| + +| +|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/cli_tools/developer-cli-odo#odo-important_update[Developer-focused CLI] +| + +|=== \ No newline at end of file diff --git a/modules/rosa-getting-started-learn.adoc b/modules/rosa-getting-started-learn.adoc new file mode 100644 index 000000000000..6b5bafebfcc4 --- /dev/null +++ b/modules/rosa-getting-started-learn.adoc @@ -0,0 +1,8 @@ +// Module included in the following assemblies: +// +// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc +:_mod-docs-content-type: CONCEPT +[id="rosa-getting-started-learn_{context}"] += Getting started with {product-title} + +Use the following sections to find content to help you learn about and use {product-title}. \ No newline at end of file diff --git a/modules/rosa-key-features.adoc b/modules/rosa-key-features.adoc new file mode 100644 index 000000000000..76f26cd373d3 --- /dev/null +++ b/modules/rosa-key-features.adoc @@ -0,0 +1,20 @@ +// Module included in the following assemblies: +// +// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc +:_mod-docs-content-type: CONCEPT +[id="rosa-key-features_{context}"] += Key features of {product-title} + +* *Cluster node scaling:* {product-title} requires a minimum of only two nodes, making it ideal for smaller projects while still being able to scale to support larger projects and enterprises. Easily add or remove compute nodes to match resource demand. Autoscaling allows you to automatically adjust the size of the cluster based on the current workload. See link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/cluster_administration/rosa-cluster-autoscaling-hcp[About autoscaling nodes on a cluster] for more details. + +* *Fully managed underlying control plane infrastructure:* Control plane components, such as the API server and etcd database, are hosted in a Red{nbsp}Hat-owned AWS account. +* *Rapid provisioning time:* Provisioning time is approximately 10 minutes. +* *Continued cluster operation during upgrades:* Customers can upgrade the control plane and machine pools separately, ensuring the cluster remains operational during the upgrade process. +* *Native AWS service:* Access and use Red{nbsp}Hat OpenShift on-demand with a self-service onboarding experience through the AWS management console. +* *Flexible, consumption-based pricing:* Scale to your business needs and pay as you go with flexible pricing and an on-demand hourly or annual billing model. +* *Single bill for Red{nbsp}Hat OpenShift and AWS usage:* Customers will receive a single bill from AWS for both Red{nbsp}Hat OpenShift and AWS consumption. +* *Fully integrated support experience:* Management, maintenance, and upgrades are performed by Red{nbsp}Hat site reliability engineers (SREs) with joint Red{nbsp}Hat and Amazon support and a 99.95% service-level agreement (SLA). See the link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/support/getting-support#getting-support[{product-title} support documentation] for more details. +* *AWS service integration:* AWS has a robust portfolio of cloud services, such as compute, storage, networking, database, analytics, Virtualization and AI. All of these services are directly accessible through {product-title}. This makes it easier to build, operate, and scale globally and on-demand through a familiar management interface. +* *Maximum availability:* Deploy clusters across multiple availability zones in supported regions to maximize availability and maintain high availability for your most demanding mission-critical applications and data. +* *Optimized clusters:* Choose from memory-optimized, compute-optimized, general purpose, or accelerated EC2 instance types with clusters to meet your needs. +* *Global availability:* Refer to the link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/introduction_to_rosa/policies-and-service-definition#rosa-sdpolicy-regions-az_rosa-hcp-service-definition[product regional availability page] to see where {product-title} is available globally. \ No newline at end of file diff --git a/modules/rosa-next-steps-cluster.adoc b/modules/rosa-next-steps-cluster.adoc new file mode 100644 index 000000000000..3c598248265d --- /dev/null +++ b/modules/rosa-next-steps-cluster.adoc @@ -0,0 +1,8 @@ +// Module included in the following assemblies: +// +// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc +:_mod-docs-content-type: CONCEPT +[id="rosa-next-steps-cluster_{context}"] += Before creating your first {product-title} cluster + +For additional information about ROSA installation, see a qucik introdcution to the process in link:https://www.redhat.com/en/products/interactive-walkthrough/install-rosa[Installing {product-title} interactive walkthrough]. \ No newline at end of file diff --git a/rosa_architecture/about-hcp.adoc b/rosa_architecture/about-hcp.adoc index fb8a9349dd4b..28b005d15abf 100644 --- a/rosa_architecture/about-hcp.adoc +++ b/rosa_architecture/about-hcp.adoc @@ -1,6 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="about-hcp"] = {product-title} overview + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: about-hcp @@ -10,6 +11,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] +[role="_abstract"] {product-title} is a fully-managed turnkey application platform that allows you to focus on what matters most, delivering value to your customers by building and deploying applications. Red{nbsp}Hat and AWS SRE experts manage the underlying platform so you do not have to worry about infrastructure management. {product-title} provides seamless integration with a wide range of AWS compute, database, analytics, machine learning, networking, mobile, AI and other services to further accelerate the building and delivering of differentiating experiences to your customers. {product-title} offers a reduced-cost solution to create a managed {product-title} cluster with a focus on efficiency and security. You can quickly create a new cluster and deploy applications in minutes. @@ -20,253 +22,26 @@ You receive OpenShift updates with new feature releases and a shared, common sou image::291_OpenShift_on_AWS_Intro_1122_docs.png[{product-title}] -{product-title} uses AWS Security Token Service (STS) with AWS IAM to obtain credentials to manage infrastructure in your AWS account. AWS STS is a global web service that creates temporary credentials for IAM users/roles or federated users/roles. {product-title} uses this to assign short-term, limited-privilege, security credentials. These credentials are associated with IAM roles that are specific to each component that makes AWS API calls. This method aligns with the principals of least privilege and secure practices in cloud service resource management. The ROSA command-line interface (CLI) tool manages the STS credentials that are assigned for unique tasks and takes action on AWS resources as part of OpenShift functionality. For a more detailed explanation, see xref:../rosa_architecture/cloud-experts-rosa-hcp-sts-explained.adoc#cloud-experts-rosa-hcp-sts-explained[AWS STS and ROSA with HCP explained]. - -== Key features of {product-title} +{product-title} uses AWS Security Token Service (STS) with AWS IAM to obtain credentials to manage infrastructure in your AWS account. AWS STS is a global web service that creates temporary credentials for IAM users/roles or federated users/roles. {product-title} uses this to assign short-term, limited-privilege, security credentials. These credentials are associated with IAM roles that are specific to each component that makes AWS API calls. This method aligns with the principals of least privilege and secure practices in cloud service resource management. The ROSA command-line interface (CLI) tool manages the STS credentials that are assigned for unique tasks and takes action on AWS resources as part of OpenShift functionality. For a more detailed explanation, see xref:../rosa_architecture/cloud-experts-rosa-hcp-sts-explained.adoc#cloud-experts-rosa-hcp-sts-explained[AWS STS and {product-title} explained]. -* *Cluster node scaling:* {product-title} requires a minimum of only two nodes, making it ideal for smaller projects while still being able to scale to support larger projects and enterprises. Easily add or remove compute nodes to match resource demand. Autoscaling allows you to automatically adjust the size of the cluster based on the current workload. See -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.html#rosa-nodes-about-autoscaling-nodes[About autoscaling nodes on a cluster] for more details. -endif::openshift-rosa-hcp[] -ifdef::openshift-rosa[] -xref:../rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc#rosa-nodes-about-autoscaling-nodes[About autoscaling nodes on a cluster] for more details. -endif::openshift-rosa[] -* *Fully managed underlying control plane infrastructure:* Control plane components, such as the API server and etcd database, are hosted in a Red{nbsp}Hat-owned AWS account. -* *Rapid provisioning time:* Provisioning time is approximately 10 minutes. -* *Continued cluster operation during upgrades:* Customers can upgrade the control plane and machine pools separately, ensuring the cluster remains operational during the upgrade process. -* *Native AWS service:* Access and use Red{nbsp}Hat OpenShift on-demand with a self-service onboarding experience through the AWS management console. -* *Flexible, consumption-based pricing:* Scale to your business needs and pay as you go with flexible pricing and an on-demand hourly or annual billing model. -* *Single bill for Red{nbsp}Hat OpenShift and AWS usage:* Customers will receive a single bill from AWS for both Red{nbsp}Hat OpenShift and AWS consumption. -* *Fully integrated support experience:* Management, maintenance, and upgrades are performed by Red{nbsp}Hat site reliability engineers (SREs) with joint Red{nbsp}Hat and Amazon support and a 99.95% service-level agreement (SLA). See the -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/support/getting-support.html#getting-support[ROSA support documentation] for more details. -endif::openshift-rosa-hcp[] -ifdef::openshift-rosa[] -xref:../support/getting-support.adoc#getting-support[ROSA support documentation] for more details. -endif::openshift-rosa[] -* *AWS service integration:* AWS has a robust portfolio of cloud services, such as compute, storage, networking, database, analytics, Virtualization and AI. All of these services are directly accessible through ROSA. This makes it easier to build, operate, and scale globally and on-demand through a familiar management interface. -* *Maximum availability:* Deploy clusters across multiple availability zones in supported regions to maximize availability and maintain high availability for your most demanding mission-critical applications and data. -* *Optimized clusters:* Choose from memory-optimized, compute-optimized, general purpose, or accelerated EC2 instance types with clusters to meet your needs. -* *Global availability:* Refer to the xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-sdpolicy-regions-az_rosa-hcp-service-definition[product regional availability page] to see where ROSA is available globally. +include::modules/rosa-key-features.adoc[leveloffset=+1] include::modules/rosa-sdpolicy-am-billing.adoc[leveloffset=+1] -== Getting started with {product-title} - -Use the following sections to find content to help you learn about and use {product-title}. - -[id="architect"] -=== Architect -[options="header",cols="3*"] -|=== -| Learn about {hcp-title} |Plan {hcp-title} deployment |Additional resources - -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/architecture/index.html#architecture-overview[Architecture overview] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../architecture/index.adoc#architecture-overview[Architecture overview] -endif::openshift-rosa-hcp[] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/rosa_backing_up_and_restoring_applications/backing-up-applications.html#rosa-backing-up-applications[Back up and restore] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../backup_and_restore/application_backup_and_restore/oadp-intro.adoc#oadp-api[Back up and restore] -endif::openshift-rosa-hcp[] -ifdef::openshift-rosa-hcp[]| -xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[{hcp-title} life cycle] -endif::openshift-rosa-hcp[]| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/architecture/rosa-architecture-models.html#rosa-architecture-models[{hcp-title} architecture] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../architecture/rosa-architecture-models.adoc#rosa-architecture-models[{hcp-title} architecture] -endif::openshift-rosa-hcp[] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.html#rosa-policy-process-security[Understanding process and security] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../../rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.adoc#rosa-policy-process-security[Understanding process and security] -endif::openshift-rosa-hcp[] - -ifdef::openshift-rosa-hcp[] -xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-hcp-service-definition[{hcp-title} service definition] - -endif::openshift-rosa-hcp[] -xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[Updates lifecycle] -| -// Removed as part of OSDOCS-13310, until figures are verified. -// ifdef::openshift-rosa-hcp[] -// link:https://docs.openshift.com/rosa/rosa_planning/rosa-limits-scalability.html#rosa-limits-scalability[Limits and scalability] -// endif::openshift-rosa-hcp[] -// ifndef::openshift-rosa-hcp[] -// xref:../../rosa_planning/rosa-limits-scalability.adoc#rosa-limits-scalability[Limits and scalability] -// endif::openshift-rosa-hcp[] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/support/index.html#support-overview[Getting support] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../support/index.adoc#support-overview[Getting support] -endif::openshift-rosa-hcp[] -| -| -| link:https://red.ht/rosa-roadmap[ROSA roadmap] -|=== - -[id="cluster-administrator"] -=== Cluster Administrator -[options="header",cols="4*"] -|=== -|Learn about {hcp-title} |Deploy {hcp-title} |Manage {hcp-title} |Additional resources -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/architecture/rosa-architecture-models.html#rosa-architecture-models[{product-title} architecture] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../architecture/rosa-architecture-models.adoc#rosa-architecture-models[{product-title} architecture] -endif::openshift-rosa-hcp[] -| -xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-quickly[Installing {product-title}] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/observability/logging/cluster-logging.html#cluster-logging[Logging] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../observability/logging/cluster-logging.adoc#cluster-logging[Logging] -endif::openshift-rosa-hcp[] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/support/index.html#support-overview[Getting Support] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../support/index.adoc#support-overview[Getting Support] -endif::openshift-rosa-hcp[] - - - -| link:https://learn.openshift.com/?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[OpenShift Interactive Learning Portal] -| -xref:../storage/index.adoc#storage-overview[Storage] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/observability/monitoring/about-openshift-container-platform-monitoring.html#about-ocp-monitoring[About {product-title} monitoring] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] -endif::openshift-rosa-hcp[] - -ifdef::openshift-rosa-hcp[] -xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[{product-title}life cycle] -endif::openshift-rosa-hcp[] - -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.html#rosa-policy-responsibility-matrix[ROSA responsibility matrix] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../../rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.adoc#rosa-policy-responsibility-matrix[ROSA responsibility matrix] -endif::openshift-rosa-hcp[] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/rosa_backing_up_and_restoring_applications/backing-up-applications.html#rosa-backing-up-applications[Back up and restore] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../backup_and_restore/application_backup_and_restore/oadp-intro.adoc#oadp-api[Back up and restore] -endif::openshift-rosa-hcp[] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/rosa_architecture/rosa-sts-about-iam-resources.html#rosa-sts-about-iam-resources[About IAM resources] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources] -endif::openshift-rosa-hcp[] - -|link:https://red.ht/rosa-roadmap[ROSA roadmap] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-understand-availability.html#rosa-policy-understand-availability[About availability] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../../rosa_architecture/rosa_policy_service_definition/rosa-policy-understand-availability.adoc#rosa-policy-understand-availability[About availability] -endif::openshift-rosa-hcp[] -//adding condition to get hcp upgrading PR built -ifdef::openshift-rosa-hcp[] -|xref:../upgrading/rosa-hcp-upgrading.adoc#rosa-hcp-upgrading[Upgrading] -endif::openshift-rosa-hcp[] -| -| - -|=== - - -[id="Developer"] -=== Developer - -[options="header",cols="3*"] -|=== -|Learn about application development in {product-title} |Deploy applications |Additional resources - -| link:https://developers.redhat.com/[Red{nbsp}Hat Developers site] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/applications/index.html#building-applications-overview[Building applications overview] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../applications/index.adoc#building-applications-overview[Building applications overview] -endif::openshift-rosa-hcp[] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/support/index.html#support-overview[Getting support] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../support/index.adoc#support-overview[Getting support] -endif::openshift-rosa-hcp[] -| link:https://developers.redhat.com/products/openshift-dev-spaces/overview[{openshift-dev-spaces-productname} (formerly Red{nbsp}Hat CodeReady Workspaces)] -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/operators/index.html#operators-overview[Operators overview] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../operators/index.adoc#operators-overview[Operators overview] -endif::openshift-rosa-hcp[] -| link:https://red.ht/rosa-roadmap[ROSA roadmap] - -| -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/openshift_images/index.html#overview-of-images[Images] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../openshift_images/index.adoc#overview-of-images[Images] -endif::openshift-rosa-hcp[] -| - -| -| -ifdef::openshift-rosa-hcp[] -link:https://docs.openshift.com/rosa/cli_reference/odo-important-update.html#odo-important_update[Developer-focused CLI] -endif::openshift-rosa-hcp[] -ifndef::openshift-rosa-hcp[] -xref:../cli_reference/odo-important-update.adoc#odo-important_update[Developer-focused CLI] -endif::openshift-rosa-hcp[] -| +include::modules/rosa-getting-started-learn.adoc[leveloffset=+1] -|=== +include::modules/rosa-architecture-topics.adoc[leveloffset=+2] -=== Before creating your first {product-title} cluster +include::modules/rosa-cluster-admin-topics.adoc[leveloffset=+2] -//Per PM review, commented out until we get a valid ROSA HCP demo. -// Watch a link:https://youtu.be/KbzUbXWs6Ck[demo] of the cluster deployment process. +include::modules/rosa-developer-topics.adoc[leveloffset=+2] -For additional information about ROSA installation, see a qucik introdcution to the process in link:https://www.redhat.com/en/products/interactive-walkthrough/install-rosa[Installing {product-title} interactive walkthrough]. +include::modules/rosa-next-steps-cluster.adoc[leveloffset=+2] [role="_additional-resources"] == Additional resources -* link:https://www.openshift.com/products/amazon-openshift[ROSA product page] +* link:https://www.openshift.com/products/amazon-openshift[{product-title} product page] * link:https://aws.amazon.com/rosa/[AWS product page] * link:https://access.redhat.com/products/red-hat-openshift-service-aws[Red{nbsp}Hat Customer Portal] * link:https://learn.openshift.com[Learn about OpenShift] diff --git a/rosa_architecture/cloud-experts-rosa-hcp-sts-explained.adoc b/rosa_architecture/cloud-experts-rosa-hcp-sts-explained.adoc index 7f634278d4f3..ee20ee03f189 100644 --- a/rosa_architecture/cloud-experts-rosa-hcp-sts-explained.adoc +++ b/rosa_architecture/cloud-experts-rosa-hcp-sts-explained.adoc @@ -1,6 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="cloud-experts-rosa-hcp-sts-explained"] = AWS STS and ROSA with HCP explained + include::_attributes/common-attributes.adoc[] include::_attributes/attributes-openshift-dedicated.adoc[] :context: cloud-experts-rosa-hcp-sts-explained @@ -11,6 +12,7 @@ toc::[] //Brought into ROSA product docs 2023-10-26 //Modified for HCP 2024-4-16 +[role="_abstract"] {hcp-title-first} uses an AWS (Amazon Web Services) Security Token Service (STS) for AWS Identity Access Management (IAM) to obtain the necessary credentials to interact with resources in your AWS account. [id="credential-methods-rosa-hcp"] diff --git a/rosa_architecture/index.adoc b/rosa_architecture/index.adoc index 7b20c50b8b95..7692cee8f2d9 100644 --- a/rosa_architecture/index.adoc +++ b/rosa_architecture/index.adoc @@ -1,6 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="welcome-index"] = {product-title} {product-version} Documentation + include::_attributes/common-attributes.adoc[] :context: welcome-index {toc} @@ -8,6 +9,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] [.lead] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-telco[] Welcome to the official {product-title} {product-version} documentation, where you can learn about {product-title} and start exploring its features. @@ -229,6 +231,9 @@ Manage machines, provide services to users, and follow monitoring and logging re - **xref:../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities]**: As a cluster administrator, you can enable cluster capabilities that were disabled before installation. +include::modules/manage-cluster-components.adoc[leveloffset=+2] + +[id="architecture-manage-cluster-components_{context}"] === Manage cluster components - **Manage machines**: Manage xref:../machine_management/index.adoc#machine-mgmt-intro-managing-compute_overview-of-machine-management[compute] and xref:../machine_management/index.adoc#machine-mgmt-intro-managing-control-plane_overview-of-machine-management[control plane] machines in your cluster with machine sets, by xref:../machine_management/deploying-machine-health-checks.adoc#deploying-machine-health-checks[deploying health checks], and xref:../machine_management/applying-autoscaling.adoc#applying-autoscaling[applying autoscaling]. diff --git a/rosa_architecture/learn_more_about_openshift.adoc b/rosa_architecture/learn_more_about_openshift.adoc index ab9a86b20262..2a0b2f44cf0f 100644 --- a/rosa_architecture/learn_more_about_openshift.adoc +++ b/rosa_architecture/learn_more_about_openshift.adoc @@ -1,11 +1,13 @@ :_mod-docs-content-type: ASSEMBLY [id="learn_more_about_openshift"] = Learn more about {product-title} + include::_attributes/common-attributes.adoc[] :context: welcome-personas toc::[] +[role="_abstract"] Use the following sections to find content to help you learn about and use {product-title}. [id="architect"] diff --git a/rosa_architecture/legal-notice.adoc b/rosa_architecture/legal-notice.adoc index efee3af4afc7..f3bbdf6d4f1c 100644 --- a/rosa_architecture/legal-notice.adoc +++ b/rosa_architecture/legal-notice.adoc @@ -1,9 +1,11 @@ :_mod-docs-content-type: ASSEMBLY [id="legal-notice"] = Legal notice + include::_attributes/common-attributes.adoc[] :context: legal-notice +[role="_abstract"] [.lead] Copyright © 2024 Red Hat, Inc. diff --git a/rosa_architecture/rosa-admission-plug-ins.adoc b/rosa_architecture/rosa-admission-plug-ins.adoc index 20877affd81c..d81b8ad342ed 100644 --- a/rosa_architecture/rosa-admission-plug-ins.adoc +++ b/rosa_architecture/rosa-admission-plug-ins.adoc @@ -1,12 +1,13 @@ :_mod-docs-content-type: ASSEMBLY [id="rosa-admission-plug-ins"] = Admission plugins + include::_attributes/common-attributes.adoc[] :context: admission-plug-ins toc::[] - +[role="_abstract"] Admission plugins are used to help regulate how {product-title} functions. // Concept modules @@ -29,7 +30,7 @@ endif::openshift-rosa,openshift-dedicated[] == Additional resources ifndef::openshift-rosa,openshift-dedicated[] -* xref: /networking/hardware_networks/configuring-sriov-operator.adoc#configuring-sriov-operator[Configuring the SR-IOV Network Operator] +* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#configuring-sriov-operator[Configuring the SR-IOV Network Operator] endif::openshift-rosa,openshift-dedicated[] * xref:../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations_dedicating_nodes-scheduler-taints-tolerations[Controlling pod placement using node taints] diff --git a/rosa_architecture/rosa-architecture-models.adoc b/rosa_architecture/rosa-architecture-models.adoc index 4f1a8d461340..fe37fa7ba2ac 100644 --- a/rosa_architecture/rosa-architecture-models.adoc +++ b/rosa_architecture/rosa-architecture-models.adoc @@ -1,12 +1,14 @@ :_mod-docs-content-type: ASSEMBLY [id="rosa-architecture-models"] = Architecture models + include::_attributes/attributes-openshift-dedicated.adoc[] include::_attributes/common-attributes.adoc[] :context: rosa-architecture-models toc::[] +[role="_abstract"] {product-title} has the following cluster topology: Hosted control plane (HCP) - The control plane is hosted in a Red{nbsp}Hat account and the worker nodes are deployed in the customer's AWS account. diff --git a/rosa_architecture/rosa-oidc-overview.adoc b/rosa_architecture/rosa-oidc-overview.adoc index fd6c1a7583d3..f8974006a4e9 100644 --- a/rosa_architecture/rosa-oidc-overview.adoc +++ b/rosa_architecture/rosa-oidc-overview.adoc @@ -1,11 +1,13 @@ :_mod-docs-content-type: ASSEMBLY [id="rosa-oidc-overview"] = OpenID Connect Overview + include::_attributes/attributes-openshift-dedicated.adoc[] :context: rosa-oidc-overview toc::[] +[role="_abstract"] OpenID Connect (OIDC) uses Security Token Service (STS) to allow clients to provide a web identity token to gain access to multiple services. When a client signs into a service using STS, the token is validated against the OIDC identity provider. The OIDC protocol uses a configuration URL that contains the necessary information to authenticate a client's identity. The protocol responds to the provider with the credentials needed for the provider to validate the client and sign them in. @@ -26,7 +28,7 @@ include::modules/rosa-sts-oidc-provider-command.adoc[leveloffset=+1] [id="additional-resources_rosa-oidc-config"] == Additional resources -* See xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-byo-odic-overview_rosa-sts-about-iam-resources[Creating an OpenID Connect Configuration] for the ROSA Classic instructions. +* xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-byo-odic-overview_rosa-sts-about-iam-resources[Creating an OpenID Connect Configuration] ifdef::openshift-rosa-hcp[] -* See xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-sts-byo-oidc_rosa-hcp-sts-creating-a-cluster-quickly[Creating an OpenID Connect Configuration] for the {hcp-title} instructions. +* xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-sts-byo-oidc_rosa-hcp-sts-creating-a-cluster-quickly[Creating an OpenID Connect Configuration] endif::openshift-rosa-hcp[] \ No newline at end of file diff --git a/rosa_architecture/rosa-sts-about-iam-resources.adoc b/rosa_architecture/rosa-sts-about-iam-resources.adoc index efaa818421d4..72756b9765a1 100644 --- a/rosa_architecture/rosa-sts-about-iam-resources.adoc +++ b/rosa_architecture/rosa-sts-about-iam-resources.adoc @@ -6,18 +6,21 @@ ifndef::openshift-rosa-hcp[] [id="rosa-sts-about-iam-resources"] = About IAM resources for STS clusters + include::_attributes/attributes-openshift-dedicated.adoc[] :context: rosa-sts-about-iam-resources endif::openshift-rosa-hcp[] ifdef::openshift-rosa-hcp[] [id="rosa-hcp-about-iam-resources"] = About IAM resources + include::_attributes/attributes-openshift-dedicated.adoc[] :context: rosa-sts-about-iam-resources endif::openshift-rosa-hcp[] toc::[] +[role="_abstract"] ifndef::openshift-rosa-hcp[] To deploy a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS), endif::openshift-rosa-hcp[] @@ -61,9 +64,7 @@ endif::openshift-rosa-hcp[] If you create ROSA clusters by using {cluster-manager-url}, you must have the following AWS IAM roles linked to your AWS account to create and manage the clusters. ifndef::openshift-rosa-hcp[] - For more information about linking your IAM roles to your AWS account, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-associating-account_rosa-sts-aws-prereqs[Associating your AWS account]. -// This section needs to remain hidden until the migration is completed -// For more information about linking your IAM roles to your AWS account, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-associating-account_rosa-sts-aws-prereqs[Associating your AWS account]. +* xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-associating-account_rosa-sts-aws-prereqs[Associating your AWS account] endif::openshift-rosa-hcp[] These AWS IAM roles are as follows: @@ -86,11 +87,11 @@ include::modules/rosa-sts-understanding-ocm-role.adoc[leveloffset=+2] include::modules/rosa-sts-ocm-role-creation.adoc[leveloffset=+2] +[role="_additional-resources"] +.Additional resources AWS IAM roles link to your AWS account to create and manage the clusters. ifndef::openshift-rosa-hcp[] -For more information about linking your IAM roles to your AWS account, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-associating-account_rosa-sts-aws-prereqs[Associating your AWS account]. -// This section needs to remain hidden until the migration is completed -// For more information about linking your IAM roles to your AWS account, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-associating-account_rosa-sts-aws-prereqs[Associating your AWS account]. +* xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-associating-account_rosa-sts-aws-prereqs[Associating your AWS account] endif::openshift-rosa-hcp[] [role="_additional-resources"] @@ -121,7 +122,7 @@ endif::openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources -* link:https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html[Permissions boundaries for IAM entities] (AWS documentation) +* link:https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html[AWS documentation about permissions boundaries for IAM entities] ifdef::openshift-rosa[] * xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-account-wide-sts-roles-and-policies_rosa-sts-creating-a-cluster-quickly[Creating the account-wide STS roles and policies] endif::openshift-rosa[] diff --git a/rosa_architecture/rosa-understanding.adoc b/rosa_architecture/rosa-understanding.adoc index 02d04f388419..946db885bd48 100644 --- a/rosa_architecture/rosa-understanding.adoc +++ b/rosa_architecture/rosa-understanding.adoc @@ -1,11 +1,13 @@ :_mod-docs-content-type: ASSEMBLY [id="rosa-understanding"] = Understanding ROSA + include::_attributes/attributes-openshift-dedicated.adoc[] :context: rosa-understanding toc::[] +[role="_abstract"] Learn about {product-title} (ROSA), interacting with ROSA by using {cluster-manager-first} and command-line interface (CLI) tools, consumption experience, and integration with Amazon Web Services (AWS) services. [id="rosa-understanding-about_{context}"] @@ -63,9 +65,4 @@ To get started with deploying your cluster, ensure your AWS account has met the * xref:../ocm/ocm-overview.adoc#ocm-overview[OpenShift Cluster Manager] //* xref ../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources] * xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Getting started with {product-title}] -* link:https://aws.amazon.com/rosa/pricing/[AWS pricing page] - - -// Remove these modules? -//include::modules/rosa-understanding.adoc[leveloffset=+1] -//include::modules/rosa-using-sts.adoc[leveloffset=+2] +* link:https://aws.amazon.com/rosa/pricing/[AWS pricing page] \ No newline at end of file diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-hcp-instance-types.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-hcp-instance-types.adoc index d62b811f68b4..51b7788a475b 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-hcp-instance-types.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-hcp-instance-types.adoc @@ -5,7 +5,9 @@ include::_attributes/attributes-openshift-dedicated.adoc[] = {hcp-title-first} instance types toc::[] -{hcp-title} offers the following worker node instance types and sizes: + +[role="_abstract"] +{hcp-title} offers the following worker node instance types and sizes. //TODO OSDOCS-11789: Confirm this [NOTE] diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc index d40d1c8083e8..c9d172afc6f5 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc @@ -6,6 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] +[role="_abstract"] include::modules/life-cycle-overview.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc index 4aa6e1e79a38..47809e8f4204 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc @@ -6,6 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] +[role="_abstract"] This documentation outlines the service definition for the {hcp-title-first} managed service. [id="rosa-hcp-sdpolicy-account-management_{context}"] diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-instance-types.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-instance-types.adoc index 9e8a9aa447c4..08c37a7ad0b9 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-instance-types.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-instance-types.adoc @@ -6,7 +6,8 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] -{product-title} offers the following worker node instance types and sizes: +[role="_abstract"] +{product-title} offers the following worker node instance types and sizes. include::modules/rosa-sdpolicy-am-aws-compute-types.adoc[leveloffset=+1] diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc index 5e21f80f2036..1e31d9769621 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc @@ -6,6 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] +[role="_abstract"] include::modules/life-cycle-overview.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.adoc index e4daba5af53c..e579b0ec3e0e 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-policy-process-security.adoc @@ -6,7 +6,8 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] -This document details the Red{nbsp}Hat, Amazon Web Services (AWS), and customer security responsibilities for the managed {product-title} (ROSA). +[role="_abstract"] +This document details the Red{nbsp}Hat, Amazon Web Services (AWS), and customer security responsibilities for the managed {product-title}. .Acronyms and terms diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.adoc index f08f03afd268..242b97a4027e 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.adoc @@ -6,6 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] +[role="_abstract"] This documentation outlines Red{nbsp}Hat, Amazon Web Services (AWS), and customer responsibilities for the {product-title} managed service. include::modules/rosa-policy-responsibilities.adoc[leveloffset=+1] diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-policy-understand-availability.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-policy-understand-availability.adoc index 725b5d702965..4df384c8f80f 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-policy-understand-availability.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-policy-understand-availability.adoc @@ -6,7 +6,8 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] -Availability and disaster avoidance are extremely important aspects of any application platform. Although {product-title} (ROSA) provides many protections against failures at several levels, customer-deployed applications must be appropriately configured for high availability. To account for outages that might occur with cloud providers, additional options are available such as deploying a cluster across multiple availability zones and maintaining multiple clusters with failover mechanisms. +[role="_abstract"] +Availability and disaster avoidance are extremely important aspects of any application platform. Although {product-title} provides many protections against failures at several levels, customer-deployed applications must be appropriately configured for high availability. To account for outages that might occur with cloud providers, additional options are available such as deploying a cluster across multiple availability zones and maintaining multiple clusters with failover mechanisms. include::modules/rosa-policy-failure-points.adoc[leveloffset=+1] diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc index c1ea7905b5ed..da0cefe6a86c 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc @@ -6,7 +6,8 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] -This documentation outlines the service definition for the {product-title} (ROSA) managed service. +[role="_abstract"] +This documentation outlines the service definition for the {product-title} managed service. [id="rosa-sdpolicy-account-management_{context}"] == Account management diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-sre-access.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-sre-access.adoc index 9948eb0dbf18..2066c0875cd3 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-sre-access.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-sre-access.adoc @@ -4,7 +4,8 @@ include::_attributes/attributes-openshift-dedicated.adoc[] [id="rosa-sre-access"] = SRE and service account access -Red{nbsp}Hat site reliability engineering (SRE) access to {product-title} (ROSA) clusters is outlined through identity and access management. +[role="_abstract"] +Red{nbsp}Hat site reliability engineering (SRE) access to {product-title} clusters is outlined through identity and access management. [id="rosa-policy-identity-access-management_{context}"] == Identity and access management