Skip to content

Commit 46bd41a

Browse files
authored
Merge pull request #43730 from bmcelvee/OSDOCS-2463
OSDOCS-2463: Update ROSA introduction
2 parents cb172bc + a96bf52 commit 46bd41a

File tree

2 files changed

+77
-11
lines changed

2 files changed

+77
-11
lines changed

rosa_architecture/rosa-understanding.adoc

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,63 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: rosa-understanding
66
toc::[]
77

8-
Learn about {product-title} (ROSA) access, supported consoles, consumption experience, and integration with Amazon Web Services (AWS) services.
8+
Learn about {product-title} (ROSA), interacting with ROSA using {cluster-manager-first} and command-line interface (CLI) tools, consumption experience, and integration with Amazon Web Services (AWS) services.
99

10-
include::modules/rosa-understanding.adoc[leveloffset=+1]
11-
include::modules/rosa-using-sts.adoc[leveloffset=+2]
10+
[id="rosa-understanding-about_{context}"]
11+
== About ROSA
12+
13+
ROSA is a fully-managed, turnkey application platform that allows you to focus on delivering value to your customers by building and deploying applications. Red Hat and AWS Site reliability engineering (SRE) experts manage the underlying platform so you do not have to worry about the complexity of infrastructure management. ROSA provides seamless integration with a wide range of AWS compute, database, analytics, machine learning, networking, mobile, and other services to further accelerate the building and delivering of differentiating experiences to your customers.
14+
15+
You subscribe to the service directly from your AWS account. After the clusters are created, you can operate your clusters with the OpenShift web console or through {cluster-manager-first}. The ROSA service also uses OpenShift APIs and command-line interface (CLI) tools. These tools provide a standardized OpenShift experience to use your existing skills and tools knowledge.
16+
17+
You receive OpenShift updates with new feature releases and a shared, common source for alignment with OpenShift Container Platform. ROSA supports the same versions of OpenShift as Red Hat OpenShift Dedicated and OpenShift Container Platform to achieve version consistency.
18+
19+
[id="rosa-understanding-credential-modes_{context}"]
20+
== Credential modes
21+
22+
There are two supported credential modes for ROSA clusters. One uses the AWS Secure Token Service (STS), which is recommended, and the other uses Identity Access Management (IAM) roles.
23+
24+
[id="rosa-understanding-aws-sts_{context}"]
25+
=== ROSA with STS
26+
27+
AWS STS is a global web service that provides short-term credentials for IAM or federated users. ROSA with STS is the recommended credential mode for ROSA clusters. You can use AWS STS with ROSA to allocate temporary, limited-privilege credentials for component-specific IAM roles. The service enables cluster components to make AWS API calls using secure cloud resource management practices.
28+
29+
You can use the `rosa` CLI to create the IAM role, policy, and identity provider resources that are required for ROSA clusters that use STS.
30+
31+
AWS STS aligns with principles of least privilege and secure practices in cloud service resource management. The `rosa` CLI manages the STS credentials that are assigned for unique tasks and takes action upon AWS resources as part of OpenShift functionality. One limitation of using STS is that roles must be created for each ROSA cluster.
32+
33+
A listing of the account-wide and per-cluster roles is provided in xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources for ROSA clusters that use STS].
34+
35+
[id="rosa-understanding-aws-without-sts_{context}"]
36+
=== ROSA without STS
37+
38+
This mode makes use of a pre-created IAM user with `AdministratorAccess` within the account that has proper permissions to create other roles and resources as needed. Using this account the service creates all the necessary resources that are needed for the cluster.
39+
40+
[id="rosa-understanding-billing-pricing_{context}"]
41+
== Billing and pricing
42+
43+
ROSA is billed directly to your AWS account. ROSA pricing can be consumption based, with annual commitments or three-year commitments for greater discounting. The total cost of ROSA consists of two components:
44+
45+
* ROSA service fees
46+
* AWS infrastructure fees
47+
48+
Visit the link:https://aws.amazon.com/rosa/pricing/[AWS pricing page] for more details.
49+
50+
[id="rosa-understanding-getting-started_{context}"]
51+
== Getting started
52+
53+
To get started with deploying your cluster, ensure your AWS account has met the prerequisites, you have a Red Hat account ready, and follow the procedures outlined in xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Getting started with {product-title}].
54+
55+
[discrete]
56+
[role="_additional-resources"]
57+
== Additional resources
58+
59+
* xref:../ocm/ocm-overview.adoc#ocm-overview[OpenShift Cluster Manager]
60+
* xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources for ROSA clusters that use STS]
61+
* xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Getting started with {product-title}]
62+
* link:https://aws.amazon.com/rosa/pricing/[AWS pricing page]
63+
64+
65+
// Remove these modules?
66+
//include::modules/rosa-understanding.adoc[leveloffset=+1]
67+
//include::modules/rosa-using-sts.adoc[leveloffset=+2]

welcome/index.adoc

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,21 @@ include::_attributes/common-attributes.adoc[]
55
:context: welcome-index
66

77
[.lead]
8+
ifndef::openshift-rosa[]
89
Welcome to the official {product-title} {product-version} documentation, where you can learn about {product-title} and start exploring its features.
10+
endif::openshift-rosa[]
11+
ifdef::openshift-rosa[]
12+
Welcome to the official {product-title} (ROSA) documentation, where you can learn about ROSA and start exploring its features.
13+
To learn about ROSA, interacting with ROSA using {cluster-manager-first} and command-line interface (CLI) tools, consumption experience, and integration with Amazon Web Services (AWS) services, start with xref:../rosa_architecture/rosa-understanding.adoc#rosa-understanding[the Introduction to ROSA documentation].
14+
endif::[]
15+
16+
ifdef::openshift-rosa[]
17+
To navigate the ROSA documentation, use the left navigation bar.
18+
19+
For documentation that is not ROSA-specific, see the link:https://docs.openshift.com/container-platform/latest/welcome/index.html[OpenShift Container Platform documentation].
20+
endif::[]
21+
22+
ifndef::openshift-rosa[]
923

1024
ifndef::openshift-rosa,openshift-dedicated,openshift-dpu[]
1125
To navigate the {product-title} {product-version} documentation, you can use one of the following methods:
@@ -14,12 +28,6 @@ To navigate the {product-title} {product-version} documentation, you can use one
1428
* Select the task that interests you from the contents of this Welcome page.
1529
endif::openshift-rosa,openshift-dedicated,openshift-dpu[]
1630
17-
ifdef::openshift-rosa[]
18-
To navigate the {product-title} (ROSA) documentation, use the left navigation bar.
19-
20-
For documentation that is not ROSA-specific, see the link:https://docs.openshift.com/container-platform/latest/welcome/index.html[OpenShift Container Platform documentation].
21-
endif::[]
22-
2331
ifdef::openshift-dpu[]
2432
To navigate the {product-title} data processing unit (DPU) documentation, use the left navigation bar.
2533

@@ -190,7 +198,7 @@ xref:../operators/operator_sdk/helm/osdk-helm-support.adoc#osdk-helm-support[Hel
190198
endif::[]
191199
endif::[]
192200
193-
ifdef::openshift-rosa,openshift-dedicated[]
201+
ifdef::openshift-dedicated[]
194202
== Developer activities
195203
Ultimately, {product-title} is a platform for developing and deploying containerized applications. As an application developer, {product-title} and OpenShift Container Platform documentation helps you:
196204

@@ -293,7 +301,7 @@ After configuring monitoring, use the web console to access xref:../monitoring/r
293301
- **xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring_about-remote-health-monitoring[Remote health monitoring]**: {product-title} collects anonymized aggregated information about your cluster. Using Telemetry and the Insights Operator, this data is received by Red Hat and used to improve {product-title}. You can view the xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring_showing-data-collected-by-remote-health-monitoring[data collected by remote health monitoring].
294302
endif::[]
295303

296-
ifdef::openshift-rosa,openshift-dedicated[]
304+
ifdef::openshift-dedicated[]
297305
== Cluster administrator activities
298306

299307
While cluster maintenance and host configuration is performed by the Red Hat Site Reliability Engineering (SRE) team, other ongoing tasks on your {product-title} {product-version} cluster can be performed by {product-title} cluster administrators. As an {product-title} cluster administrator, the documentation helps you:
@@ -303,3 +311,5 @@ While cluster maintenance and host configuration is performed by the Red Hat Sit
303311
- *Monitor clusters*: Learn to use the Web UI to access monitoring dashboards.
304312
- *Manage nodes*: Learn to manage nodes, including configuring machine pools and autoscaling.
305313
endif::[]
314+
315+
endif::openshift-rosa[]

0 commit comments

Comments
 (0)