Skip to content

Commit e7302da

Browse files
committed
OSDOCS-15910: Pruning HCP Cluster Installation
1 parent fd294ca commit e7302da

File tree

58 files changed

+190
-380
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+190
-380
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -241,31 +241,6 @@ Topics:
241241
- Name: Setting up your environment
242242
File: rosa-sts-setting-up-environment
243243
---
244-
Name: Install ROSA with HCP clusters
245-
Dir: rosa_hcp
246-
Distros: openshift-rosa
247-
Topics:
248-
- Name: Creating ROSA with HCP clusters using the default options
249-
File: rosa-hcp-sts-creating-a-cluster-quickly
250-
- Name: Creating a ROSA cluster using Terraform
251-
Dir: terraform
252-
Distros: openshift-rosa
253-
Topics:
254-
- Name: Creating a default ROSA cluster using Terraform
255-
File: rosa-hcp-creating-a-cluster-quickly-terraform
256-
- Name: Creating ROSA with HCP clusters using a custom AWS KMS encryption key
257-
File: rosa-hcp-creating-cluster-with-aws-kms-key
258-
- Name: Creating a private cluster on ROSA with HCP
259-
File: rosa-hcp-aws-private-creating-cluster
260-
- Name: Creating ROSA with HCP clusters with egress zero
261-
File: rosa-hcp-egress-zero-install
262-
- Name: Creating a ROSA with HCP cluster that uses direct authentication with an external OIDC identity provider
263-
File: rosa-hcp-sts-creating-a-cluster-ext-auth
264-
- Name: Creating ROSA with HCP clusters without a CNI plugin
265-
File: rosa-hcp-cluster-no-cni
266-
- Name: Deleting a ROSA with HCP cluster
267-
File: rosa-hcp-deleting-cluster
268-
---
269244
Name: Install ROSA Classic clusters
270245
Dir: rosa_install_access_delete_clusters
271246
Distros: openshift-rosa

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ Topics:
178178
- Name: Planning resource usage in your cluster
179179
File: rosa-planning-environment
180180
---
181-
Name: Install ROSA clusters
181+
Name: Install clusters
182182
Dir: rosa_hcp
183183
Distros: openshift-rosa-hcp
184184
Topics:
@@ -397,8 +397,6 @@ Topics:
397397
# File: troubleshooting-installations
398398
- Name: Review your cluster notifications
399399
File: mos-tshoot-cluster-notifications
400-
# - Name: Troubleshooting ROSA installations
401-
# File: rosa-troubleshooting-installations
402400
- Name: Troubleshooting Red Hat OpenShift Service on AWS installations
403401
File: rosa-troubleshooting-installations-hcp
404402
- Name: Troubleshooting networking

cloud_experts_tutorials/cloud-experts-custom-dns-resolver.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,12 @@ This tutorial uses the open-source BIND DNS server (`named`) to demonstrate the
2020

2121
* ROSA CLI (`rosa`)
2222
* AWS CLI (`aws`)
23-
* A xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-vpc-manual_rosa-hcp-sts-creating-a-cluster-quickly[manually created AWS VPC]
23+
ifdef::openshift-rosa[]
24+
* A manually created AWS VPC
25+
endif::openshift-rosa[]
26+
ifdef::openshift-rosa-hcp[]
27+
* A xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-creating-vpc_rosa-hcp-sts-creating-a-cluster-quickly[manually created AWS VPC]
28+
endif::openshift-rosa-hcp[]
2429
* A DHCP option set configured to point to a custom DNS server and set as the default for your VPC
2530

2631
[id="cloud-experts-custom-dns-resolver-environment-setup"]

cloud_experts_tutorials/cloud-experts-rosa-hcp-activation-and-account-linking-tutorial.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,12 @@ image::rosa-create-cli-billing-17.png[]
165165

166166
.Additional resources
167167

168+
ifdef::openshift-rosa-hcp[]
168169
* 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 {product-title} clusters using the default options] for more details about how to complete the {product-title} cluster deployment using the CLI.
170+
endif::openshift-rosa-hcp[]
171+
ifdef::openshift-rosa[]
172+
* The detailed cluster deployment steps are beyond the scope of this tutorial.
173+
endif::openshift-rosa[]
169174

170175
== Selecting the AWS billing account for {product-title} during cluster deployment using the web console
171176

@@ -215,4 +220,4 @@ The following steps past the billing AWS account selection are beyond the scope
215220
.Additional resources
216221

217222
* 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 {product-title} cluster using the CLI].
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 cluster deployment using the web console.
223+
* 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 cluster deployment using the web console.

modules/creating-cluster-with-aws-kms-key.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="creating-cluster-with-aws-kms-key"]
7-
= Creating a ROSA cluster using a custom AWS KMS key
7+
= Creating a {product-title} cluster using a custom AWS KMS key
88

9-
You can create a {product-title} (ROSA) cluster with a customer-provided KMS key that is used to encrypt either node root volumes, the etcd database, or both. A different KMS key ARN can be provided for each option.
9+
You can create a {product-title} cluster with a customer-provided KMS key that is used to encrypt either node root volumes, the etcd database, or both. A different KMS key ARN can be provided for each option.
1010

1111
[NOTE]
1212
====
13-
{hcp-title} does not automatically configure the `default` storage class to encrypt persistent volumes with the customer-provided KMS key. This is something that can be configured in-cluster after installation.
13+
{product-title} does not automatically configure the `default` storage class to encrypt persistent volumes with the customer-provided KMS key. This is something that can be configured in-cluster after installation.
1414
====
1515

1616

modules/rosa-additional-principals-create.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="rosa-additional-principals-create_{context}"]
8-
= Adding additional principals while creating your {hcp-title} cluster
8+
= Adding additional principals while creating your {product-title} cluster
99

1010
Use the `--additional-allowed-principals` argument to permit access through other roles.
1111

modules/rosa-additional-principals-edit.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="rosa-additional-principals-edit_{context}"]
8-
= Adding additional principals to your existing {hcp-title} cluster
8+
= Adding additional principals to your existing {product-title} cluster
99

1010
You can add additional principals to your cluster by using the command-line interface (CLI).
1111

modules/rosa-additional-principals-overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="rosa-additional-principals-overview_{context}"]
7-
= Additional principals on your {hcp-title} cluster
7+
= Additional principals on your {product-title} cluster
88

99
You can allow AWS Identity and Access Management (IAM) roles as additional principals to connect to your cluster's private API server endpoint.
1010

11-
You can access your {hcp-title} cluster's API Server endpoint from either the public internet or the interface endpoint that was created within the VPC private subnets. By default, you can privately access your {hcp-title} API Server by using the `-kube-system-kube-controller-manager` Operator role. To be able to access ROSA with HCP API server from another account directly without using the primary account where cluster is installed, you must include cross-account IAM roles as additional principals. This feature allows you to simplify your network architecture and reduce data transfer costs by avoiding peering or attaching cross-account VPCs to cluster's VPC.
11+
You can access your {product-title} cluster's API Server endpoint from either the public internet or the interface endpoint that was created within the VPC private subnets. By default, you can privately access your {product-title} API Server by using the `-kube-system-kube-controller-manager` Operator role. To be able to access {product-title} API server from another account directly without using the primary account where cluster is installed, you must include cross-account IAM roles as additional principals. This feature allows you to simplify your network architecture and reduce data transfer costs by avoiding peering or attaching cross-account VPCs to cluster's VPC.
1212

1313
image::AWS_cross_account_access.png[Overview of AWS cross account access]
1414

1515
In this diagram, the cluster creating account is designated as Account A. This account designates that another account, Account B, should have access to the API server.
1616

1717
[NOTE]
1818
====
19-
After you have configured additional allowed principals, you must create the interface VPC endpoint in the VPC from where you want to access the cross-account {hcp-title} API server. Then, create a private hosted zone in Route53 to route calls made to cross-account {hcp-title} API server to pass through the created VPC endpoint.
19+
After you have configured additional allowed principals, you must create the interface VPC endpoint in the VPC from where you want to access the cross-account {product-title} API server. Then, create a private hosted zone in Route53 to route calls made to cross-account {product-title} API server to pass through the created VPC endpoint.
2020
====

modules/rosa-deleting-account-wide-iam-roles-and-policies.adoc

Lines changed: 4 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,11 @@ endif::[]
1515
[id="rosa-deleting-account-wide-iam-roles-and-policies_{context}"]
1616
= Deleting the account-wide IAM roles and policies
1717

18-
This section provides steps to delete the account-wide IAM roles and policies that you created for
19-
ifdef::sts[]
20-
{rosa-classic-short} with STS
21-
endif::sts[]
22-
ifdef::hcp[]
23-
{rosa-short}
24-
endif::hcp[]
25-
deployments, along with the account-wide Operator policies. You can delete the account-wide AWS Identity and Access Management (IAM) roles and policies only after deleting all of the
26-
ifdef::sts[]
27-
{rosa-classic-short} with AWS Security Token Services (STS)
28-
endif::sts[]
29-
ifdef::hcp[]
30-
{rosa-short}
31-
endif::hcp[]
32-
clusters that depend on them.
18+
This section provides steps to delete the account-wide IAM roles and policies that you created for {product-title} deployments, along with the account-wide Operator policies. You can delete the account-wide AWS Identity and Access Management (IAM) roles and policies only after deleting all of the {product-title} clusters that depend on them.
3319

3420
[IMPORTANT]
3521
====
36-
The account-wide IAM roles and policies might be used by other
37-
ifdef::sts[]
38-
{rosa-classic-short}
39-
endif::sts[]
40-
ifdef::hcp[]
41-
{rosa-short}
42-
endif::hcp[]
43-
clusters in the same AWS account. Only remove the roles if they are not required by other clusters.
22+
The account-wide IAM roles and policies might be used by other {product-title} clusters in the same AWS account. Only remove the roles if they are not required by other clusters.
4423
====
4524

4625
.Prerequisites
@@ -101,7 +80,7 @@ $ rosa delete account-roles --prefix <prefix> --delete-hosted-shared-vpc-policie
10180
+
10281
[IMPORTANT]
10382
====
104-
The account-wide IAM roles might be used by other ROSA clusters in the same AWS account. Only remove the roles if they are not required by other clusters.
83+
The account-wide IAM roles might be used by other {product-title} clusters in the same AWS account. Only remove the roles if they are not required by other clusters.
10584
====
10685
+
10786
ifdef::hcp[]
@@ -132,12 +111,5 @@ If you did not specify a custom prefix when you created the account-wide roles,
132111
+
133112
[IMPORTANT]
134113
====
135-
The account-wide and Operator IAM policies might be used by other
136-
ifdef::sts[]
137-
{rosa-classic-short}
138-
endif::sts[]
139-
ifdef::hcp[]
140-
{rosa-short}
141-
endif::hcp[]
142-
clusters in the same AWS account. Only remove the roles if they are not required by other clusters.
114+
The account-wide and Operator IAM policies might be used by other {product-title} clusters in the same AWS account. Only remove the roles if they are not required by other clusters.
143115
====

modules/rosa-deleting-sts-iam-resources-account-wide.adoc

Lines changed: 4 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -11,48 +11,13 @@ endif::[]
1111
[id="rosa-deleting-sts-resources-account-wide_{context}"]
1212
= Deleting the account-wide IAM resources
1313

14-
After you have deleted all
15-
ifndef::hcp[]
16-
{product-title} (ROSA) with AWS Security Token Services (STS)
17-
endif::hcp[]
18-
ifdef::hcp[]
19-
{rosa-short}
20-
endif::hcp[]
21-
clusters that depend on the account-wide AWS Identity and Access Management (IAM) resources, you can delete the account-wide resources.
14+
After you have deleted all {product-title} clusters that depend on the account-wide AWS Identity and Access Management (IAM) resources, you can delete the account-wide resources.
2215

23-
If you no longer need to install a
24-
ifndef::hcp[]
25-
{rosa-classic-short} with STS
26-
endif::hcp[]
27-
ifdef::hcp[]
28-
{rosa-short}
29-
endif::hcp[]
30-
cluster by using {cluster-manager-first}, you can also delete the {cluster-manager} and user IAM roles.
16+
If you no longer need to install a {product-title} cluster by using {cluster-manager-first}, you can also delete the {cluster-manager} and user IAM roles.
3117

3218
[IMPORTANT]
3319
====
34-
The account-wide IAM roles and policies might be used by other
35-
ifndef::hcp[]
36-
{rosa-classic-short}
37-
endif::hcp[]
38-
ifdef::hcp[]
39-
{rosa-short}
40-
endif::hcp[]
41-
clusters in the same AWS account. Only remove the resources if they are not required by other clusters.
20+
The account-wide IAM roles and policies might be used by other {product-title} clusters in the same AWS account. Only remove the resources if they are not required by other clusters.
4221
43-
The {cluster-manager} and user IAM roles are required if you want to install, manage, and delete other
44-
ifndef::hcp[]
45-
{rosa-classic-short}
46-
endif::hcp[]
47-
ifdef::hcp[]
48-
{rosa-short}
49-
endif::hcp[]
50-
clusters in the same AWS account by using {cluster-manager}. Only remove the roles if you no longer need to install
51-
ifndef::hcp[]
52-
{rosa-classic-short}
53-
endif::hcp[]
54-
ifdef::hcp[]
55-
{rosa-short}
56-
endif::hcp[]
57-
clusters in your account by using {cluster-manager}. For more information about repairing your cluster if these roles are removed before deletion, see "Repairing a cluster that cannot be deleted" in _Troubleshooting cluster deployments_.
22+
The {cluster-manager} and user IAM roles are required if you want to install, manage, and delete other {product-title} clusters in the same AWS account by using {cluster-manager}. Only remove the roles if you no longer need to install {product-title} clusters in your account by using {cluster-manager}. For more information about repairing your cluster if these roles are removed before deletion, see "Repairing a cluster that cannot be deleted" in _Troubleshooting cluster deployments_.
5823
====

0 commit comments

Comments
 (0)