Skip to content

Commit f6f44c9

Browse files
committed
Text rework
1 parent 4710bf9 commit f6f44c9

10 files changed

+76
-49
lines changed
Loading
Loading
Loading
Loading
Loading

modules/rosa-sharing-vpc-cluster-creation.adoc

+13-13
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,25 @@
33
// * networking/rosa-shared-vpc-config.adoc
44
:_content-type: PROCEDURE
55
[id="rosa-sharing-vpc-cluster-creation_{context}"]
6-
= Creating your cluster in a shared VPC
7-
To create a cluster in a shared VPC, complete the following step.
6+
= Step Four - Cluster Creator: Creating your cluster in a shared VPC
7+
To create a cluster in a shared VPC, complete the following steps.
88

99
[NOTE]
1010
====
11-
Installing a cluster in a shared VPC is supported only for OpenShift 4.13.9 and later.
11+
Installing a cluster in a shared VPC is supported only for OpenShift 4.12.34 and later, 4.13.10 and later, and all future 4.y-streams.
1212
====
1313

14-
.Procedure
15-
* In a terminal, the *cluster-creating AWS account* user enters the following command to create the cluster in the shared VPC:
14+
image::372_OpenShift_on_AWS_persona_worflows_0923_4.png[]
15+
.Prerequisites
16+
17+
* You have the hosted zone ID from the *VPC Owner*.
18+
* You have the AWS region from the *VPC Owner*.
19+
* You have the subnet IDs from the *VPC Owner*.
1620
21+
.Procedure
22+
* In a terminal, enter the following command to create the shared VPC:
23+
+
1724
[source,terminal]
1825
----
1926
rosa create cluster --cluster-name <cluster_name> --sts --operator-roles-prefix <prefix> --oidc-config-id <oidc_config_id> --region us-east-1 --subnet-ids <subnet_ids> --private-hosted-zone-id <hosted_zone_ID> --shared-vpc-role-arn <vpc-role-arn> --base-domain <dns-domain>
20-
----
21-
22-
[IMPORTANT]
23-
====
24-
After you delete a shared-VPC cluster, three DNS records will not be removed from the private hosted zone. If you make any subsequent install attempts by using the same values, installation errors will occur.
25-
26-
This issue might also manifest when shared-VPC networking prerequisites are not correctly configured. See this article for more information link:https://access.redhat.com/articles/7031016[on this limitation].
27-
====
27+
----

modules/rosa-sharing-vpc-creation-and-sharing.adoc

+9-8
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@
44

55
:_content-type: PROCEDURE
66
[id="rosa-sharing-vpc-creation-and-sharing_{context}"]
7-
= Configuring a VPC to share within your AWS organization
7+
= Step One - VPC Owner: Configuring a VPC to share within your AWS organization
88

99
You can share subnets within a configured VPC with another AWS user account if that account is within your current AWS organization.
1010

11+
image::372_OpenShift_on_AWS_persona_worflows_0923_1.png[]
1112
.Procedure
1213

13-
. From the AWS account that centrally manages your VPC, create or modify a VPC to your specifications in the link:https://us-east-1.console.aws.amazon.com/vpc/[VPC section of the AWS console]. This AWS account will be the *VPC-owning AWS account*.
14+
. Create or modify a VPC to your specifications in the link:https://us-east-1.console.aws.amazon.com/vpc/[VPC section of the AWS console].
1415
+
15-
. Create a custom policy file to allow for necessary Shared VPC permissions that uses the name `SharedVPCPolicy`:
16+
. Create a custom policy file to allow for necessary shared VPC permissions that uses the name `SharedVPCPolicy`:
1617
+
1718
[source,terminal]
1819
----
@@ -75,15 +76,15 @@ EOF
7576
----
7677
+
7778
--
78-
<1> The principal will be scoped down later in this process after the *cluster-creating AWS account* user has created the necessary cluster roles. On creation, you must create a root user placeholder by using the *cluster-creator's AWS Account* ID as `arn:aws:iam::{Account}:root`.
79+
<1> The principal will be scoped down after the *Cluster Creator* creates the necessary cluster roles. On creation, you must create a root user placeholder by using the *Cluster Creator's* AWS account ID as `arn:aws:iam::{Account}:root`.
7980
--
8081
+
8182
. Create the IAM role:
8283
+
8384
[source,terminal]
8485
----
8586
$ aws iam create-role --role-name <role_name> \ <1>
86-
--assume-role-policy-document file:///tmp/trust-policy.json
87+
--assume-role-policy-document file:///tmp/shared-vpc-role.json
8788
----
8889
+
8990
--
@@ -100,9 +101,9 @@ $ aws iam attach-role-policy --role-name <role_name> --policy-arn \ <1>
100101
+
101102
--
102103
<1> Replace _<role_name>_ with the name of the role you created.
103-
<2> Replace _<AWS_account_ID>_ with the *VPC-owning AWS account* ID.
104+
<2> Replace _<AWS_account_ID>_ with the *VPC Owner's* AWS account ID.
104105
--
105106
+
106-
. In the link:https://us-east-1.console.aws.amazon.com/ram/[Resource Access Manager of the AWS console], create a Resource Share that shares the previously created public and private subnets to the *cluster-creating AWS account* ID.
107+
. In the link:https://us-east-1.console.aws.amazon.com/ram/[Resource Access Manager of the AWS console], create a resource share that shares the previously created public and private subnets with the *Cluster Creator's* AWS account ID.
107108

108-
After you create the Resource Share, notify the *cluster-creating AWS account* user to reserve an `openshiftapps.com` DNS domain and create Operator roles to continue configuration.
109+
. After you create the resource share, provide the `SharedVPCRole` ARN to the *Cluster Creator* to continue configuration.

modules/rosa-sharing-vpc-dns-and-roles.adoc

+20-15
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,18 @@
33
// * networking/rosa-shared-vpc-config.adoc
44
:_content-type: PROCEDURE
55
[id="rosa-sharing-vpc-dns-and-roles_{context}"]
6-
= Creating your DNS and cluster creation roles
6+
= Step Two - Cluster Creator: Reserving your DNS and creating cluster operator roles
77

8-
After the *VPC-owning AWS account* user creates a virtual private cloud, subnets, and an IAM role for sharing the VPC resources, the *cluster-creating AWS account* user must reserve an `openshiftapps.com` DNS domain and create Operator roles to communicate back to the *VPC-owning AWS account*.
8+
After the *VPC Owner* creates a virtual private cloud, subnets, and an IAM role for sharing the VPC resources, reserve an `openshiftapps.com` DNS domain and create Operator roles to communicate back to the *VPC Owner*.
99

10+
image::372_OpenShift_on_AWS_persona_worflows_0923_2.png[]
1011
.Prerequisites
11-
12-
* You have the ARN for the IAM role that is used to share your VPC.
12+
13+
* You have the `SharedVPCRole` ARN for the IAM role from the *VPC Owner*.
1314
1415
.Procedure
1516

16-
. The cluster creator reserves an `openshiftapps.com` DNS domain with the following command:
17+
. Reserve an `openshiftapps.com` DNS domain with the following command:
1718
+
1819
[source,terminal]
1920
----
@@ -27,21 +28,24 @@ The command creates a reserved `openshiftapps.com` DNS domain.
2728
I: DNS domain '14eo.p1.openshiftapps.com' has been created.
2829
I: To view all DNS domains, run 'rosa list dns-domains'
2930
----
30-
. After creating the DNS domain, the *cluster-creating AWS account* user needs to create an OIDC configuration. Review this article for more information link:https://access.redhat.com/articles/7031018[on the ODIC configuration process]. The following command produces the OIDC config ID that you need:
31+
. Create an OIDC configuration.
32+
+
33+
Review this article for more information on the link:https://access.redhat.com/articles/7031018[OIDC configuration process]. The following command produces the OIDC configuration ID that you need:
3134
+
3235
[source,terminal]
3336
----
3437
$ rosa create oidc-config
3538
----
3639
+
37-
You receive confirmation that the command created an OIDC configuration.
40+
You receive confirmation that the command created an OIDC configuration:
3841
+
3942
[source,terminal]
4043
----
4144
I: To create Operator Roles for this OIDC Configuration, run the following command and remember to replace <user-defined> with a prefix of your choice:
4245
rosa create operator-roles --prefix <user-defined> --oidc-config-id 25tu67hq45rto1am3slpf5lq6jargg
4346
----
44-
. After the OIDC configuration is created, create the Operator roles by entering the following command:
47+
48+
. Create the Operator roles by entering the following command:
4549
+
4650
[source,terminal]
4751
----
@@ -53,8 +57,8 @@ $ rosa create operator-roles --oidc-config-id <oidc-config-ID> <1>
5357
+
5458
--
5559
<1> Provide the OIDC configuration ID that you created in the previous step.
56-
<2> Provide the cluster creator's installer ARN that was created as part of the `rosa create account-roles` process.
57-
<3> Provide the ARN for the role that the *VPC-owning AWS account* created.
60+
<2> Provide your installer ARN that was created as part of the `rosa create account-roles` process.
61+
<3> Provide the ARN for the role that the *VPC Owner* created.
5862
<4> Provide a prefix for the Operator roles.
5963
--
6064
+
@@ -63,10 +67,11 @@ $ rosa create operator-roles --oidc-config-id <oidc-config-ID> <1>
6367
The Installer account role and the shared VPC role must have a one-to-one relationship. If you want to create multiple shared VPC roles, you should create one set of account roles per shared VPC role.
6468
====
6569

66-
After you create the Operator roles, share the full domain name, which is created with `<intended_cluster_name>.<created_dns_domain>`, your _Ingress Operator Cloud Credentials_ and _Installer_ roles' ARN with the *VPC-owning AWS account* user.
67-
68-
This information resembles these examples:
69-
70+
. After you create the Operator roles, share the full domain name, which is created with `<intended_cluster_name>.<reserved_dns_domain>`, your _Ingress Operator Cloud Credentials_ role's ARN, and your _Installer_ role's ARN with the *VPC Owner* to continue configuration.
71+
+
72+
The shared information resembles these examples:
73+
+
7074
* ``my-rosa-cluster.14eo.p1.openshiftapps.com``
7175
* ``arn:aws:iam::111122223333:role/ManagedOpenShift-Installer-Role``
72-
* ``arn:aws:iam::111122223333:role/my-rosa-cluster-openshift-ingress-operator-cloud-credentials``
76+
* ``arn:aws:iam::111122223333:role/my-rosa-cluster-openshift-ingress-operator-cloud-credentials``
77+

modules/rosa-sharing-vpc-hosted-zones.adoc

+13-6
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,20 @@
33
// * networking/rosa-shared-vpc-config.adoc
44
:_content-type: PROCEDURE
55
[id="rosa-sharing-vpc-hosted-zones_{context}"]
6-
= Updating the shared VPC role and creating hosted zones
6+
= Step Three - VPC Owner: Updating the shared VPC role and creating hosted zones
77

8-
After the *cluster-creating AWS account* user provides the DNS domain and the IAM roles, *the VPC-owning AWS account* user must create a private hosted zone and update the trust policy on the IAM role that was created for sharing the VPC.
8+
After the *Cluster Creator* provides the DNS domain and the IAM roles, create a private hosted zone and update the trust policy on the IAM role that was created for sharing the VPC.
9+
10+
image::372_OpenShift_on_AWS_persona_worflows_0923_3.png[]
11+
.Prerequisites
12+
13+
* You have the full domain name from the *Cluster Creator*.
14+
* You have the _Ingress Operator Cloud Credentials_ role's ARN from the *Cluster Creator*.
15+
* You have the _Installer_ role's ARN from the *Cluster Creator*.
916
1017
.Procedure
1118

12-
. The *VPC-owning AWS account* user who owns the VPC must update the VPC sharing IAM role and add the _Installer_ and _Ingress Operator Cloud Credentials_ roles to the principal section of the trust policy.
19+
. Update the VPC sharing IAM role and add the _Installer_ and _Ingress Operator Cloud Credentials_ roles to the principal section of the trust policy.
1320
+
1421
[source,terminal]
1522
----
@@ -30,8 +37,8 @@ After the *cluster-creating AWS account* user provides the DNS domain and the IA
3037
]
3138
}
3239
----
33-
. After updating the trust policy, the *VPC-owning AWS account* user creates a private hosted zone in the link:https://us-east-1.console.aws.amazon.com/route53/v2/[Route 53 section of the AWS console]. In the hosted zone configuration, the domain name is `<cluster-name>.<dns_domain>`. The private hosted zone must be associated with the created VPC.
34-
. After the hosted zone is created and associated with the VPC, provide the following to the *cluster-creating AWS account* user:
40+
. Create a private hosted zone in the link:https://us-east-1.console.aws.amazon.com/route53/v2/[Route 53 section of the AWS console]. In the hosted zone configuration, the domain name is `<cluster-name>.openshiftapps.com`. The private hosted zone must be associated with the created VPC.
41+
. After the hosted zone is created and associated with the VPC, provide the following to the *Cluster Creator* to continue configuration:
3542
* Hosted zone ID
3643
* AWS region
37-
* Intended subnet IDs
44+
* Subnet IDs

rosa_install_access_delete_clusters/rosa-shared-vpc-config.adoc

+21-7
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,38 @@
11
include::_attributes/attributes-openshift-dedicated.adoc[]
22
[id="rosa-shared-vpc-config"]
3-
= Configuring a shared virtual private cloud for ROSA clusters
3+
= Configuring a shared VPC for ROSA clusters
44
:context: rosa-shared-vpc-config
55

66
toc::[]
77

8-
You can create {product-title} clusters in shared, centrally-managed AWS virtual private clouds (VPCs). This process requires two separate AWS accounts that belong to the same AWS organization. One account functions as the VPC owner while the other account creates the cluster in this VPC.
8+
You can create {product-title}
9+
ifdef::openshift-rosa[]
10+
(ROSA)
11+
endif::openshift-rosa[]
12+
clusters in shared, centrally-managed AWS virtual private clouds (VPCs).
913

10-
.Prerequisites
11-
* You installed the ROSA CLI (`rosa`) 1.2.26 or later.
12-
* You created all of the required ROSA account roles for creating a cluster.
14+
[NOTE]
15+
====
16+
This process requires *two separate* AWS accounts that belong to the same AWS organization. One account functions as the VPC-owning AWS account (*VPC Owner*), while the other account creates the cluster in the cluster-creating AWS account (*Cluster Creator*).
17+
====
18+
19+
image::372_OpenShift_on_AWS_persona_worflows_0923_all.png[]
20+
.Prerequisites for the *VPC Owner*
1321
* You have an AWS account with the proper permissions to create roles and share resources.
14-
* You are using an AWS account to create your cluster ("*cluster-creating AWS account*") that is separate from the AWS account that creates your VPC ("*VPC-owning AWS account*").
22+
* The *Cluster Creator's* AWS account is separate from the *VPC Owner's* AWS account.
1523
* Both AWS accounts belong to the same AWS organization.
1624
* You enabled resource sharing from the management account for your organization.
1725
* You have access to the link:https://signin.aws.amazon.com[AWS console].
1826

27+
.Prerequisites for the *Cluster Creator*
28+
* You installed the link:https://console.redhat.com/openshift/downloads#tool-rosa[ROSA CLI (`rosa`)] 1.2.26 or later.
29+
* You created all of the required xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-account-wide-sts-roles-and-policies_rosa-sts-creating-a-cluster-quickly[ROSA account roles] for creating a cluster.
30+
* The *Cluster Creator's* AWS account is separate from the *VPC Owner's* AWS account.
31+
* Both AWS accounts belong to the same AWS organization.
32+
1933
[NOTE]
2034
====
21-
Installing a cluster in a shared VPC is supported only for OpenShift 4.13.9 and later.
35+
Installing a cluster in a shared VPC is supported only for OpenShift 4.12.34 and later, 4.13.10 and later, and all future 4.y-streams.
2236
====
2337

2438
include::modules/rosa-sharing-vpc-creation-and-sharing.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)