Skip to content

Commit 52e9dae

Browse files
committed
OSDOCS-15140: Updated HCP Install guide for migration
1 parent 7ec3458 commit 52e9dae

9 files changed

+79
-64
lines changed

modules/rosa-getting-started-deleting-a-cluster.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="rosa-getting-started-deleting-a-cluster_{context}"]
8-
= Deleting a ROSA cluster and the AWS STS resources
8+
= Deleting a ROSA cluster and the AWS IAM STS resources
99

1010
ifeval::["{context}" == "rosa-getting-started"]
1111
:getting-started:
@@ -15,15 +15,15 @@ ifeval::["{context}" == "rosa-quickstart"]
1515
endif::[]
1616

1717
ifdef::openshift-rosa-hcp[]
18-
You can delete a ROSA cluster by using the {product-title} (ROSA) CLI, `rosa`. You can also use the ROSA CLI to delete the AWS Identity and Access Management (IAM) account-wide roles, the cluster-specific Operator roles, and the OpenID Connect (OIDC) provider. To delete the account-wide inline and Operator policies, you can use the AWS IAM Console.
18+
You can delete a ROSA cluster by using the ROSA CLI, `rosa`. You can also use the ROSA CLI to delete the AWS Identity and Access Management (IAM) account-wide roles, the cluster-specific Operator roles, and the OpenID Connect (OIDC) provider. To delete the account-wide and Operator policies, you can use the AWS IAM Console or the AWS CLI.
1919
endif::openshift-rosa-hcp[]
2020
ifndef::openshift-rosa-hcp[]
21-
You can delete a ROSA cluster that uses the AWS Security Token Service (STS) by using the {product-title} (ROSA) CLI, `rosa`. You can also use the ROSA CLI to delete the AWS Identity and Access Management (IAM) account-wide roles, the cluster-specific Operator roles, and the OpenID Connect (OIDC) provider. To delete the account-wide inline and Operator policies, you can use the AWS IAM Console.
21+
You can delete a ROSA cluster that uses the AWS Security Token Service (STS) by using the ROSA CLI, `rosa`. You can also use the ROSA CLI to delete the AWS Identity and Access Management (IAM) account-wide roles, the cluster-specific Operator roles, and the OpenID Connect (OIDC) provider. To delete the account-wide inline and Operator policies, you can use the AWS IAM Console or the AWS CLI.
2222
endif::openshift-rosa-hcp[]
2323

2424
[IMPORTANT]
2525
====
26-
Account-wide IAM roles and policies might be used by other ROSA clusters in the same AWS account. You must only remove the resources if they are not required by other clusters.
26+
Account-wide IAM roles and policies might be used by other ROSA clusters in the same AWS account. You must only remove the resources if they are **not** required by other clusters.
2727
====
2828

2929
ifdef::getting-started[]
@@ -45,10 +45,10 @@ $ rosa delete cluster --cluster=<cluster_name> --watch
4545
+
4646
[IMPORTANT]
4747
====
48-
You must wait for the cluster deletion to complete before you remove the IAM roles, policies, and OIDC provider. The account-wide roles are required to delete the resources created by the installer. The cluster-specific Operator roles are required to clean-up the resources created by the OpenShift Operators. The Operators use the OIDC provider to authenticate.
48+
You must wait for the cluster deletion to complete before you remove the IAM roles, policies, and OIDC provider. The account-wide roles are required to delete the resources created by the installer. The cluster-specific Operator roles are required to clean-up the resources created by the OpenShift Operators. The Operators use the OIDC provider to authenticate with AWS APIs.
4949
====
5050

51-
. Delete the OIDC provider that the cluster Operators use to authenticate:
51+
. After the cluster is deleted, delete the OIDC provider that the cluster Operators use to authenticate:
5252
+
5353
[source,terminal]
5454
----
@@ -73,27 +73,27 @@ $ rosa delete operator-roles -c <cluster_id> --mode auto <1>
7373
+
7474
[IMPORTANT]
7575
====
76-
Account-wide IAM roles and policies might be used by other ROSA clusters in the same AWS account. You must only remove the resources if they are not required by other clusters.
76+
Account-wide IAM roles and policies might be used by other ROSA clusters in the same AWS account. You must only remove the resources if they are **not** required by other clusters.
7777
====
7878
+
7979
[source,terminal]
8080
----
8181
$ rosa delete account-roles --prefix <prefix> --mode auto <1>
8282
----
83-
<1> You must include the `--<prefix>` argument. Replace `<prefix>` with the prefix of the account-wide roles to delete. If you did not specify a custom prefix when you created the account-wide roles, specify the default prefix, `ManagedOpenShift`.
83+
<1> You must include the `--<prefix>` argument. Replace `<prefix>` with the prefix of the account-wide roles to delete. If you did not specify a custom prefix when you created the account-wide roles, specify the default prefix, depending on how they were created, `HCP-ROSA` or `ManagedOpenShift`.
8484

8585
ifdef::openshift-rosa-hcp[]
86-
. Delete the account-wide inline and Operator IAM policies that you created for ROSA deployments:
86+
. Delete the account-wide and Operator IAM policies that you created for ROSA deployments:
8787
endif::openshift-rosa-hcp[]
8888
ifndef::openshift-rosa-hcp[]
89-
. Delete the account-wide inline and Operator IAM policies that you created for ROSA deployments that use STS:
89+
. Delete the account-wide and Operator IAM policies that you created for ROSA deployments that use STS:
9090
endif::openshift-rosa-hcp[]
9191
+
9292
.. Log in to the link:https://console.aws.amazon.com/iamv2/home#/home[AWS IAM Console].
9393
.. Navigate to *Access management* -> *Policies* and select the checkbox for one of the account-wide policies.
9494
.. With the policy selected, click on *Actions* -> *Delete* to open the delete policy dialog.
9595
.. Enter the policy name to confirm the deletion and select *Delete* to delete the policy.
96-
.. Repeat this step to delete each of the account-wide inline and Operator policies for the cluster.
96+
.. Repeat this step to delete each of the account-wide and Operator policies for the cluster.
9797

9898
ifeval::["{context}" == "rosa-getting-started"]
9999
:getting-started:

modules/rosa-hcp-create-network.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ ifeval::["{context}" == "rosa-hcp-egress-zero-install"]
1010
endif::[]
1111
:_mod-docs-content-type: PROCEDURE
1212
[id="rosa-hcp-create-network_{context}"]
13-
= Creating a Virtual Private Cloud using the ROSA CLI
13+
= Creating an AWS VPC using the ROSA CLI
1414

15-
The `rosa create network` command is available in v.1.2.48 or later of the ROSA command-line interface (CLI). The command uses AWS CloudFormation to create a VPC and the other networking components used to install a ROSA cluster. CloudFormation is a native AWS infrastructure-as-code tool and is compatible with the AWS CLI.
15+
The `rosa create network` command is available in v.1.2.48 or later of the ROSA command-line interface (CLI). The command uses AWS CloudFormation to create a VPC and associated networking components necessary to install a ROSA cluster. CloudFormation is a native AWS infrastructure-as-code tool and is compatible with the AWS CLI.
1616

17-
If you do not specify a template, CloudFormation uses a default template that creates the following parameters:
17+
If you do not specify a template, CloudFormation uses a default template that creates resources with the following parameters:
1818

1919
[cols="2a,3a",options="header"]
2020
|===

modules/rosa-hcp-vpc-manual.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ endif::[]
88

99
:_mod-docs-content-type: PREFERENCE
1010
[id="rosa-hcp-vpc-manual_{context}"]
11-
= Creating a Virtual Private Cloud manually
11+
= Creating an AWS Virtual Private Cloud manually
1212

13-
If you choose to manually create your Virtual Private Cloud (VPC) instead of using Terraform, go to link:https://us-east-1.console.aws.amazon.com/vpc/[the VPC page in the AWS console].
13+
If you choose to manually create your AWS Virtual Private Cloud (VPC) instead of using Terraform, go to link:https://us-east-1.console.aws.amazon.com/vpc/[the VPC page in the AWS console].
1414

1515
include::snippets/rosa-existing-vpc-requirements.adoc[leveloffset=+0]
1616

@@ -19,7 +19,7 @@ ifdef::rosa-egress-lockdown[]
1919
[id="rosa-hcp-vpc-subnet-tagging-manual_{context}"]
2020
== Tagging your subnets
2121

22-
Before you can use your VPC to create a {hcp-title} cluster, you must tag your VPC subnets. Automated service preflight checks verify that these resources are tagged correctly. The following table shows how to tag your resources:
22+
Before you can use your VPC to create a {rosa-short} cluster, you must tag your VPC subnets. Automated service preflight checks verify that these resources are tagged correctly. The following table shows how to tag your resources:
2323

2424
[cols="3a,8a,8a", options="header"]
2525
|===

modules/rosa-hcp-vpc-subnet-tagging.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[id="rosa-hcp-vpc-subnet-tagging_{context}"]
66
= Tagging your subnets
77

8-
Before you can use your VPC to create a {hcp-title} cluster, you must tag your VPC subnets. Automated service preflight checks verify that these resources are tagged correctly before you can use these resources. The following table shows how your resources should be tagged as the following:
8+
Before you can use your VPC to create a {rosa-short} cluster, you must tag your VPC subnets. Automated service preflight checks verify that these resources are tagged correctly before you can use these resources for a cluster. The following table shows how your resources should be tagged:
99

1010
[cols="3a,8a,8a", options="header"]
1111
|===
@@ -15,17 +15,17 @@ Before you can use your VPC to create a {hcp-title} cluster, you must tag your V
1515

1616
| Public subnet
1717
| `kubernetes.io/role/elb`
18-
| `1` or no value
18+
| `1` (or no value)
1919

2020
| Private subnet
2121
| `kubernetes.io/role/internal-elb`
22-
| `1` or no value
22+
| `1` (or no value)
2323

2424
|===
2525

2626
[NOTE]
2727
====
28-
You must tag at least one private subnet and, if applicable, and one public subnet.
28+
You must tag at least one private subnet and, if applicable, one public subnet.
2929
====
3030

3131
.Prerequisites

modules/rosa-sts-byo-oidc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[id="rosa-sts-byo-oidc_{context}"]
1212
= Creating an OpenID Connect configuration
1313

14-
When using a
14+
When creating a
1515
ifdef::openshift-rosa-hcp[]
1616
{rosa-short}
1717
endif::openshift-rosa-hcp[]

modules/rosa-sts-creating-account-wide-sts-roles-and-policies.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ifeval::["{context}" == "rosa-quickstart"]
1414
:quickstart:
1515
endif::[]
1616

17-
Before using the {cluster-manager-first} {hybrid-console-second} to create {product-title} (ROSA) clusters that use the AWS Security Token Service (STS), create the required account-wide STS roles and policies, including the Operator policies.
17+
Before using the {hybrid-console} to create {product-title} clusters that use the AWS Security Token Service (STS), create the required account-wide STS roles and policies, including the Operator policies.
1818

1919
ifdef::quick-install[]
2020
.Prerequisites
@@ -37,11 +37,19 @@ $ rosa list account-roles
3737
----
3838
endif::[]
3939

40-
. If they do not exist in your AWS account, create the required account-wide STS roles and policies:
40+
. If they do not exist in your AWS account, create the required account-wide AWS IAM STS roles and policies:
4141
+
42+
ifdef::openshift-rosa[]
4243
[source,terminal]
4344
----
4445
$ rosa create account-roles
4546
----
47+
endif::openshift-rosa[]
48+
ifdef::openshift-rosa-hcp[]
49+
[source,terminal]
50+
----
51+
$ rosa create account-roles --hosted-cp
52+
----
53+
endif::openshift-rosa-hcp[]
4654
+
4755
Select the default values at the prompts to quickly create the roles and policies.

modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
// Module included in the following assemblies:
22
//
3+
// * rosa_getting_started/rosa-quickstart-guide-ui.adoc
4+
// * rosa_hcp/terraform/rosa-hcp-creating-a-cluster-quickly-terraform.adoc
5+
// * rosa_hcp/rosa-hcp-quickstart-guide.adoc
36
// * rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc
7+
// * rosa_install_access_delete_clusters/terraform/rosa-classic-creating-a-cluster-quickly-terraform.adoc
48
// * rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc
5-
// * rosa_getting_started/rosa-quickstart-guide-ui.adoc
69

710
ifeval::["{context}" == "rosa-classic-creating-a-cluster-quickly-terraform"]
811
:tf-classic:
912
endif::[]
1013
ifeval::["{context}" == "rosa-hcp-creating-a-cluster-quickly-terraform"]
1114
:tf-hcp:
1215
endif::[]
13-
ifeval::["{context}" == "rosa-hcp-sts-creating-a-cluster-quickly"]
14-
:hcp-rosa:
15-
endif::[]
1616

1717
:_mod-docs-content-type: CONCEPT
1818
[id="rosa-sts-overview-of-the-default-cluster-specifications_{context}"]
@@ -48,9 +48,16 @@ ifdef::tf-classic,tf-hcp[]
4848
* Default IAM role prefix: `rosa-<6-digit-alphanumeric-string>`
4949
endif::tf-classic,tf-hcp[]
5050
ifndef::tf-classic,tf-hcp[]
51+
ifdef::openshift-rosa[]
5152
* Default IAM role prefix: `ManagedOpenShift`
53+
endif::openshift-rosa[]
54+
ifdef::openshift-rosa-hcp[]
55+
* Default IAM role prefix: `HCP-ROSA`
56+
endif::openshift-rosa-hcp[]
5257
endif::tf-classic,tf-hcp[]
58+
ifndef::openshift-rosa-hcp[]
5359
* No cluster admin role created
60+
endif::openshift-rosa-hcp[]
5461

5562
|Cluster settings
5663
|
@@ -70,29 +77,32 @@ ifdef::openshift-rosa-hcp[]
7077
* Default AWS region for installations using the ROSA CLI (`rosa`): Defined by your `aws` CLI configuration
7178
* Default EC2 IMDS endpoints (both v1 and v2) are enabled
7279
endif::openshift-rosa-hcp[]
73-
* Availability: Single zone for the data plane
7480
endif::tf-classic,tf-hcp[]
75-
ifndef::rosa-hcp,tf-hcp[]
81+
ifndef::openshift-rosa-hcp,tf-hcp[]
7682
* EC2 Instance Metadata Service (IMDS) is enabled and allows the use of IMDSv1 or IMDSv2 (token optional)
77-
endif::rosa-hcp,tf-hcp[]
83+
endif::openshift-rosa-hcp,tf-hcp[]
84+
* Availability: Single zone for the data plane
7885
* Monitoring for user-defined projects: Enabled
79-
ifndef::openshift-rosa-hcp,hcp-rosa[]
86+
ifdef::openshift-rosa-hcp[]
87+
* No cluster admin role created
88+
endif::openshift-rosa-hcp[]
89+
ifndef::openshift-rosa-hcp[]
8090
|Encryption
8191
|* Cloud storage is encrypted at rest
8292
* Additional etcd encryption is not enabled
8393
* The default AWS Key Management Service (KMS) key is used as the encryption key for persistent data
84-
endif::openshift-rosa-hcp,hcp-rosa[]
94+
endif::openshift-rosa-hcp[]
8595

86-
ifdef::openshift-rosa,openshift-rosa-hcp,tf-classic[]
96+
ifdef::openshift-rosa,tf-classic[]
8797
|Control plane node configuration
8898
|* Control plane node instance type: m5.2xlarge (8 vCPU, 32 GiB RAM)
8999
* Control plane node count: 3
90-
endif::openshift-rosa,openshift-rosa-hcp,tf-classic[]
91-
ifndef::openshift-rosa-hcp,hcp-rosa[]
100+
endif::openshift-rosa,tf-classic[]
101+
ifndef::openshift-rosa-hcp[]
92102
|Infrastructure node configuration
93103
|* Infrastructure node instance type: r5.xlarge (4 vCPU, 32 GiB RAM)
94104
* Infrastructure node count: 2
95-
endif::openshift-rosa-hcp,hcp-rosa[]
105+
endif::openshift-rosa-hcp[]
96106

97107
|Compute node machine pool
98108
|* Compute node instance type: m5.xlarge (4 vCPU 16, GiB RAM)
@@ -145,7 +155,7 @@ endif::openshift-rosa-hcp[]
145155
+
146156
[NOTE]
147157
====
148-
For installations that use {cluster-manager} on the {hybrid-console-second}, the `auto` mode requires an admin-privileged {cluster-manager} role.
158+
For installations that use {cluster-manager} on the {hybrid-console-second}, the `auto` mode requires an admin-privileged {cluster-manager} role (ocm-role).
149159
====
150160
ifdef::tf-classic,tf-hcp[]
151161
* Default Operator role prefix: `rosa-<6-digit-alphanumeric-string>`
@@ -175,7 +185,4 @@ endif::[]
175185
ifeval::["{context}" == "rosa-hcp-creating-a-cluster-quickly-terraform"]
176186
:!tf-hcp:
177187
endif::[]
178-
ifeval::["{context}" == "rosa-hcp-sts-creating-a-cluster-quickly"]
179-
:!hcp-rosa:
180-
endif::[]
181188

rosa_hcp/rosa-hcp-quickstart-guide.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,22 @@ include::modules/rosa-getting-started-install-configure-cli-tools.adoc[leveloffs
1919

2020
.Next steps
2121

22-
Before you can use the {cluster-manager} {hybrid-console-second} to deploy ROSA clusters, you must associate your AWS account with your Red{nbsp}Hat organization and create the required account-wide STS roles and policies.
22+
Before you can use the {hybrid-console} to deploy {rosa-short} clusters, you must associate your AWS account with your Red{nbsp}Hat organization and create the required account-wide AWS IAM STS roles and policies for ROSA.
2323

2424
include::modules/rosa-sts-creating-account-wide-sts-roles-and-policies.adoc[leveloffset=+1]
2525

2626
[id="rosa-hcp-quickstart-creating-vpc"]
27-
== Creating a Virtual Private Cloud for your {hcp-title} clusters
27+
== Creating a Virtual Private Cloud for your {rosa-short} clusters
2828

29-
You must have a Virtual Private Cloud (VPC) to create {hcp-title} cluster. You can use the following methods to create a VPC:
29+
You must have an AWS Virtual Private Cloud (VPC) to create a {rosa-short} cluster. You can use the following methods to create a VPC:
3030

3131
* Create a VPC using the ROSA CLI
3232
* Create a VPC by using a Terraform template
3333
* Manually create the VPC resources in the AWS console
3434

3535
[NOTE]
3636
====
37-
The Terraform instructions are for testing and demonstration purposes. Your own installation requires some modifications to the VPC for your own use. You should also ensure that when you use this Terraform script it is in the same region that you intend to install your cluster. In these examples, use `us-east-2`.
37+
The Terraform instructions are for testing and demonstration purposes. Your own installation requires some modifications to the VPC for your own use. You should also ensure that when you use this linked Terraform configuration, it is in the same region that you intend to install your cluster. In these examples, `us-east-2` is used.
3838
====
3939

4040
[discrete]

0 commit comments

Comments
 (0)