Skip to content

Commit 0799efe

Browse files
authored
Merge pull request #59383 from EricPonvelle/ROSA-HCP_Renaming
ROSA-HCP: Renamed the product to ROSA with hosted control planes.
2 parents 487da97 + caa7c3c commit 0799efe

13 files changed

+70
-47
lines changed

_attributes/attributes-openshift-dedicated.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,5 @@
2929
:openshift-local-productname: Red Hat OpenShift Local
3030
:openshift-dev-spaces-productname: Red Hat OpenShift Dev Spaces
3131
:hcp: hosted control planes
32-
:hcp-first: Hosted control planes
32+
:hcp-title: ROSA with {hcp}
33+
:hcp-title-first: {product-title} (ROSA) with {hcp}

modules/rosa-hcp-byo-oidc-options.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You are required to register the unmanaged OIDC configuration by posting a reque
2020

2121
Allows you to provide raw files for the private RSA key. This key is named `rosa-private-key-oidc-<random_label_of_length_4>.key`. You also receive a discovery document, named `discovery-document-oidc-<random_label_of_length_4>.json`, and a JSON Web Key Set, named `jwks-oidc-<random_label_of_length_4>.json`.
2222

23-
You use these files to set up the endpoint. This endpoint responds to `/.well-known/openid-configuration` with the discovery document and on `keys.json` with the JSON Web Key Set. The private key is to be stored in Amazon Web Services (AWS) Secrets Manager Service (SMS) as plaintext.
23+
You use these files to set up the endpoint. This endpoint responds to `/.well-known/openid-configuration` with the discovery document and on `keys.json` with the JSON Web Key Set. The private key is stored in Amazon Web Services (AWS) Secrets Manager Service (SMS) as plaintext.
2424

2525
.Example
2626
[source,terminal]
@@ -34,7 +34,7 @@ $ rosa create oidc-config --raw-files
3434

3535
Allows you to specify the mode to create your OIDC configuration. With the `manual` option, you receive AWS commands that setup the OIDC configuration within an S3 bucket. This option stores the private key in the Secrets Manager. With the `manual` option, the OIDC Endpoint URL is the URL for the S3 bucket. You must retrieve the Secrets Manager ARN to register the OIDC configuration with OCM.
3636

37-
Using the `auto` option, like with manual mode, you receive the same OIDC configuration with AWS resources. One change is that ROSA calls AWS, so you do not need to do anything else. The OIDC Endpoint URL is the URL for the S3 bucket. The CLI retrieves the Secrets Manager ARN, registers the OIDC configuration with OCM, and reports a second ROSA command the user can run to continue with creation of STS cluster.
37+
Using the `auto` option, you receive the same OIDC configuration and AWS resources as the `manual` mode. One change is that ROSA calls AWS, so you do not need to do anything else. The OIDC Endpoint URL is the URL for the S3 bucket. The CLI retrieves the Secrets Manager ARN, registers the OIDC configuration with OCM, and reports a second ROSA command that the user can run to continue with creation of STS cluster.
3838

3939
.Example
4040
[source,terminal]

modules/rosa-hcp-byo-oidc.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
You can create your own OpenID Connect (OIDC) configuration before you create your cluster by using the `rosa create oidc-config --mode=auto` command. This command produces an OIDC configuration that is hosted under Red Hat's AWS account. The `rosa` CLI provides some additional options for creating your OIDC configuration.
1010

11-
You can generate managed or unmanaged OIDC configurations. Customer-hosted, or unmanaged, OIDC configurations are stored within your AWS account with the configurations also being flagged for use with {cluster-manager-first}. This process also provides you with a private key to have access to and take ownership of the configurations. Red-Hat hosted, or managed, OIDC configurations are stored within Red Hat's AWS account. This process provides you with private keys for accessing the configuration.
11+
You can generate managed or unmanaged OIDC configurations. Customer-hosted, or unmanaged, OIDC configurations are stored within your AWS account, and the configurations are flagged for use with {cluster-manager-first}. This process also provides you with a private key to have access to and take ownership of the configurations. Red Hat-hosted, or managed, OIDC configurations are stored within Red Hat's AWS account. This process provides you with private keys for accessing the configuration.
1212

1313
[NOTE]
1414
====
@@ -17,7 +17,7 @@ When using the `--managed` parameter, you can only create a new managed OIDC con
1717

1818
.Prerequisites
1919

20-
* You have completed the AWS prerequisites for {hcp} for ROSA.
20+
* You have completed the AWS prerequisites for {hcp-title}.
2121
* You have installed and configured the latest ROSA CLI (`rosa`) on your installation host.
2222
2323
.Procedure

modules/rosa-hcp-classic-comparison.adoc

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

55
:_content-type: CONCEPT
66
[id="rosa-hcp-classic-comparison_{context}"]
7-
= Comparing ROSA Classic and hosted control planes for ROSA
7+
= Comparing ROSA with hosted control planes and ROSA Classic
88

9-
{hcp-first} for {product-title} (ROSA) offers a different way to create a managed ROSA cluster. {hcp-first} for ROSA offers a reduced-cost solution with focuses on reliability and efficiency. With a focus on efficiency, you can quickly create a new cluster and deploy applications in minutes.
9+
{hcp-title-first} offers a different way to create a managed ROSA cluster. {hcp-title} offers a reduced-cost solution with focuses on reliability and efficiency. With a focus on efficiency, you can quickly create a new cluster and deploy applications in minutes.
1010

11-
{hcp-first} for ROSA requires only a minimum two nodes, making it ideal for smaller projects, while still being able to scale to support larger projects and enterprises.
11+
{hcp-title} requires only a minimum of two nodes making it ideal for smaller projects while still being able to scale to support larger projects and enterprises.
1212

1313
.ROSA architectures comparison table
1414

@@ -34,8 +34,8 @@
3434
* All-in-one {product-title} infrastructure architecture
3535

3636
| *Footprint*
37-
| 1 cluster requires a minimum of 2 nodes
38-
| 1 cluster requires minimum of 7 nodes
37+
| One cluster requires a minimum of two nodes
38+
| One cluster requires a minimum of seven nodes
3939

4040
| *Deployment*
4141
|

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66
[id="rosa-sts-creating-account-wide-sts-roles-and-policies_{context}"]
77
= Creating the account-wide STS roles and policies
88

9-
Before using the {cluster-manager-first} {hybrid-console-second} to create {hcp} for {product-title} (ROSA) clusters, create the required account-wide roles and policies, including the Operator policies.
9+
Before using the {cluster-manager-first} {hybrid-console-second} to create {hcp-title-first} clusters, create the required account-wide roles and policies, including the Operator policies.
1010

1111
.Prerequisites
1212

13-
* You have completed the AWS prerequisites for {hcp} for ROSA with STS.
13+
* You have completed the AWS prerequisites for {hcp-title}.
1414
* You have available AWS service quotas.
1515
* You have enabled the ROSA service in the AWS Console.
1616
* You have installed and configured the latest ROSA CLI (`rosa`) on your installation host.
1717
+
1818
[NOTE]
1919
====
20-
To successfully install {hcp} for ROSA clusters, use the latest version of the ROSA CLI (`rosa`).
20+
To successfully install {hcp-title} clusters, use the latest version of the ROSA CLI (`rosa`).
2121
====
2222
* You have logged in to your Red Hat account by using the `rosa` CLI.
2323

modules/rosa-hcp-sts-creating-a-cluster-cli.adoc

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

55
:_content-type: PROCEDURE
66
[id="rosa-hcp-sts-creating-a-cluster-cli_{context}"]
7-
= Creating a {hcp} for ROSA cluster using the CLI
7+
= Creating a {hcp-title} cluster using the CLI
88

99
When using {product-title} (ROSA) CLI (`rosa`) to create a cluster, you can select the default options to create the cluster quickly.
1010

1111
.Prerequisites
1212

13-
* You have completed the AWS prerequisites for {hcp} for ROSA.
13+
* You have completed the AWS prerequisites for {hcp-title}.
1414
* You have available AWS service quotas.
1515
* You have enabled the ROSA service in the AWS Console.
1616
* You have installed and configured the latest ROSA CLI (`rosa`) on your installation host.
@@ -32,7 +32,7 @@ To successfully install ROSA clusters, use the latest version of the ROSA CLI (`
3232
//REGION="<region>"
3333
//----
3434

35-
. You can create your {hcp} for ROSA cluster with one of the following commands.
35+
. You can create your {hcp-title} cluster with one of the following commands.
3636
+
3737
[NOTE]
3838
====

modules/rosa-hcp-vpc-manual.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ To manually create your Virtual Private Cloud (VPC), go to link:https://us-east-
1919
| CIDR range
2020
| Your VPC CIDR range should match your machine CIDR.
2121

22-
| Availability Zone
23-
| You need 1 Availability Zone for a single zone, and you need 3 for Availability Zones for multi-zone.
22+
| Availability zone
23+
| You need one availability zone for a single zone, and you need three for availability zones for multi-zone.
2424

2525
| Public subnet
2626
| You must have one public subnet with a NAT gateway.

modules/rosa-hcp-vpc-terraform.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="rosa-hcp-vpc-terraform_{context}"]
77
= Creating an AWS Virtual Private Cloud using Terraform
88

9-
Terraform is a tool that allows you to create various resources using an established template. The following process uses the default options as required to create a {hcp} for ROSA cluster. For more information about using Terraform, see the additional resources.
9+
Terraform is a tool that allows you to create various resources using an established template. The following process uses the default options as required to create a {hcp-title} cluster. For more information about using Terraform, see the additional resources.
1010

1111
.Prerequisites
1212

@@ -58,7 +58,7 @@ $ terraform plan -out rosa.plan [-var aws_region=<region>] [-var cluster_name=<c
5858
$ terraform apply rosa.plan
5959
----
6060

61-
. Optional: You can capture the values of the Terraform-provisioned private, public, and machinepool subnet IDs as environment variables to use when creating your {hcp} for ROSA cluster by running the following commands:
61+
. Optional: You can capture the values of the Terraform-provisioned private, public, and machinepool subnet IDs as environment variables to use when creating your {hcp-title} cluster by running the following commands:
6262
+
6363
** For the private subnet ID:
6464
+

modules/rosa-sts-associating-your-aws-account.adoc

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,22 @@ endif::[]
2222

2323
Before using the {cluster-manager-first} {hybrid-console-second} to create
2424
ifdef::rosa-hcp[]
25-
{hcp} for
25+
{hcp-title} clusters
2626
endif::rosa-hcp[]
27-
{product-title} (ROSA) clusters that use the AWS Security Token Service (STS), create an {cluster-manager} IAM role and link it to your Red Hat organization. Then, create a user IAM role and link it to your Red Hat user account in the same Red Hat organization.
27+
ifndef::rosa-hcp[]
28+
{product-title} (ROSA) clusters
29+
endif::rosa-hcp[]
30+
that use the AWS Security Token Service (STS), create an {cluster-manager} IAM role and link it to your Red Hat organization. Then, create a user IAM role and link it to your Red Hat user account in the same Red Hat organization.
2831

2932
ifdef::quick-install[]
3033
.Prerequisites
3134

32-
* You have completed the AWS prerequisites for
3335
ifdef::rosa-hcp[]
34-
{hcp} for
36+
* You have completed the AWS prerequisites for {hcp-title}.
37+
endif::rosa-hcp[]
38+
ifndef::rosa-hcp[]
39+
* You have completed the AWS prerequisites for ROSA with STS.
3540
endif::rosa-hcp[]
36-
ROSA with STS.
3741
* You have available AWS service quotas.
3842
* You have enabled the ROSA service in the AWS Console.
3943
* You have installed and configured the latest ROSA CLI (`rosa`) on your installation host.
@@ -42,9 +46,12 @@ ROSA with STS.
4246
====
4347
To successfully install
4448
ifdef::rosa-hcp[]
45-
{hcp} for
49+
{hcp-title}
50+
endif::rosa-hcp[]
51+
ifndef::rosa-hcp[]
52+
ROSA
4653
endif::rosa-hcp[]
47-
ROSA clusters, use the latest version of the ROSA CLI.
54+
clusters, use the latest version of the ROSA CLI.
4855
====
4956
* You have logged in to your Red Hat account by using the `rosa` CLI.
5057
* You have organization administrator privileges in your Red Hat organization.
@@ -58,22 +65,31 @@ endif::[]
5865
====
5966
To enable automatic deployment of the cluster-specific Operator roles and the OpenID Connect (OIDC) provider using the {cluster-manager} {hybrid-console-second}, you must apply the administrative privileges to the role by choosing the _Admin OCM role_ command in the *Accounts and roles* step of creating a
6067
ifdef::rosa-hcp[]
61-
{hcp} for
68+
{hcp-title}
6269
endif::rosa-hcp[]
63-
ROSA cluster. For more information about the basic and administrative privileges for the {cluster-manager} role, see _Understanding AWS account association_.
70+
ifndef::rosa-hcp[]
71+
ROSA
72+
endif::rosa-hcp[]
73+
cluster. For more information about the basic and administrative privileges for the {cluster-manager} role, see _Understanding AWS account association_.
6474
====
6575
+
6676
[NOTE]
6777
====
6878
If you choose the _Basic OCM role_ command in the *Accounts and roles* step of creating a
6979
ifdef::rosa-hcp[]
70-
{hcp} for
80+
{hcp-title}
81+
endif::rosa-hcp[]
82+
ifndef::rosa-hcp[]
83+
ROSA
7184
endif::rosa-hcp[]
72-
ROSA cluster in the {cluster-manager} {hybrid-console-second}, you must deploy a
85+
cluster in the {cluster-manager} {hybrid-console-second}, you must deploy a
7386
ifdef::rosa-hcp[]
74-
{hcp} for
87+
{hcp-title}
88+
endif::rosa-hcp[]
89+
ifndef::rosa-hcp[]
90+
ROSA
7591
endif::rosa-hcp[]
76-
ROSA cluster using manual mode. You will be prompted to configure the cluster-specific Operator roles and the OpenID Connect (OIDC) provider in a later step.
92+
cluster using manual mode. You will be prompted to configure the cluster-specific Operator roles and the OpenID Connect (OIDC) provider in a later step.
7793
====
7894
+
7995
[source,terminal]

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,15 @@ endif::[]
1717

1818
You can quickly create a
1919
ifdef::rosa-hcp[]
20-
{hcp} for
20+
{hcp-title}
2121
endif::rosa-hcp[]
22-
{product-title} (ROSA) cluster with the AWS Security Token Service (STS) by using the default installation options. The following summary describes the default cluster specifications.
22+
ifndef::rosa-hcp[]
23+
{product-title} (ROSA)
24+
endif::rosa-hcp[]
25+
cluster with the AWS Security Token Service (STS) by using the default installation options. The following summary describes the default cluster specifications.
2326

2427
ifdef::rosa-hcp[]
25-
.Default {hcp} for ROSA cluster specifications
28+
.Default {hcp-title} cluster specifications
2629
endif::rosa-hcp[]
2730
ifdef::rosa-standalone[]
2831
.Default ROSA with STS cluster specifications

0 commit comments

Comments
 (0)