Skip to content

Commit 4e9a715

Browse files
authored
Merge pull request #96760 from EricPonvelle/HCP-Prereq-Fix
Repaired a misconfigured link for HCP
2 parents 306eb9f + d831098 commit 4e9a715

File tree

34 files changed

+388
-53
lines changed

34 files changed

+388
-53
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,16 @@ Topics:
233233
- Name: Prerequisites checklist for deploying ROSA using STS
234234
File: rosa-cloud-expert-prereq-checklist
235235
- Name: Detailed requirements for deploying ROSA using STS
236-
File: rosa-sts-aws-prereqs
237-
- Name: ROSA IAM role resources
236+
File: rosa-classic-aws-prereqs
237+
- Name: Detailed requirements for deploying ROSA with HCP
238+
File: rosa-hcp-aws-prereqs
239+
# Hiding this entry until the HCP migration is completed
240+
# - Name: Detailed requirements for deploying ROSA using STS
241+
# File: rosa-sts-aws-prereqs
242+
- Name: ROSA Classic IAM role resources
238243
File: rosa-sts-ocm-role
244+
- Name: ROSA with HCP IAM roles and resources
245+
File: rosa-hcp-prepare-iam-roles-resources
239246
##### NOTE: THE BELOW IS REMOVED AS PART OF OSDOCS-13310
240247
# - Name: Limits and scalability
241248
# File: rosa-limits-scalability

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,10 @@ Topics:
164164
- Name: Prerequisites checklist for deploying ROSA with HCP
165165
File: rosa-cloud-expert-prereq-checklist
166166
- Name: Detailed requirements for deploying ROSA with HCP
167-
File: rosa-sts-aws-prereqs
167+
File: rosa-hcp-aws-prereqs
168+
# Hiding this entry until the HCP migration is completed
169+
# - Name: Detailed requirements for deploying ROSA with HCP
170+
# File: rosa-sts-aws-prereqs
168171
- Name: Required IAM roles and resources
169172
File: rosa-hcp-prepare-iam-roles-resources
170173
##### NOTE: THE BELOW IS REMOVED AS PART OF OSDOCS-13310

cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-detailed-cli-guide.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,9 @@ The default settings are as follows:
142142
** 2 infrastructure nodes
143143
** 2 worker nodes
144144
** No autoscaling
145-
** See the documentation on xref:../../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-ec2-instances_rosa-sts-aws-prereqs[ec2 instances] for more details.
145+
** See the documentation on xref:../../../rosa_planning/rosa-classic-aws-prereqs.adoc#rosa-ec2-instances_rosa-classic-aws-prereqs[ec2 instances] for more details.
146+
// This link needs to remain hidden until the HCP migration is published
147+
// ** See the documentation on xref:../../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-ec2-instances_rosa-sts-aws-prereqs[ec2 instances] for more details.
146148
* Region: As configured for the `aws` CLI
147149
* Networking IP ranges:
148150
** Machine CIDR: 10.0.0.0/16

cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-hcp.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,9 @@ echo "export PRIVATE_SUBNET_ID=$PRIVATE_SUBNET_ID"
152152
+
153153
[role="_additional-resources"]
154154
.Additional resources
155-
* For more about VPC requirements, see the xref:../../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-vpc_rosa-sts-aws-prereqs[VPC documentation].
155+
* For more about VPC requirements, see the xref:../../../rosa_planning/rosa-classic-aws-prereqs.adoc#rosa-vpc_rosa-classic-aws-prereqs[VPC documentation].
156+
// This link needs to remain hidden until the HCP migration is published
157+
// * For more about VPC requirements, see the xref:../../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-vpc_rosa-sts-aws-prereqs[VPC documentation].
156158

157159
. The script outputs commands. Set the commands as environment variables to store the subnet IDs for later use. Copy and run the commands:
158160
+

cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-what-is-rosa.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,9 @@ etcd encryption is configured the same as in OpenShift Container Platform. The a
134134
Currently, the ROSA CLI does not accept multi-region KMS keys for EBS encryption. This feature is in our backlog for product updates. The ROSA CLI accepts single region KMS keys for EBS encryption if it is defined at cluster creation.
135135

136136
== Infrastructure
137-
ROSA uses several different cloud services such as virtual machines, storage, and load balancers. You can see a defined list in the xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-aws-policy-provisioned_rosa-sts-aws-prereqs[AWS prerequisites].
137+
ROSA uses several different cloud services such as virtual machines, storage, and load balancers. You can see a defined list in the xref:../../rosa_planning/rosa-classic-aws-prereqs.adoc#rosa-aws-policy-provisioned_rosa-classic-aws-prereqs[AWS prerequisites].
138+
// This section needs to remain hidden until the HCP migration is published
139+
// ROSA uses several different cloud services such as virtual machines, storage, and load balancers. You can see a defined list in the xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-aws-policy-provisioned_rosa-sts-aws-prereqs[AWS prerequisites].
138140

139141
== Credential methods
140142
There are two credential methods to grant Red{nbsp}Hat the permissions needed to perform the required actions in your AWS account: AWS with STS or an IAM user with admin permissions. AWS with STS is the preferred method, and the IAM user method will eventually be deprecated. AWS with STS better aligns with the principles of least privilege and secure practices in cloud service resource management.

cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-rosa-sts-explained.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ STS roles and policies must be created for each ROSA cluster. To make this easie
6161

6262
[id="components-specific-to-rosa-with-sts"]
6363
== Components specific to ROSA with STS
64-
* *AWS infrastructure* - This provides the infrastructure required for the cluster. It contains the actual EC2 instances, storage, and networking components. See xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-aws-compute-types_rosa-service-definition[AWS compute types] to see supported instance types for compute nodes and xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-ec2-instances_rosa-sts-aws-prereqs[provisioned AWS infrastructure] for control plane and infrastructure node configuration.
64+
* *AWS infrastructure* - This provides the infrastructure required for the cluster. It contains the actual EC2 instances, storage, and networking components. See xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-aws-compute-types_rosa-service-definition[AWS compute types] to see supported instance types for compute nodes and xref:../../rosa_planning/rosa-classic-aws-prereqs.adoc#rosa-ec2-instances_rosa-classic-aws-prereqs[provisioned AWS infrastructure] for control plane and infrastructure node configuration.
65+
// This section needs to remain hidden until the HCP migration is done
66+
// * *AWS infrastructure* - This provides the infrastructure required for the cluster. It contains the actual EC2 instances, storage, and networking components. See xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-aws-compute-types_rosa-service-definition[AWS compute types] to see supported instance types for compute nodes and xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-ec2-instances_rosa-sts-aws-prereqs[provisioned AWS infrastructure] for control plane and infrastructure node configuration.
6567
* *AWS STS* - See the credential method section above.
6668
* *OpenID Connect (OIDC)* - This provides a mechanism for cluster Operators to authenticate with AWS, assume the cluster roles through a trust policy, and obtain temporary credentials from STS to make the required API calls.
6769
* *Roles and policies* - The roles and policies are one of the main differences between ROSA with STS and ROSA with IAM Users. For ROSA with STS, the roles and policies used by ROSA are broken into account-wide roles and policies and Operator roles and policies.

modules/rosa-prereq-roles-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * rosa_planning/rosa-hcp-prepare-iam-roles-resources.adoc
44

55
:_mod-docs-content-type: MODULE
6-
[id="rosa-prereq-roles-overview"]
6+
[id="rosa-prereq-roles-overview_{context}"]
77
= Overview of required roles
88

99
To create and manage your

networking/network_security/network-verification.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ ifdef::openshift-dedicated[]
4141
* Egress is available to the required domain and port combinations that are specified in the xref:../../osd_planning/aws-ccs.adoc#osd-aws-privatelink-firewall-prerequisites_aws-ccs[AWS firewall prerequisites] section.
4242
endif::openshift-dedicated[]
4343
ifdef::openshift-rosa[]
44-
* Egress is available to the required domain and port combinations that are specified in the xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-classic-firewall-prerequisites_rosa-sts-aws-prereqs[AWS firewall prerequisites] section.
44+
* Egress is available to the required domain and port combinations that are specified in the xref:../../rosa_planning/rosa-classic-aws-prereqs.adoc#rosa-classic-firewall-prerequisites_rosa-classic-aws-prereqs[AWS firewall prerequisites] section.
45+
// This link needs to reamin hidden until the HCP migration is published
46+
// * Egress is available to the required domain and port combinations that are specified in the xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-classic-firewall-prerequisites_rosa-sts-aws-prereqs[AWS firewall prerequisites] section.
4547
endif::openshift-rosa[]
4648

4749
include::modules/automatic-network-verification-bypassing.adoc[leveloffset=+1]

networking/ovn_kubernetes_network_provider/configuring-cluster-wide-proxy.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ include::modules/cluster-wide-proxy-preqs.adoc[leveloffset=+1]
3333
.Additional resources
3434

3535
ifdef::openshift-rosa[]
36-
* For the installation prerequisites for ROSA clusters that use the AWS Security Token Service (STS), see xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prerequisites[AWS prerequisites for ROSA with STS].
36+
* For the installation prerequisites for ROSA clusters that use the AWS Security Token Service (STS), see xref:../../rosa_planning/rosa-classic-aws-prereqs.adoc#rosa-classic-aws-prerequisites[AWS prerequisites for ROSA with STS].
37+
// This section needs to remain hidden until the HCP migration is completed
38+
// * For the installation prerequisites for ROSA clusters that use the AWS Security Token Service (STS), see xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prerequisites[AWS prerequisites for ROSA with STS].
3739
* For the installation prerequisites for ROSA clusters that do not use STS, see xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc#prerequisites[AWS prerequisites for ROSA].
3840
endif::openshift-rosa[]
3941
ifdef::openshift-dedicated[]

rosa_architecture/cloud-experts-rosa-hcp-sts-explained.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ Security features for AWS STS include:
3737

3838
[id="components-specific-to-rosa-hcp-with-sts"]
3939
== Components of {hcp-title}
40-
* *AWS infrastructure* - The infrastructure required for the cluster including the Amazon EC2 instances, Amazon EBS storage, and networking components. See xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-sdpolicy-instance-types_rosa-hcp-service-definition[AWS compute types] to see the supported instance types for compute nodes and xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-ec2-instances_rosa-sts-aws-prereqs[provisioned AWS infrastructure] for more information on cloud resource configuration.
40+
* *AWS infrastructure* - The infrastructure required for the cluster including the Amazon EC2 instances, Amazon EBS storage, and networking components. See xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-sdpolicy-instance-types_rosa-hcp-service-definition[AWS compute types] to see the supported instance types for compute nodes and xref:../rosa_planning/rosa-hcp-aws-prereqs.adoc#rosa-ec2-instances_rosa-hcp-aws-prereqs[provisioned AWS infrastructure] for more information on cloud resource configuration.
41+
// This link remains hidden until the migration is completed
42+
//* *AWS infrastructure* - The infrastructure required for the cluster including the Amazon EC2 instances, Amazon EBS storage, and networking components. See xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-sdpolicy-instance-types_rosa-hcp-service-definition[AWS compute types] to see the supported instance types for compute nodes and xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-ec2-instances_rosa-sts-aws-prereqs[provisioned AWS infrastructure] for more information on cloud resource configuration.
4143
* *AWS STS* - A method for granting short-term, dynamic tokens to provide users the necessary permissions to temporarily interact with your AWS account resources.
4244
* *OpenID Connect (OIDC)* - A mechanism for cluster Operators to authenticate with AWS, assume the cluster roles through a trust policy, and obtain temporary credentials from AWS IAM STS to make the required API calls.
4345
* *Roles and policies* - The roles and policies used by {hcp-title} can be divided into account-wide roles and policies and Operator roles and policies.

0 commit comments

Comments
 (0)