Skip to content

Commit b961788

Browse files
committed
OSDOCS-14434: Changed the ROSA name variables.
1 parent c226350 commit b961788

File tree

33 files changed

+236
-202
lines changed

33 files changed

+236
-202
lines changed

_attributes/attributes-openshift-dedicated.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@
2727
:sts-first: Security Token Service (STS)
2828
:sts-full: Security Token Service
2929
:sts-short: STS
30+
// ROSA specific
31+
:hcp: hosted control planes
32+
:rosa-first: Red Hat OpenShift Service on AWS (ROSA) with {hcp} (HCP)
33+
:rosa-short: ROSA with HCP
34+
:rosa-classic-first: {product-title} (ROSA) (classic architecture)
35+
:rosa-classic: Red Hat OpenShift Service on AWS (classic architecture)
36+
:rosa-classic-short: ROSA (classic)
37+
:classic: {rosa-classic}
38+
:classic-short: {rosa-classic-short}
3039
//logging
3140
:logging-title: logging for Red Hat OpenShift
3241
:logging-title-uc: Logging for Red Hat OpenShift
@@ -49,11 +58,6 @@
4958
//Formerly known as CodeReady Containers and CodeReady Workspaces
5059
:openshift-local-productname: Red Hat OpenShift Local
5160
:openshift-dev-spaces-productname: Red Hat OpenShift Dev Spaces
52-
:hcp: hosted control planes
53-
:hcp-title: ROSA with HCP
54-
:hcp-title-first: {product-title} (ROSA) with {hcp} (HCP)
55-
:rosa-classic: ROSA (classic architecture)
56-
:rosa-classic-first: {product-title} (ROSA) (classic architecture)
5761
:egress-lockdown: {hcp-title} clusters with zero egress
5862
//ROSA CLI variables
5963
:zero-egress: zero egress

_distro_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ openshift-aro:
196196
name: '4'
197197
dir: aro/4
198198
openshift-rosa:
199-
name: Red Hat OpenShift Service on AWS
199+
name: Red Hat OpenShift Service on AWS (classic architecture)
200200
author: OpenShift Documentation Project <[email protected]>
201201
site: commercial
202202
site_name: Documentation

_topic_maps/_topic_map_rosa.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Topics:
2929
- Name: Welcome
3030
File: index
3131
- Name: Learn more about ROSA with HCP
32-
File: about-hcp
32+
File: rosa-classic-about
3333
- Name: AWS STS and ROSA with HCP explained
3434
File: cloud-experts-rosa-hcp-sts-explained
3535
- Name: Legal notice

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,20 @@
2121
# The ordering of the records in this document determines the ordering of the
2222
# topic groups and topics on the main page.
2323
---
24+
Name: About
25+
Dir: welcome
26+
Distros: openshift-rosa-hcp
27+
Topics:
28+
- Name: Welcome
29+
File: index
30+
- Name: Learn more about ROSA with HCP
31+
File: rosa-hcp-about
32+
- Name: AWS STS and ROSA with HCP explained
33+
File: cloud-experts-rosa-hcp-sts-explained
34+
- Name: Legal notice
35+
File: legal-notice
36+
Distros: openshift-rosa-hcp
37+
---
2438
Name: What's new
2539
Dir: rosa_release_notes
2640
Distros: openshift-rosa-hcp
@@ -32,14 +46,6 @@ Name: Introduction to ROSA
3246
Dir: rosa_architecture
3347
Distros: openshift-rosa-hcp
3448
Topics:
35-
- Name: Welcome
36-
File: index
37-
- Name: Legal notice
38-
File: legal-notice
39-
- Name: ROSA with HCP overview
40-
File: about-hcp
41-
- Name: AWS STS and ROSA with HCP explained
42-
File: cloud-experts-rosa-hcp-sts-explained
4349
- Name: Architecture models
4450
File: rosa-architecture-models
4551
- Name: Policies and service definition

cli_reference/rosa_cli/rosa-updating-billing-account-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:_mod-docs-content-type: ASSEMBLY
22
include::_attributes/attributes-openshift-dedicated.adoc[]
33
[id="rosa-updating-account-cli"]
4-
= Managing billing accounts for ROSA with HCP clusters
4+
= Managing billing accounts for {rosa-short} clusters
55
:context: rosa-updating-account-cli
66
toc::[]
77

cloud_experts_tutorials/cloud-experts-aws-secret-manager.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ ifndef::openshift-rosa-hcp[]
6363
See xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-a-cluster-quickly[Red{nbsp}Hat documentation on creating an STS cluster] before continuing this process.
6464
endif::openshift-rosa-hcp[]
6565
ifdef::openshift-rosa-hcp[]
66-
See link:https://docs.openshift.com/rosa-hcp/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.html[Creating ROSA with HCP clusters using the default options] before continuing this process.
66+
See link:https://docs.openshift.com/rosa-hcp/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.html[Creating {rosa-short} clusters using the default options] before continuing this process.
6767
endif::openshift-rosa-hcp[]
6868

6969
. Set the `SecurityContextConstraints` permission to allow the CSI driver to run by running the following command:

cloud_experts_tutorials/cloud-experts-deploying-application/cloud-experts-deploying-application-prerequisites.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ toc::[]
1414
. A Provisioned ROSA cluster
1515
+
1616
ifdef::openshift-rosa-hcp[]
17-
This lab assumes you have access to a successfully provisioned a ROSA cluster. If you have not yet created a ROSA cluster, see xref:../../rosa_hcp/rosa-hcp-quickstart-guide.adoc#rosa-getting-started-environment-setup_rosa-hcp-quickstart-guide[ROSA with HCP quick start guide] for more information.
17+
This lab assumes you have access to a successfully provisioned a ROSA cluster. If you have not yet created a ROSA cluster, see xref:../../rosa_hcp/rosa-hcp-quickstart-guide.adoc#rosa-getting-started-environment-setup_rosa-hcp-quickstart-guide[{rosa-short} quick start guide] for more information.
1818
endif::openshift-rosa-hcp[]
1919
ifdef::openshift-rosa[]
2020
This lab assumes you have access to a successfully provisioned a ROSA cluster. If you have not yet created a ROSA cluster, see xref:../../rosa_getting_started/rosa-quickstart-guide-ui.adoc#rosa-getting-started-environment-setup_rosa-quickstart-guide-ui[ROSA quick start guide] for more information.

cloud_experts_tutorials/cloud-experts-external-dns.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The `External DNS` Operator does not support STS using IAM Roles for Service Acc
3232
+
3333
[NOTE]
3434
====
35-
ROSA with HCP is not supported at this time.
35+
{rosa-short} is not supported at this time.
3636
====
3737
+
3838
* A user account with `cluster-admin` privileges

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This tutorial outlines the two options for allowing {product-title} (ROSA) to in
1313

1414
[NOTE]
1515
====
16-
This content currently covers ROSA Classic with AWS STS. For ROSA with hosted control planes (HCP) with AWS STS, see xref:../../welcome/cloud-experts-rosa-hcp-sts-explained.adoc#cloud-experts-rosa-hcp-sts-explained[AWS STS and ROSA with HCP explained].
16+
This content currently covers ROSA Classic with AWS STS. For ROSA with hosted control planes (HCP) with AWS STS, see xref:../../welcome/cloud-experts-rosa-hcp-sts-explained.adoc#cloud-experts-rosa-hcp-sts-explained[AWS STS and {rosa-short} explained].
1717
====
1818

1919
This tutorial will:

cloud_experts_tutorials/cloud-experts-rosa-with-hcp-private-offer-acceptance-and-sharing.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id=“cloud-experts-rosa-with-hcp-private-offer-acceptance-and-sharing”]
3-
= Tutorial: ROSA with HCP private offer acceptance and sharing
3+
= Tutorial: {rosa-short} private offer acceptance and sharing
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: cloud-experts-rosa-with-hcp-private-offer-acceptance-and-sharing
66

@@ -151,7 +151,7 @@ image::rosa-infrastructure-and-billing-aws-account-selection-during-rosa-with-hc
151151
* John makes sure that Anne Red{nbsp}Hat user is in the same Red{nbsp}Hat organization as John’s Red{nbsp}Hat user. John is the Red{nbsp}Hat organization administrator and can do that here.
152152
* Anne visits the {hybrid-console} and starts a new cluster deployment.
153153
* During the initial steps, Anne makes sure to select 111111111111 as the AWS billing account, while using their own AWS account 123412341234 as the AWS infrastructure account.
154-
* Note that Anne is also able to select their own AWS account 123412341234 as the billing account when creating a cluster because they previously activated the ROSA with HCP public offer. However, that would result in custom private offer pricing not being applied to this cluster. Therefore it is important for John to communicate the information about which AWS billing account is to be used by employees when creating a new cluster in order to benefit from a private offer that was accepted before.
154+
* Note that Anne is also able to select their own AWS account 123412341234 as the billing account when creating a cluster because they previously activated the {rosa-short} public offer. However, that would result in custom private offer pricing not being applied to this cluster. Therefore it is important for John to communicate the information about which AWS billing account is to be used by employees when creating a new cluster in order to benefit from a private offer that was accepted before.
155155
////
156156

157157
== Troubleshooting
@@ -190,7 +190,7 @@ image::rosa-aws-account-is-already-linked-to-a-different-red-hat-account.png[]
190190

191191
** However, since this guide pertains to private offers, the assumption is that you are logged in with the AWS account that was specified as the buyer and already accepted the private offer so it is intended to be used as the billing account. Logging in as another AWS account is not expected after a private offer was accepted.
192192

193-
* You can still log in with another Red{nbsp}Hat user which is already connected to the AWS account that accepted the private offer. Other Red{nbsp}Hat users belonging to the same Red{nbsp}Hat organization are able to use the linked AWS account as the ROSA with HCP AWS billing account when creating clusters as seen in Figure 10.
193+
* You can still log in with another Red{nbsp}Hat user which is already connected to the AWS account that accepted the private offer. Other Red{nbsp}Hat users belonging to the same Red{nbsp}Hat organization are able to use the linked AWS account as the {rosa-short} AWS billing account when creating clusters as seen in Figure 10.
194194

195195
* If you believe that the existing account linking might not be correct, see the "My team members belong to different Red{nbsp}Hat organizations" question below for tips on how you can proceed.
196196

cloud_experts_tutorials/cloud-experts-update-component-routes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The changes that we make to the component routes{fn-term-component-routes} in th
2222
+
2323
[NOTE]
2424
====
25-
ROSA with HCP is not supported at this time.
25+
{rosa-short} is not supported at this time.
2626
====
2727
+
2828
* OpenShift CLI (`oc`)

modules/rosa-architecture-local-zones.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
// * architecture/rosa-architecture-models.adoc
44
:_mod-docs-content-type: REFERENCE
55
[id="rosa-architecture-local-zones_{context}"]
6-
= ROSA architecture with Local Zones
6+
= {rosa-classic-short} architecture with Local Zones
77

8-
ROSA supports the use of AWS Local Zones, which are metropolis-centralized availability zones where customers can place latency-sensitive application workloads within a VPC. Local Zones are extensions of AWS Regions and are not enabled by default. When Local Zones are enabled and configured, the traffic is extended into the Local Zones for greater flexibility and lower latency. For more information, see "Configuring machine pools in Local Zones".
8+
{rosa-classic-short} supports the use of AWS Local Zones, which are metropolis-centralized availability zones where customers can place latency-sensitive application workloads within a VPC. Local Zones are extensions of AWS Regions and are not enabled by default. When Local Zones are enabled and configured, the traffic is extended into the Local Zones for greater flexibility and lower latency. For more information, see "Configuring machine pools in Local Zones".
99

1010
The following diagram displays a ROSA cluster without traffic routed into a Local Zone.
1111

12-
.ROSA cluster without traffic routed into Local Zones
13-
image::../images/354_OpenShift_ROSA_Local_Zones_0923_1.png[ROSA cluster without traffic routed into Local Zones]
12+
.{rosa-classic-short} cluster without traffic routed into Local Zones
13+
image::../images/354_OpenShift_ROSA_Local_Zones_0923_1.png[{rosa-classic-short} cluster without traffic routed into Local Zones]
1414

15-
The following diagram displays a ROSA cluster with traffic routed into a Local Zone.
15+
The following diagram displays a {rosa-classic-short} cluster with traffic routed into a Local Zone.
1616

17-
.ROSA cluster with traffic routed into Local Zones
18-
image::../images/354_OpenShift_ROSA_Local_Zones_0923_2.png[ROSA cluster with traffic routed into Local Zones]
17+
.{rosa-classic-short} cluster with traffic routed into Local Zones
18+
image::../images/354_OpenShift_ROSA_Local_Zones_0923_2.png[{rosa-classic-short} cluster with traffic routed into Local Zones]

modules/rosa-architecture.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,31 @@
33
// * rosa_architecture/rosa_architecture_sub/rosa-architecture-models.adoc
44

55
[id="rosa-classic-architecture_{context}"]
6-
= ROSA Classic architecture
6+
= {rosa-classic-short} architecture
77

8-
In {product-rosa} (ROSA) Classic, both the control plane and the worker nodes are deployed in your VPC subnets.
8+
In {rosa-classic-first}, both the control plane and the worker nodes are deployed in your VPC subnets.
99

1010
[id="rosa-classic-architecture-networks_{context}"]
11-
== ROSA Classic architecture on public and private networks
11+
== {rosa-classic-short} architecture on public and private networks
1212

13-
With ROSA Classic, you can create clusters that are accessible over public or private networks.
13+
With {rosa-classic-short}, you can create clusters that are accessible over public or private networks.
1414

1515
You can customize access patterns for your API server endpoint and Red{nbsp}Hat SRE management in the following ways:
1616

1717
* Public - API server endpoint and application routes are internet-facing.
1818

19-
* Private - API server endpoint and application routes are private. Private ROSA Classic clusters use some public subnets, but no control plane or worker nodes are deployed in public subnets.
19+
* Private - API server endpoint and application routes are private. Private {rosa-classic-short} clusters use some public subnets, but no control plane or worker nodes are deployed in public subnets.
2020

2121
* Private with AWS PrivateLink - API server endpoint and application routes are private. Public subnets or NAT gateways are not required in your VPC for egress. ROSA SRE management uses AWS PrivateLink.
2222

23-
The following image depicts the architecture of a ROSA Classic cluster deployed on both public and private networks.
23+
The following image depicts the architecture of a {rosa-classic-short} cluster deployed on both public and private networks.
2424

25-
.ROSA Classic deployed on public and private networks
26-
image::156_OpenShift_ROSA_Arch_0621_private_public_classic.png[ROSA deployed on public and private networks]
25+
.{rosa-classic-short} deployed on public and private networks
26+
image::156_OpenShift_ROSA_Arch_0621_private_public_classic.png[{rosa-classic-short} deployed on public and private networks]
2727

28-
ROSA Classic clusters include infrastructure nodes where OpenShift components such as the ingress controller, image registry, and monitoring are deployed. The infrastructure nodes and the OpenShift components deployed on them are managed by ROSA Service SREs.
28+
{rosa-classic-short} clusters include infrastructure nodes where OpenShift components such as the ingress controller, image registry, and monitoring are deployed. The infrastructure nodes and the OpenShift components deployed on them are managed by ROSA Service SREs.
2929

30-
The following types of clusters are available with ROSA Classic:
30+
The following types of clusters are available with {rosa-classic-short}:
3131

3232
* Single zone cluster - The control plane and worker nodes are hosted on a single availability zone.
3333

modules/rosa-hcp-architecture.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55
[id="rosa-hcp-architecture_{context}"]
66
= ROSA with HCP architecture
77

8-
In {hcp-title-first}, the ROSA service hosts a highly-available, single-tenant OpenShift control plane. The hosted control plane is deployed across 3 availability zones with 2 API server instances and 3 etcd instances.
8+
In {rosa-first}, the ROSA service hosts a highly-available, single-tenant OpenShift control plane. The hosted control plane is deployed across 3 availability zones with 2 API server instances and 3 etcd instances.
99

1010
You can create a ROSA with HCP cluster with or without an internet-facing API server. Private API servers are only accessible from your VPC subnets. You access the hosted control plane through an AWS PrivateLink endpoint.
1111

1212
The worker nodes are deployed in your AWS account and run on your VPC private subnets. You can add additional private subnets from one or more availability zones to ensure high availability. Worker nodes are shared by OpenShift components and applications. OpenShift components such as the ingress controller, image registry, and monitoring are deployed on the worker nodes hosted on your VPC.
1313

14-
.ROSA with HCP architecture
15-
image::544_OpenShift_ROSA-HCP_architecture-model.png[ROSA with HCP architecture]
14+
.{rosa-short} architecture
15+
image::544_OpenShift_ROSA-HCP_architecture-model.png[{rosa-short} architecture]
1616

1717
[id="rosa-hcp-network-architecture_{context}"]
18-
== ROSA with HCP architecture on public and private networks
19-
With ROSA with HCP, you can create your clusters on public or private networks. The following images depict the architecture of both public and private networks.
18+
== {rosa-short} architecture on public and private networks
19+
With {rosa-short}, you can create your clusters on public or private networks. The following images depict the architecture of both public and private networks.
2020

21-
.ROSA with HCP deployed on a public network
22-
image::544_OpenShift_ROSA-HCP-and-ROSA-Classic-public.png[ROSA with HCP deployed on a public network]
21+
.{rosa-short} deployed on a public network
22+
image::544_OpenShift_ROSA-HCP-and-ROSA-Classic-public.png[{rosa-short} deployed on a public network]
2323

24-
.ROSA with HCP deployed on a private network
25-
image::544_OpenShift_ROSA-HCP-and-ROSA-Classic-private.png[ROSA with HCP deployed on a private network]
24+
.{rosa-short} deployed on a private network
25+
image::544_OpenShift_ROSA-HCP-and-ROSA-Classic-private.png[{rosa-short} deployed on a private network]

0 commit comments

Comments
 (0)