Skip to content

Commit 509ed43

Browse files
EricPonvelleEricPonvelle
authored
Merge pull request #101079 from EricPonvelle/OSDOCS-16524_ROSA-Architecture-DITA
OSDOCS-16524: Updated ROSA Architecture for DITA compliance
2 parents bd34069 + c4a45d1 commit 509ed43

30 files changed

+268
-679
lines changed

‎modules/rosa-architecture-topics.adoc‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="architect_{context}"]
6+
= Architect
7+
[options="header",cols="3*"]
8+
|===
9+
| Learn about {rosa-title} |Plan {rosa-title} deployment |Additional resources
10+
11+
|
12+
link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/architecture/architecture-overview#architecture-overview[Architecture overview]
13+
|
14+
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]
15+
|
16+
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]
17+
|
18+
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]
19+
20+
|
21+
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]
22+
23+
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]
24+
25+
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[Lifecycle updates]
26+
|
27+
28+
|
29+
link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/support/support-overview#support-overview[Getting support]
30+
31+
|
32+
|
33+
| link:https://red.ht/rosa-roadmap[ROSA roadmap]
34+
|===

‎modules/rosa-cluster-admin-topics.adoc‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="cluster-administrator_{context}"]
6+
= Cluster Administrator
7+
[options="header",cols="4*"]
8+
|===
9+
|Learn about {product-title} |Deploy {product-title} |Manage {product-title} |Additional resources
10+
//Row 1
11+
|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]
12+
|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}]
13+
|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/logging/about-logging[Logging]
14+
|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]
15+
//Row 2
16+
|link:https://learn.openshift.com/?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[OpenShift Interactive Learning Portal]
17+
|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/storage/index#storage-overview[Storage]
18+
|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/monitoring/index#about-monitoring[About {product-title} monitoring]
19+
20+
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]
21+
22+
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]
23+
24+
|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]
25+
26+
//Row 3
27+
|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]
28+
|link:https://red.ht/rosa-roadmap[{product-title} roadmap]
29+
|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]
30+
31+
32+
|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/upgrading/index#rosa-hcp-upgrading[Upgrading]
33+
|
34+
|
35+
36+
|===

‎modules/rosa-developer-topics.adoc‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="rosa-developer-topics_{context}"]
6+
= Developer
7+
8+
[options="header",cols="3*"]
9+
|===
10+
|Learn about application development in {product-title} |Deploy applications |Additional resources
11+
12+
|link:https://developers.redhat.com/[Red{nbsp}Hat Developers site]
13+
|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]
14+
|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/support/support-overview#support-overview[Getting support]
15+
16+
|link:https://developers.redhat.com/products/openshift-dev-spaces/overview[{openshift-dev-spaces-productname} (formerly Red{nbsp}Hat CodeReady Workspaces)]
17+
|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/operators/operators-overview#operators-overview[Operators overview]
18+
|link:https://red.ht/rosa-roadmap[{product-title} roadmap]
19+
|
20+
21+
|link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/images/overview-of-images#overview-of-images[Images]
22+
|
23+
24+
|
25+
|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]
26+
|
27+
28+
|===

‎modules/rosa-getting-started-learn.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="rosa-getting-started-learn_{context}"]
6+
= Getting started with {product-title}
7+
8+
Use the following sections to find content to help you learn about and use {product-title}.

‎modules/rosa-key-features.adoc‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="rosa-key-features_{context}"]
6+
= Key features of {product-title}
7+
8+
* *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.
9+
10+
* *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.
11+
* *Rapid provisioning time:* Provisioning time is approximately 10 minutes.
12+
* *Continued cluster operation during upgrades:* Customers can upgrade the control plane and machine pools separately, ensuring the cluster remains operational during the upgrade process.
13+
* *Native AWS service:* Access and use Red{nbsp}Hat OpenShift on-demand with a self-service onboarding experience through the AWS management console.
14+
* *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.
15+
* *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.
16+
* *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.
17+
* *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.
18+
* *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.
19+
* *Optimized clusters:* Choose from memory-optimized, compute-optimized, general purpose, or accelerated EC2 instance types with clusters to meet your needs.
20+
* *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.

‎modules/rosa-next-steps-cluster.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="rosa-next-steps-cluster_{context}"]
6+
= Before creating your first {product-title} cluster
7+
8+
For additional information about ROSA installation, see a quick introduction to the process in link:https://www.redhat.com/en/products/interactive-walkthrough/install-rosa[Installing {product-title} interactive walkthrough].

‎modules/rosa-policy-change-management.adoc‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,12 @@ Red{nbsp}Hat does not automatically upgrade your clusters. You can schedule to u
6767
Because the required permissions can change between y-stream releases, the AWS managed policies are automatically updated before an upgrade can be performed.
6868
====
6969

70+
ifndef::openshift-dedicated[]
71+
You can review the history of all cluster upgrade events in the {cluster-manager} web console.
72+
endif::openshift-dedicated[]
73+
ifdef::openshift-dedicated[]
7074
You can review the history of all cluster upgrade events in the {cluster-manager} web console. For more information about releases, see the link:https://access.redhat.com/support/policy/updates/openshift/dedicated[Life Cycle policy].
75+
endif::openshift-dedicated[]
7176

7277
[id="rosa-policy-resource-responsibilities_{context}"]
7378
== Service and Customer resource responsibilities
@@ -239,4 +244,4 @@ applications and data hosted on the AWS Cloud.
239244

240245
1. For more information on authentication flow for AWS STS, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/authentication_and_authorization/managing-cloud-provider-credentials#cco-short-term-creds-auth-flow-aws-diagram_cco-short-term-creds[Authentication flow for AWS STS].
241246

242-
2. For more information on pruning images, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/registry/registry-overview-1#pruning-images_registry-overview[Automatically Pruning Images].
247+
2. For more information on pruning images, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/registry/registry-overview-1#pruning-images_registry-overview[Automatically pruning Images].

‎modules/rosa-sdpolicy-account-manageme.adoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc
4+
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
5+
:_mod-docs-content-type: CONCEPT
6+
[id="rosa-sdpolicy-account-management_{context}"]
7+
= Account management
8+
9+
This section provides information about the service definition for {product-title} account management.

‎modules/rosa-sdpolicy-account-management.adoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc
4+
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
5+
:_mod-docs-content-type: CONCEPT
6+
[id="rosa-sdpolicy-account-management_{context}"]
7+
= Account management
8+
9+
This section provides information about the service definition for {product-title} account management.

‎modules/rosa-sdpolicy-am-cluster-self-service.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
21
// Module included in the following assemblies:
32
//
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc
44
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
55
:_mod-docs-content-type: CONCEPT
66
[id="rosa-sdpolicy-cluster-self-service_{context}"]

0 commit comments

Comments
 (0)