You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -25,35 +25,44 @@ If you have received a private offer for the product, make sure to proceed accor
25
25
== Prerequisites
26
26
27
27
* Make sure to log in to the Red{nbsp}Hat account that you plan to associate with the AWS account where you have activated {hcp-title} in previous steps.
28
-
* Only a single AWS account that will be used for service billing can be associated with a Red{nbsp}Hat account. Typically an organizational AWS account that has other AWS accounts, such as developer accounts, linked would be the one that is to be billed, rather than individual AWS end user accounts.
29
-
* Red{nbsp}Hat accounts belonging to the same Red{nbsp}Hat organization will be linked with the same AWS account. Therefore, you can manage who has access to creating {hcp-title} clusters on the Red{nbsp}Hat organization account level.
28
+
* The AWS account used for service billing can only be associated with a single Red{nbsp}Hat account. Typically an AWS payer account is the one that is used to subscribe to ROSA and used for account linking and billing.
29
+
* All team members belonging to the same Red{nbsp}Hat organization can use the linked AWS account for service billing while creating {hcp-title} clusters.
30
30
31
31
== Subscription enablement and AWS account setup
32
32
33
-
. Activate the {hcp-title} product at the AWS console page by clicking the *Get started* button:
33
+
. Activate the {hcp-title} product at the link:https://console.aws.amazon.com/rosa/home[AWS console page] by clicking the *Get started* button:
34
+
+
35
+
.Get started
34
36
+
35
37
image::rosa-get-started.png[]
36
38
+
37
39
If you have activated ROSA before but did not complete the process, you can click the button and complete the account linking as described in the following steps.
38
40
39
41
. Confirm that you want your contact information to be shared with Red{nbsp}Hat and enable the service:
40
42
+
43
+
.Enable ROSA
41
44
image::rosa-enable-2.png[]
42
45
+
43
46
* You will not be charged by enabling the service in this step. The connection is made for billing and metering that will take place only after you deploy your first cluster. This could take a few minutes.
44
47
+
45
48
. After the process is completed, you will see a confirmation:
46
49
+
50
+
.ROSA enablement confirmation
51
+
+
47
52
image::rosa-prereq-enable-3.png[]
48
53
+
49
-
. Other sections on this verification page show the status of additional prerequisites. In case any of these prerequisites are not met, a respective message is shown. Here is an example of insufficient quotas in the selected region:
54
+
. Other sections on this verification page show the status of additional prerequisites. In case any of these prerequisites are not met, a corresponding message is shown. Here is an example of insufficient quotas in the selected region:
55
+
+
56
+
.Service quotas
50
57
+
51
58
image::rosa-service-quota-4.png[]
52
59
53
60
.. Click the *Increase service quotas* button or use the *Learn more* link to get more information about the about how to manage service quotas. In the case of insufficient quotas, note that quotas are region-specific. You can use the region switcher in the upper right corner of the web console to re-run the quota check for any region you are interested in and then submit service quota increase requests as needed.
54
61
55
62
. If all the prerequisites are met, the page will look like this:
56
63
+
64
+
.Verify ROSA prerequisites
65
+
+
57
66
image::rosa-prereq-5.png[]
58
67
+
59
68
The ELB service-linked role is created for you automatically. You can click any of the small *Info* blue links to get contextual help and resources.
@@ -62,24 +71,39 @@ The ELB service-linked role is created for you automatically. You can click any
62
71
63
72
. Click the orange *Continue to Red{nbsp}Hat* button to proceed with account linking:
64
73
+
74
+
.Continue to Red{nbsp}Hat
75
+
+
65
76
image::rosa-continue-rh-6.png[]
66
77
67
78
. If you are not already logged in to your Red{nbsp}Hat account in your current browser's session, you will be asked to log in to your account:
68
79
+
80
+
[NOTE]
81
+
====
82
+
Your AWS account must be linked to a single Red{nbsp}Hat organization.
83
+
====
84
+
+
85
+
.Log in to your Red{nbsp}Hat account
86
+
+
69
87
image::rosa-login-rh-account-7.png[]
70
88
+
71
89
* You can also register for a new Red{nbsp}Hat account or reset your password on this page.
72
90
* Make sure to log in to the Red{nbsp}Hat account that you plan to associate with the AWS account where you have activated {hcp-title} in previous steps.
73
-
* Only a single AWS account that will be used for service billing can be associated with a Red{nbsp}Hat account. Typically an organizational AWS account that has other AWS accounts, such as developer accounts, linked would be the one that is to be billed, rather than individual AWS end user accounts.
74
-
* Red{nbsp}Hat accounts belonging to the same Red{nbsp}Hat organization will be linked with the same AWS account. Therefore, you can manage who has access to creating {hcp-title} clusters on the Red{nbsp}Hat organization account level.
91
+
* The AWS account used for service billing can only be associated with a single Red{nbsp}Hat account. Typically an AWS payer account is the one that is used to subscribe to ROSA and used for account linking and billing.
92
+
* All team members belonging to the same Red{nbsp}Hat organization can use the linked AWS account for service billing while creating {hcp-title} clusters.
75
93
76
94
. Complete the Red{nbsp}Hat account linking after reviewing the terms and conditions:
77
95
+
78
96
[NOTE]
79
97
====
80
-
This step is available only if the logged-in Red{nbsp}Hat account, or the Red{nbsp}Hat organization managing the Red{nbsp}Hat account, was not linked to an AWS account before.
98
+
This step is available only if the AWS account was not linked to any Red{nbsp}Hat account before.
99
+
100
+
This step is skipped if the AWS account is already linked to the user's logged in Red{nbsp}Hat account.
101
+
102
+
If the AWS account is linked to a different Red{nbsp}Hat account, an error will be displayed. See link:https://access.redhat.com/articles/7066995[Correcting Billing Account Information for HCP clusters] for troubleshooting.
81
103
====
82
104
+
105
+
.Complete your account connection
106
+
+
83
107
image::rosa-rh-account-connection-8.png[]
84
108
+
85
109
Both the Red{nbsp}Hat and AWS account numbers are shown on this screen.
@@ -88,93 +112,85 @@ Both the Red{nbsp}Hat and AWS account numbers are shown on this screen.
88
112
+
89
113
If this is the first time you are using the {hybrid-console}, you will be asked to agree with the general managed services terms and conditions before being able to create the first ROSA cluster:
90
114
+
115
+
.Terms and conditions
116
+
+
91
117
image::rosa-terms-conditions-9.png[]
92
118
+
93
-
Additional terms that need to be reviewed and accepted will be shown after clicking the *View Terms and Conditions* button:
119
+
Additional terms that need to be reviewed and accepted are shown after clicking the *View Terms and Conditions* button:
120
+
+
121
+
.Red{nbsp}Hat terms and conditions
94
122
+
95
123
image::rosa-terms-conditions-9-5.png[]
96
124
+
97
125
Submit your agreement once you have reviewed any additional terms when prompted at this time.
98
126
99
-
. The {hybrid-console-second} provides a confirmation that AWS prerequisites were completed and lists the first steps needed for cluster deployment:
100
-
+
101
-
image::rosa-cluster-create-10.png[]
102
-
103
-
. The following steps pertain to technical deployment of the cluster:
127
+
. The {hybrid-console-second} provides a confirmation that AWS account setup was completed and lists the prerequisites for cluster deployment:
104
128
+
105
-
image::rosa-deploy-11.png[]
129
+
.Complete ROSA prerequisites
106
130
+
107
-
* It is possible that these steps will be performed on a different machine than where the service enablement and account linking were completed.
108
-
* As mentioned previously, any Red{nbsp}Hat account belonging to the Red{nbsp}Hat organization that was linked with the AWS account that activated the ROSA service will have access to creating a cluster and will be able to select the billing AWS account that was linked under this Red{nbsp}Hat organization previously.
131
+
image::rosa-cluster-create-10.png[]
109
132
+
110
133
The last section of this page shows cluster deployment options, either using the `rosa` CLI or through the web console:
111
134
+
112
-
image::rosa-cli-ui-12.png[]
135
+
.Deploy the cluster and set up access
113
136
+
114
-
* The following steps describe cluster deployment using the `rosa` CLI.
115
-
* If you are interested in deployment using the web console only, you can skip to the _{hcp-title} cluster deployment using the web console_ section. However, note that the `rosa` CLI is required for certain tasks, such as creating the account roles. If you are deploying ROSA for the first time, follow this the CLI steps until running the `rosa whoami` command, before skipping to the web console deployment steps.
137
+
image::rosa-cli-ui-12.png[]
116
138
117
-
== {hcp-title} cluster deployment using the CLI
139
+
== Selecting the AWS billing account for {hcp-title} during cluster deployment using the CLI
118
140
119
-
. Click the *Download the ROSA CLI* button to download the ROSA command line interface (CLI) for your operating system and set it up as described in the xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[Help with ROSA CLI setup].
120
-
+
121
141
[IMPORTANT]
122
142
====
123
-
Make sure that you have the most recent AWS CLI installed. See link:https://aws.amazon.com/cli/[Instructions to install the AWS CLI] for more information.
143
+
Make sure that you have the most recent ROSA command line interface (CLI) and AWS CLI installed and have completed the ROSA prerequisites covered in the previous section. See xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[Help with ROSA CLI setup] and link:https://aws.amazon.com/cli/[Instructions to install the AWS CLI] for more information.
124
144
====
125
-
+
126
-
. After the previous steps are completed, you can verify that both CLI are available by running the `rosa version`. This command shows an update notification if you are using an older version and `aws –version` commands in your terminal.
127
145
128
-
. The prerequisite for creating a {hcp-title} cluster is to log in using the `rosa` cli by the personalized command with your unique token shown under step _2.1. To authenticate, run this command_ on the web console. Use the *copy* button for easy copy and pasting of the command with full token into your terminal:
129
-
+
130
-
image::rosa-token-13.png[]
146
+
. Initiate the cluster deployment using the `rosa create cluster` command. You can click the *copy* button on the link:https://console.redhat.com/openshift/create/rosa/getstarted[Set up Red{nbsp}Hat OpenShift Service on AWS (ROSA) console page] and paste the command in your terminal. This launches the cluster creation process in interactive mode:
131
147
+
132
-
Do not share your unique token.
133
-
134
-
. The final prerequisite before your first cluster deployment is making sure the necessary account-wide roles and policies are created. The `rosa` CLI can help with that by using the command shown under step _2.2. To create the necessary account-wide roles and policies quickly…_ on the web console. The alternative to that is manual creation of these roles and policies.
135
-
136
-
. After logging in, creating the account roles, and verifying your identity using the `rosa whoami` command, your terminal will look similar to this:
137
-
+
138
-
image::rosa-whoami-14.png[]
139
-
140
-
141
-
. Initiate the cluster deployment using the presented command. You can click the *copy* button again and paste the command in your terminal:
148
+
.Deploy the cluster and set up access
142
149
+
143
150
image::rosa-cli-15.png[]
144
151
145
152
. To use a custom AWS profile, one of the non-default profiles specified in your `~/.aws/credentials`, you can add the `–profile <profile_name>` selector to the rosa create cluster command so that the command looks like rosa create cluster `–profile stage`. If no AWS CLI profile is specified using this option, the default AWS CLI profile will determine the AWS infrastructure profile into which the cluster is deployed. The billing AWS profile is selected in one of the following steps.
146
153
147
-
. After entering a cluster name, you will be asked whether to use the hosted control plane. Select *yes*:
148
-
//At the time of creating this tutorial, the `rosa` CLI defaults to the “classic” control plane.
149
-
+
150
-
image::rosa-create-cli-16.png[]
151
-
152
154
. When deploying a {hcp-title} cluster, the billing AWS account needs to be specified:
153
155
+
156
+
.Specify the Billing Account
157
+
+
154
158
image::rosa-create-cli-billing-17.png[]
155
159
+
156
-
* Only AWS accounts that were linked to the Red{nbsp}Hat organization that is currently used will be shown.
157
-
* The specified AWS account will be charged for using the ROSA service, regardless of whether the infrastructure AWS account is linked to it in the same AWS organization.
158
-
* You can see an indicator of whether the ROSA contract is enabled for a given AWS billing account or not.
159
-
* To select an AWS account that does not have the contract enabled, refer to the first few steps in this tutorial to enable the contract and allow the service charging, which is required for a successful cluster deployment.
160
+
* Only AWS accounts that are linked to the user's logged in Red{nbsp}Hat account are shown.
161
+
* The specified AWS account is charged for using the ROSA service.
162
+
* An indicator shows if the ROSA contract is enabled or not enabled for a given AWS billing account.
163
+
** If you select an AWS billing account that shows the _Contract enabled_ label, on-demand consumption rates are charged only after the capacity of your pre-paid contract is consumed.
164
+
** AWS accounts without the _Contract enabled_ label are charged the applicable on-demand consumption rates.
160
165
161
-
. In the following steps, you will specify technical details of the cluster that is to be deployed:
162
-
+
163
-
image::rosa-cli-details-18.png[]
166
+
.Additional resources
164
167
165
-
* These steps are beyond the scope of this tutorial. See xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-quickly[Creating ROSA with HCP clusters using the default options] for more details about how to complete the {hcp-title} cluster deployment using the CLI.
168
+
* The detailed cluster deployment steps are beyond the scope of this tutorial. See xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-quickly[Creating {hcp-title} clusters using the default options] for more details about how to complete the {hcp-title} cluster deployment using the CLI.
166
169
167
-
== {hcp-title} cluster deployment using the web console
170
+
== Selecting the AWS billing account for {hcp-title} during cluster deployment using the web console
168
171
169
172
. A cluster can be created using the web console by selecting the second option in the bottom section of the introductory *Set up ROSA* page:
170
173
+
174
+
.Deploy with web interface
175
+
+
171
176
image::rosa-deploy-ui-19.png[]
177
+
+
178
+
[NOTE]
179
+
====
180
+
Complete the prerequisites before starting the web console deployment process.
181
+
182
+
The `rosa` CLI is required for certain tasks, such as creating the account roles. If you are deploying ROSA for the first time, follow this the CLI steps until running the `rosa whoami` command, before starting the web console deployment steps.
183
+
====
172
184
173
185
. The first step when creating a ROSA cluster using the web console is the control plane selection. Make sure the *Hosted* option is selected before clicking the *Next* button:
174
186
+
187
+
.Select hosted option
188
+
+
175
189
image::rosa-deploy-ui-hcp-20.png[]
176
190
177
-
. The next step *Accounts and roles* allows you specifying the infrastructure AWS account, into which the ROSA cluster will be deployed and where the resources will be consumed and managed:
191
+
. The next step *Accounts and roles* allows you specifying the infrastructure AWS account, into which the the ROSA cluster is deployed and where the resources are consumed and managed:
. The billing AWS account is selected in the immediately following section:
186
202
+
203
+
.AWS billing account
204
+
+
187
205
image::rosa-ui-billing-22.png[]
188
206
+
189
-
* Only AWS accounts that were linked to the Red{nbsp}Hat organization that is currently used will be shown.
190
-
* The specified AWS account will be charged for using the ROSA service, regardless of whether the infrastructure AWS account is linked to it in the same AWS organization.
191
-
* You can see an indicator whether the ROSA contract is enabled for a given AWS billing account or not.
192
-
* In case you would like to use an AWS account that does not have a contract enabled yet, you can either use the _Connect ROSA to a new AWS billing account_ to reach the ROSA AWS console page, where you can activate it after logging in using the respective AWS account by following steps described earlier in this tutorial, or ask the administrator of the AWS account to do that for you.
207
+
* Only AWS accounts that are linked to the user's logged in Red{nbsp}Hat account are shown.
208
+
* The specified AWS account is charged for using the ROSA service.
209
+
* An indicator shows if the ROSA contract is enabled or not enabled for a given AWS billing account.
210
+
** If you select an AWS billing account that shows the _Contract enabled_ label, on-demand consumption rates are charged only after the capacity of your pre-paid contract is consumed.
211
+
** AWS accounts without the _Contract enabled_ label are charged the applicable on-demand consumption rates.
193
212
194
213
The following steps past the billing AWS account selection are beyond the scope of this tutorial.
195
214
196
215
.Additional resources
197
216
198
-
* For information on using the CLI to create a cluster, see xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-cli_rosa-hcp-sts-creating-a-cluster-quickly[Creating a ROSA with HCP cluster using the CLI].
217
+
* For information on using the CLI to create a cluster, see xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-cli_rosa-hcp-sts-creating-a-cluster-quickly[Creating a {hcp-title} cluster using the CLI].
199
218
* See link:https://cloud.redhat.com/learning/learn:getting-started-red-hat-openshift-service-aws-rosa/resource/resources:how-deploy-cluster-red-hat-openshift-service-aws-using-console-ui[this learning path] for more details on how to complete ROSA cluster deployment using the web console.
0 commit comments