Skip to content

Commit fe89833

Browse files
committed
OSDOCS-14500
1 parent 0c30bc3 commit fe89833

18 files changed

+85
-112
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,10 +111,6 @@ Topics:
111111
File: index
112112
#- Name: ROSA prerequisites
113113
# File: rosa-mobb-prerequisites-tutorial
114-
- Name: ROSA with HCP activation and account linking
115-
File: cloud-experts-rosa-hcp-activation-and-account-linking-tutorial
116-
- Name: ROSA with HCP private offer acceptance and sharing
117-
File: cloud-experts-rosa-with-hcp-private-offer-acceptance-and-sharing
118114
- Name: Verifying Permissions for a ROSA STS Deployment
119115
File: rosa-mobb-verify-permissions-sts-deployment
120116
- Name: Deploying ROSA with a Custom DNS Resolver

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ Topics:
141141
File: cloud-experts-aws-secret-manager
142142
- Name: Using AWS Controllers for Kubernetes on ROSA
143143
File: cloud-experts-using-aws-ack
144-
- Name: Dynamically issuing certificates using the cert-manager Operator on ROSA
145-
File: cloud-experts-dynamic-certificate-custom-domain
144+
#- Name: Dynamically issuing certificates using the cert-manager Operator on ROSA
145+
# File: cloud-experts-dynamic-certificate-custom-domain
146146
- Name: Assigning consistent egress IP for external traffic
147147
File: cloud-experts-consistent-egress-ip
148148
# ---

cloud_experts_tutorials/cloud-experts-aws-load-balancer-operator.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="cloud-experts-aws-load-balancer-operator"]
3-
= Tutorial: AWS Load Balancer Operator on ROSA
3+
= Tutorial: AWS Load Balancer Operator on {product-title}
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: cloud-experts-aws-load-balancer-operator
66

@@ -33,7 +33,7 @@ Load Balancers created by the AWS Load Balancer Operator cannot be used for link
3333
====
3434
endif::openshift-rosa-hcp[]
3535

36-
The link:https://kubernetes-sigs.github.io/aws-load-balancer-controller/[AWS Load Balancer Controller] manages AWS Elastic Load Balancers for a {product-title} (ROSA) cluster. The controller provisions link:https://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html[AWS Application Load Balancers (ALB)] when you create Kubernetes Ingress resources and link:https://docs.aws.amazon.com/elasticloadbalancing/latest/network/introduction.html[AWS Network Load Balancers (NLB)] when implementing Kubernetes Service resources with a type of LoadBalancer.
36+
The link:https://kubernetes-sigs.github.io/aws-load-balancer-controller/[AWS Load Balancer Controller] manages AWS Elastic Load Balancers for a {product-title} cluster. The controller provisions link:https://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html[AWS Application Load Balancers (ALB)] when you create Kubernetes Ingress resources and link:https://docs.aws.amazon.com/elasticloadbalancing/latest/network/introduction.html[AWS Network Load Balancers (NLB)] when implementing Kubernetes Service resources with a type of LoadBalancer.
3737

3838
Compared with the default AWS in-tree load balancer provider, this controller is developed with advanced annotations for both ALBs and NLBs. Some advanced use cases are:
3939

@@ -53,11 +53,10 @@ AWS ALBs require a multi-AZ cluster, as well as three public subnets split acros
5353
====
5454

5555
ifndef::openshift-rosa-hcp[]
56-
* xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-a-cluster-quickly[A multi-AZ ROSA classic cluster]
56+
* xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-a-cluster-quickly[A multi-AZ {product-title} cluster]
5757
endif::openshift-rosa-hcp[]
5858
ifdef::openshift-rosa-hcp[]
59-
* link:https://docs.openshift.com/rosa-hcp/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.html[A multi-AZ ROSA cluster]
60-
endif::openshift-rosa-hcp[]
59+
* xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-quickly[A multi-AZ {product-title} cluster]
6160
* BYO VPC cluster
6261
* AWS CLI
6362
* OC CLI

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="cloud-experts-aws-secret-manager"]
3-
= Tutorial: Using AWS Secrets Manager CSI on ROSA with STS
3+
= Tutorial: Using AWS Secrets Manager CSI on {product-title} with STS
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: cloud-experts-aws-secret-manager
66

@@ -17,14 +17,14 @@ toc::[]
1717
// - Chris Kang
1818
// ---
1919

20-
The AWS Secrets and Configuration Provider (ASCP) provides a way to expose AWS Secrets as Kubernetes storage volumes. With the ASCP, you can store and manage your secrets in Secrets Manager and then retrieve them through your workloads running on {product-title} (ROSA).
20+
The AWS Secrets and Configuration Provider (ASCP) provides a way to expose AWS Secrets as Kubernetes storage volumes. With the ASCP, you can store and manage your secrets in Secrets Manager and then retrieve them through your workloads running on {product-title}.
2121

2222
[id="cloud-experts-aws-secret-manager-prerequisites"]
2323
== Prerequisites
2424

2525
Ensure that you have the following resources and tools before starting this process:
2626

27-
* A ROSA cluster deployed with STS
27+
* A {product-title} cluster deployed with STS
2828
* Helm 3
2929
* `aws` CLI
3030
* `oc` CLI
@@ -34,7 +34,7 @@ Ensure that you have the following resources and tools before starting this proc
3434
[id="cloud-experts-aws-secret-manager-preparing-environment"]
3535
=== Additional environment requirements
3636

37-
. Log in to your ROSA cluster by running the following command:
37+
. Log in to your {product-title} cluster by running the following command:
3838
+
3939
[source,terminal]
4040
----
@@ -58,12 +58,13 @@ $ oc get authentication.config.openshift.io cluster -o json \
5858
"https://xxxxx.cloudfront.net/xxxxx"
5959
----
6060
+
61-
If your output is different, do not proceed.
61+
If your output is different, do not proceed.
62+
See
6263
ifndef::openshift-rosa-hcp[]
63-
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.
64+
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.
6465
endif::openshift-rosa-hcp[]
6566
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.
67+
xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-quickly[Red{nbsp}Hat documentation on creating an STS cluster] before continuing this process.
6768
endif::openshift-rosa-hcp[]
6869

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

cloud_experts_tutorials/cloud-experts-consistent-egress-ip.adoc

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ toc::[]
1919

2020
You can assign a consistent IP address for traffic that leaves your cluster such as security groups which require an IP-based configuration to meet security standards.
2121

22-
By default, {product-title} (ROSA) uses the OVN-Kubernetes container network interface (CNI) to assign random IP addresses from a pool. This can make configuring security lockdowns unpredictable or open.
22+
By default, {product-title} uses the OVN-Kubernetes container network interface (CNI) to assign random IP addresses from a pool. This can make configuring security lockdowns unpredictable or open.
2323

2424
ifndef::openshift-rosa-hcp[]
2525
See xref:../networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc#configuring-egress-ips-ovn[Configuring an egress IP address] for more information.
@@ -34,15 +34,9 @@ endif::openshift-rosa-hcp[]
3434
3535
.Prerequisites
3636

37-
* A ROSA cluster deployed with OVN-Kubernetes
38-
ifndef::openshift-rosa-hcp[]
37+
* A {product-title} cluster deployed with OVN-Kubernetes
3938
* The xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI] (`oc`)
4039
* The xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[ROSA CLI] (`rosa`)
41-
endif::openshift-rosa-hcp[]
42-
ifdef::openshift-rosa-hcp[]
43-
* The link:https://docs.openshift.com/rosa/cli_reference/openshift_cli/getting-started-cli.html[OpenShift CLI] (`oc`)
44-
* The link:https://docs.openshift.com/rosa/cli_reference/rosa_cli/rosa-get-started-cli.html[ROSA CLI] (`rosa`)
45-
endif::openshift-rosa-hcp[]
4640
* link:https://stedolan.github.io/jq/[`jq`]
4741
4842

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="cloud-experts-custom-dns-resolver"]
3-
= Tutorial: Deploying ROSA with a Custom DNS Resolver
3+
= Tutorial: Deploying {product-title} with a Custom DNS Resolver
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: cloud-experts-custom-dns-resolver
66

77
toc::[]
88

9-
A link:https://docs.aws.amazon.com/vpc/latest/userguide/DHCPOptionSet.html[custom DHCP option set] enables you to customize your VPC with your own DNS server, domain name, and more. {product-title} (ROSA) clusters support using custom DHCP option sets. By default, ROSA clusters require setting the "domain name servers" option to `AmazonProvidedDNS` to ensure successful cluster creation and operation. Customers who want to use custom DNS servers for DNS resolution must do additional configuration to ensure successful ROSA cluster creation and operation.
9+
A link:https://docs.aws.amazon.com/vpc/latest/userguide/DHCPOptionSet.html[custom DHCP option set] enables you to customize your VPC with your own DNS server, domain name, and more. {product-title} clusters support using custom DHCP option sets. By default, {product-title} clusters require setting the "domain name servers" option to `AmazonProvidedDNS` to ensure successful cluster creation and operation. Customers who want to use custom DNS servers for DNS resolution must do additional configuration to ensure successful {product-title} cluster creation and operation.
1010

1111
In this tutorial, we will configure our DNS server to forward DNS lookups for specific DNS zones (further detailed below) to an link:https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html[Amazon Route 53 Inbound Resolver].
1212

1313
[NOTE]
1414
====
15-
This tutorial uses the open-source BIND DNS server (`named`) to demonstrate the configuration necessary to forward DNS lookups to an Amazon Route 53 Inbound Resolver located in the VPC you plan to deploy a ROSA cluster into. Refer to the documentation of your preferred DNS server for how to configure zone forwarding.
15+
This tutorial uses the open-source BIND DNS server (`named`) to demonstrate the configuration necessary to forward DNS lookups to an Amazon Route 53 Inbound Resolver located in the VPC you plan to deploy a {product-title} cluster into. Refer to the documentation of your preferred DNS server for how to configure zone forwarding.
1616
====
1717

1818
[id="cloud-experts-custom-dns-resolver-prerequisites"]
@@ -124,9 +124,9 @@ $ aws route53resolver list-resolver-endpoint-ip-addresses \
124124

125125
Use the following procedure to configure your DNS server to forward the necessary private hosted zones to your Amazon Route 53 Inbound Resolver.
126126

127-
//ifdef::openshift-rosa-hcp[]
128-
=== ROSA with HCP
129-
ROSA with HCP clusters require you to configure DNS forwarding for two private hosted zones:
127+
ifdef::openshift-rosa-hcp[]
128+
=== {product-title}
129+
{product-title} clusters require you to configure DNS forwarding for two private hosted zones:
130130

131131
* `<cluster-name>.hypershift.local`
132132
* `rosa.<domain-prefix>.<unique-ID>.p3.openshiftapps.com`
@@ -148,10 +148,10 @@ zone "<cluster-name>.hypershift.local" { <1>
148148
};
149149
};
150150
----
151-
<1> Replace `<cluster-name>` with your ROSA HCP cluster name.
151+
<1> Replace `<cluster-name>` with your {product-title} cluster name.
152152
<2> Replace with the IP addresses of your inbound resolver endpoints collected above, ensuring that following each IP address there is a `;`.
153153
+
154-
. link:https://docs.openshift.com/rosa/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.html[Create your cluster].
154+
. xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-quickly[Create your cluster].
155155
+
156156
. Once your cluster has begun the creation process, locate the newly created private hosted zone:
157157
+
@@ -198,11 +198,11 @@ zone "rosa.<domain-prefix>.<unique-ID>.p3.openshiftapps.com" { <1>
198198
----
199199
<1> Replace `<domain-prefix>` with your cluster domain prefix and `<unique-ID>` with your unique ID collected above.
200200
<2> Replace with the IP addresses of your inbound resolver endpoints collected above, ensuring that following each IP address there is a `;`.
201-
//endif::openshift-rosa-hcp[]
201+
endif::openshift-rosa-hcp[]
202202
203203
ifdef::openshift-rosa[]
204-
=== ROSA Classic
205-
ROSA Classic clusters require you to configure DNS forwarding for one private hosted zones:
204+
=== {product-title}
205+
{product-title} clusters require you to configure DNS forwarding for one private hosted zones:
206206
207207
* `<domain-prefix>.<unique-ID>.p1.openshiftapps.com`
208208

cloud_experts_tutorials/cloud-experts-deploy-api-data-protection.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-deploy-api-data-protection"]
3-
= Tutorial: Deploying OpenShift API for Data Protection on a ROSA cluster
3+
= Tutorial: Deploying OpenShift API for Data Protection on a {product-title} cluster
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: cloud-experts-deploy-api-data-protection
66

@@ -22,10 +22,10 @@ include::snippets/mobb-support-statement.adoc[leveloffset=+1]
2222
.Prerequisites
2323

2424
ifndef::openshift-rosa-hcp[]
25-
* A xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-a-cluster-quickly[ROSA classic cluster]
25+
* A xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc#rosa-sts-creating-a-cluster-quickly[{product-title} cluster]
2626
endif::openshift-rosa-hcp[]
2727
ifdef::openshift-rosa-hcp[]
28-
* A link:https://docs.openshift.com/rosa-hcp/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.html[ROSA cluster]
28+
* A xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-quickly[{product-title} cluster]
2929
endif::openshift-rosa-hcp[]
3030

3131
.Environment

cloud_experts_tutorials/cloud-experts-dynamic-certificate-custom-domain.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-dynamic-certificate-custom-domain"]
3-
= Tutorial: Dynamically issuing certificates using the cert-manager Operator on ROSA
3+
= Tutorial: Dynamically issuing certificates using the cert-manager Operator on {product-title}
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: cloud-experts-dynamic-certificate-custom-domain
66

@@ -24,7 +24,7 @@ Learn how to use the link:https://docs.openshift.com/container-platform/latest/s
2424
[id="cloud-experts-dynamic-certificate-custom-domain-prerequisites"]
2525
== Prerequisites
2626

27-
* A ROSA cluster (HCP or Classic)
27+
* A {product-title} cluster
2828
* A user account with `cluster-admin` privileges
2929
* The OpenShift CLI (`oc`)
3030
* The Amazon Web Services (AWS) CLI (`aws`)
@@ -71,7 +71,7 @@ $ export CLUSTER=my-custom-value
7171
[id="cloud-experts-dynamic-certificate-prep-aws"]
7272
== Preparing your AWS account
7373

74-
When cert-manager requests a certificate from Lets Encrypt (or another ACME certificate issuer), Let's Encrypt servers validate that you control the domain name in that certificate using _challenges_. For this tutorial, you are using a link:https://letsencrypt.org/docs/challenge-types/#dns-01-challenge[DNS-01 challenge] that proves that you control the DNS for your domain name by putting a specific value in a TXT record under that domain name. This is all done automatically by cert-manager. To allow cert-manager permission to modify the Amazon Route 53 public hosted zone for your domain, you need to create an Identity Access Management (IAM) role with specific policy permissions and a trust relationship to allow access to the pod.
74+
When cert-manager requests a certificate from Let's Encrypt (or another ACME certificate issuer), Let's Encrypt servers validate that you control the domain name in that certificate using _challenges_. For this tutorial, you are using a link:https://letsencrypt.org/docs/challenge-types/#dns-01-challenge[DNS-01 challenge] that proves that you control the DNS for your domain name by putting a specific value in a TXT record under that domain name. This is all done automatically by cert-manager. To allow cert-manager permission to modify the Amazon Route 53 public hosted zone for your domain, you need to create an Identity Access Management (IAM) role with specific policy permissions and a trust relationship to allow access to the pod.
7575

7676
The public hosted zone that is used in this tutorial is in the same AWS account as the ROSA cluster. If your public hosted zone is in a different account, a few additional steps for link:https://cert-manager.io/docs/configuration/acme/dns01/route53/#cross-account-access[Cross Account Access] are required.
7777

cloud_experts_tutorials/cloud-experts-entra-id-idp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ toc::[]
1919
// - Thatcher Hubbard
2020
// ---
2121

22-
You can configure Microsoft Entra ID (formerly Azure Active Directory) as the cluster identity provider in {product-title} (ROSA).
22+
You can configure Microsoft Entra ID (formerly Azure Active Directory) as the cluster identity provider in {product-title}.
2323

2424
This tutorial guides you to complete the following tasks:
2525

cloud_experts_tutorials/cloud-experts-external-dns.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="cloud-experts-external-dns"]
3-
= Tutorial: Deploying the External DNS Operator on ROSA
3+
= Tutorial: Deploying the External DNS Operator on {product-title}
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: cloud-experts-external-dns
66

@@ -18,7 +18,7 @@ toc::[]
1818
// - Dustin Scott
1919
//---
2020

21-
The External DNS Operator deploys and manages `ExternalDNS` to provide the name resolution for services and routes from the external DNS provider, like Amazon Route 53, to {product-title} (ROSA) clusters. In this tutorial, we will deploy and configure the External DNS Operator with a secondary ingress controller to manage DNS records in Amazon Route 53.
21+
The External DNS Operator deploys and manages `ExternalDNS` to provide the name resolution for services and routes from the external DNS provider, like Amazon Route 53, to {product-title} clusters. In this tutorial, we will deploy and configure the External DNS Operator with a secondary ingress controller to manage DNS records in Amazon Route 53.
2222

2323
[IMPORTANT]
2424
====

0 commit comments

Comments
 (0)