Skip to content

Commit f12bc8c

Browse files
authored
Merge pull request #107845 from EricPonvelle/OSDOCS-18374_OCM-role-changes
Updated OCM-role requirements throughout the ROSA docs
2 parents eceb210 + c68ec34 commit f12bc8c

33 files changed

Lines changed: 776 additions & 247 deletions

File tree

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-creating-cluster.adoc
4+
// * rosa_install_access_delete_clusters/rosa-aws-privatelink-creating-cluster.adoc
5+
// * rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc
6+
7+
:_mod-docs-content-type: REFERENCE
8+
[id="rosa-classic-prerequisites_{context}"]
9+
= {product-title} prerequisites
10+
11+
[role="_abstract"]
12+
Before you can create a {product-title} cluster, you must complete the following prerequisites. Use each link to find detailed instructions for completing that specific prerequisite:
13+
14+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/prepare_your_environment/index#rosa-sts-creating-account-wide-sts-roles-and-policies_prepare-role-resources[Create account-wide roles]
15+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/prepare_your_environment/index#rosa-sts-ocm-roles-and-permissions-iam-basic-role_prepare-role-resources[Create the ocm-role IAM role]
16+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/prepare_your_environment/index#rosa-sts-byo-oidc_prepare-role-resources[Create an OIDC configuration]
17+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html-single/prepare_your_environment/index#rosa-operator-config_prepare-role-resources[Create Operator roles]
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="rosa-hcp-creating-a-cluster-using-defaults-ocm_{context}"]
7+
= Create a cluster with the default options using {cluster-manager}
8+
9+
[role="_abstract"]
10+
When using {cluster-manager-first} on the {hybrid-console-url} to create a {product-title} cluster, you can select the default options to create the cluster quickly. You can also use the admin {cluster-manager} IAM role to enable automatic deployment of the cluster-specific Operator roles and the OpenID Connect (OIDC) provider.
11+
12+
.Procedure
13+
14+
. Navigate to {cluster-manager-url} and select *Create cluster*.
15+
16+
. On the *Create an OpenShift cluster* page, select *Create cluster* in the *{product-title} (ROSA)* row.
17+
18+
. Verify that your AWS account ID is listed in the *Associated AWS accounts* drop-down menu and that the installation program, support, worker, and control plane account role Amazon Resource Names (ARNs) are listed on the *Accounts and roles* page.
19+
+
20+
[NOTE]
21+
====
22+
If your AWS account ID is not listed, check that you have successfully associated your AWS account with your Red{nbsp}Hat organization. If your account role ARNs are not listed, check that the required account-wide STS roles exist in your AWS account.
23+
====
24+
25+
. Click *Next*.
26+
27+
. On the *Cluster details* page, provide a name for your cluster in the *Cluster name* field. Leave the default values in the remaining fields and click *Next*.
28+
+
29+
[NOTE]
30+
====
31+
Cluster creation generates a domain prefix as a subdomain for your provisioned cluster on `openshiftapps.com`. If the cluster name is less than or equal to 15 characters, that name is used for the domain prefix. If the cluster name is longer than 15 characters, the domain prefix is randomly generated as a 15-character string. To customize the subdomain, select the *Create custom domain prefix* checkbox, and enter your domain prefix name in the *Domain prefix* field.
32+
====
33+
. On the *Machine pools* page, select your created VPC and at least one of your private subnet IDs.
34+
35+
. On the *Network configuration* page, if your cluster is publicly available, provide your public subnet ID.
36+
37+
. To deploy a cluster quickly, leave the default options in the *Cluster settings*, *Networking*, *Cluster roles and policies*, and *Cluster updates* pages and click *Next* on each page.
38+
39+
. On the *Review your {product-title} cluster* page, review the summary of your selections and click *Create cluster* to start the installation.
40+
+
41+
. Optional: On the *Overview* tab, you can enable the delete protection feature by selecting *Enable*, which is located directly under *Delete Protection: Disabled*. This prevents your cluster from being deleted. To disable delete protection, select *Disable*.
42+
By default, clusters are created with the delete protection feature disabled.
43+
+
44+
45+
.Verification
46+
47+
. Go to the *Overview* page for your cluster.
48+
. Check the progress of the installation and view the installation logs.
49+
. Go to *Details* > *Status* and confirm that your cluster is listed as `Ready`.
50+
+
51+
[NOTE]
52+
====
53+
If the installation fails or the cluster *State* does not change to *Ready* after about 40 minutes, check the installation troubleshooting documentation for details. For more information, see _Troubleshooting installations_. For steps to contact Red{nbsp}Hat Support for assistance, see _Getting support for Red{nbsp}Hat OpenShift Service on AWS_.
54+
====
55+
56+
ifeval::["{context}" == "rosa-sts-creating-a-cluster-quickly"]
57+
:quick-install:
58+
endif::[]
59+
ifeval::["{context}" == "rosa-quickstart"]
60+
:quickstart:
61+
endif::[]

0 commit comments

Comments
 (0)