Skip to content

Commit ec9a3bd

Browse files
authored
Merge pull request #98004 from jneczypor/OSDOCS-14500
OSDOCS-14500: Prune "Tutorials"
2 parents a22a260 + e98d694 commit ec9a3bd

20 files changed

+187
-215
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -109,45 +109,41 @@ Distros: openshift-rosa
109109
Topics:
110110
- Name: Tutorials overview
111111
File: index
112-
#- Name: ROSA prerequisites
112+
#- Name: ROSA classic architecture 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
118-
- Name: Verifying Permissions for a ROSA STS Deployment
114+
- Name: Verifying Permissions for a ROSA classic architecture STS Deployment
119115
File: rosa-mobb-verify-permissions-sts-deployment
120-
- Name: Deploying ROSA with a Custom DNS Resolver
116+
- Name: Deploying ROSA classic architecture with a Custom DNS Resolver
121117
File: cloud-experts-custom-dns-resolver
122-
- Name: Using AWS WAF and Amazon CloudFront to protect ROSA workloads
118+
- Name: Using AWS WAF and Amazon CloudFront to protect ROSA classic architecture workloads
123119
File: cloud-experts-using-cloudfront-and-waf
124-
- Name: Using AWS WAF and AWS ALBs to protect ROSA workloads
120+
- Name: Using AWS WAF and AWS ALBs to protect ROSA classic architecture workloads
125121
File: cloud-experts-using-alb-and-waf
126-
- Name: Deploying OpenShift API for Data Protection on a ROSA cluster
122+
- Name: Deploying OpenShift API for Data Protection on a ROSA classic architecture cluster
127123
File: cloud-experts-deploy-api-data-protection
128-
- Name: AWS Load Balancer Operator on ROSA
124+
- Name: AWS Load Balancer Operator on ROSA classic architecture
129125
File: cloud-experts-aws-load-balancer-operator
130126
- Name: Configuring Microsoft Entra ID (formerly Azure Active Directory) as an identity provider
131127
File: cloud-experts-entra-id-idp
132-
- Name: Using AWS Secrets Manager CSI on ROSA with STS
128+
- Name: Using AWS Secrets Manager CSI on ROSA classic architecture with STS
133129
File: cloud-experts-aws-secret-manager
134-
- Name: Using AWS Controllers for Kubernetes on ROSA
130+
- Name: Using AWS Controllers for Kubernetes on ROSA classic architecture
135131
File: cloud-experts-using-aws-ack
136-
- Name: Deploying the External DNS Operator on ROSA
132+
- Name: Deploying the External DNS Operator on ROSA classic architecture
137133
File: cloud-experts-external-dns
138134
- Name: Dynamically issuing certificates using the cert-manager Operator on ROSA
139135
File: cloud-experts-dynamic-certificate-custom-domain
140136
- Name: Assigning consistent egress IP for external traffic
141137
File: cloud-experts-consistent-egress-ip
142138
- Name: Updating component routes with custom domains and TLS certificates
143139
File: cloud-experts-update-component-routes
144-
- Name: Getting started with ROSA
140+
- Name: Getting started with ROSA classic architecture
145141
Dir: cloud-experts-getting-started
146142
Distros: openshift-rosa
147143
Topics:
148-
- Name: What is ROSA
144+
- Name: What is ROSA classic architecture
149145
File: cloud-experts-getting-started-what-is-rosa
150-
- Name: ROSA with AWS STS explained
146+
- Name: ROSA classic architecture with AWS STS explained
151147
File: cloud-experts-rosa-sts-explained
152148
- Name: OpenShift concepts
153149
File: cloud-experts-getting-started-openshift-concepts
@@ -164,8 +160,6 @@ Topics:
164160
File: cloud-experts-getting-started-simple-ui-guide
165161
- Name: Detailed UI guide
166162
File: cloud-experts-getting-started-detailed-ui
167-
- Name: HCP deployment guide
168-
File: cloud-experts-getting-started-hcp
169163
- Name: Creating an admin user
170164
File: cloud-experts-getting-started-admin
171165
- Name: Setting up an identity provider

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ Topics:
3636
File: index
3737
- Name: Legal notice
3838
File: legal-notice
39-
- Name: ROSA with HCP overview
39+
- Name: ROSA overview
4040
File: about-hcp
41-
- Name: AWS STS and ROSA with HCP explained
41+
- Name: AWS STS and ROSA explained
4242
File: cloud-experts-rosa-hcp-sts-explained
4343
- Name: Architecture models
4444
File: rosa-architecture-models
@@ -50,11 +50,11 @@ Topics:
5050
File: rosa-policy-understand-availability
5151
- Name: Overview of responsibilities for ROSA
5252
File: rosa-policy-responsibility-matrix
53-
- Name: ROSA with HCP service definition
53+
- Name: ROSA service definition
5454
File: rosa-hcp-service-definition
55-
- Name: ROSA with HCP instance types
55+
- Name: ROSA instance types
5656
File: rosa-hcp-instance-types
57-
- Name: ROSA with HCP update life cycle
57+
- Name: ROSA update life cycle
5858
File: rosa-hcp-life-cycle
5959
- Name: SRE and service account access
6060
File: rosa-sre-access
@@ -121,9 +121,9 @@ Distros: openshift-rosa-hcp
121121
Topics:
122122
- Name: Tutorials overview
123123
File: index
124-
- Name: ROSA with HCP activation and account linking
124+
- Name: ROSA activation and account linking
125125
File: cloud-experts-rosa-hcp-activation-and-account-linking-tutorial
126-
- Name: ROSA with HCP private offer acceptance and sharing
126+
- Name: ROSA private offer acceptance and sharing
127127
File: cloud-experts-rosa-with-hcp-private-offer-acceptance-and-sharing
128128
- Name: Deploying ROSA with a Custom DNS Resolver
129129
File: cloud-experts-custom-dns-resolver
@@ -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
# ---
@@ -161,14 +161,14 @@ Name: Prepare your environment
161161
Dir: rosa_planning
162162
Distros: openshift-rosa-hcp
163163
Topics:
164-
- Name: Prerequisites checklist for deploying ROSA with HCP
164+
- Name: Prerequisites checklist for deploying ROSA
165165
File: rosa-cloud-expert-prereq-checklist
166-
- Name: Detailed requirements for deploying ROSA with HCP
166+
- Name: Detailed requirements for deploying ROSA
167167
File: rosa-sts-aws-prereqs
168168
- Name: Required IAM roles and resources
169169
File: rosa-hcp-prepare-iam-roles-resources
170170
##### NOTE: THE BELOW IS REMOVED AS PART OF OSDOCS-13310
171-
#- Name: ROSA with HCP limits and scalability
171+
#- Name: ROSA limits and scalability
172172
# File: rosa-hcp-limits-scalability
173173
##### NOTE: THE ABOVE IS REMOVED AS PART OF OSDOCS-13310
174174
- Name: Required AWS service quotas
@@ -178,33 +178,33 @@ Topics:
178178
- Name: Planning resource usage in your cluster
179179
File: rosa-planning-environment
180180
---
181-
Name: Install ROSA with HCP clusters
181+
Name: Install ROSA clusters
182182
Dir: rosa_hcp
183183
Distros: openshift-rosa-hcp
184184
Topics:
185-
- Name: ROSA with HCP quick start guide
185+
- Name: ROSA quick start guide
186186
File: rosa-hcp-quickstart-guide
187-
- Name: Creating ROSA with HCP clusters using the default options
187+
- Name: Creating ROSA clusters using the default options
188188
File: rosa-hcp-sts-creating-a-cluster-quickly
189189
- Name: Creating a ROSA cluster using Terraform
190190
Dir: terraform
191191
Distros: openshift-rosa-hcp
192192
Topics:
193193
- Name: Creating a default ROSA cluster using Terraform
194194
File: rosa-hcp-creating-a-cluster-quickly-terraform
195-
- Name: Creating ROSA with HCP clusters using a custom AWS KMS encryption key
195+
- Name: Creating ROSA clusters using a custom AWS KMS encryption key
196196
File: rosa-hcp-creating-cluster-with-aws-kms-key
197-
- Name: Configuring a shared virtual private cloud for ROSA with HCP clusters
197+
- Name: Configuring a shared virtual private cloud for ROSA clusters
198198
File: rosa-hcp-shared-vpc-config
199-
- Name: Creating a private cluster on ROSA with HCP
199+
- Name: Creating a private cluster on ROSA
200200
File: rosa-hcp-aws-private-creating-cluster
201-
- Name: Creating ROSA with HCP clusters with egress zero
201+
- Name: Creating ROSA clusters with egress zero
202202
File: rosa-hcp-egress-zero-install
203-
- Name: Creating a ROSA with HCP cluster that uses direct authentication with an external OIDC identity provider
203+
- Name: Creating a ROSA cluster that uses direct authentication with an external OIDC identity provider
204204
File: rosa-hcp-sts-creating-a-cluster-ext-auth
205-
- Name: Creating ROSA with HCP clusters without a CNI plugin
205+
- Name: Creating ROSA clusters without a CNI plugin
206206
File: rosa-hcp-cluster-no-cni
207-
- Name: Deleting a ROSA with HCP cluster
207+
- Name: Deleting a ROSA cluster
208208
File: rosa-hcp-deleting-cluster
209209
---
210210
Name: Web console
@@ -569,7 +569,7 @@ Name: Upgrading
569569
Dir: upgrading
570570
Distros: openshift-rosa-hcp
571571
Topics:
572-
- Name: Upgrading ROSA with HCP
572+
- Name: Upgrading ROSA
573573
File: rosa-hcp-upgrading
574574
---
575575
Name: CI/CD

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

Lines changed: 9 additions & 10 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

@@ -42,7 +42,7 @@ Compared with the default AWS in-tree load balancer provider, this controller is
4242
* Specify custom NLB source IP ranges
4343
* Specify custom NLB internal IP addresses
4444
45-
The link:https://github.com/openshift/aws-load-balancer-operator[AWS Load Balancer Operator] is used to used to install, manage and configure an instance of `aws-load-balancer-controller` in a ROSA cluster.
45+
The link:https://github.com/openshift/aws-load-balancer-operator[AWS Load Balancer Operator] is used to used to install, manage and configure an instance of `aws-load-balancer-controller` in a {product-title} cluster.
4646

4747
[id="prerequisites_{context}"]
4848
== Prerequisites
@@ -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
@@ -87,7 +86,7 @@ $ echo "Cluster: ${ROSA_CLUSTER_NAME}, Region: ${REGION}, OIDC Endpoint: ${OIDC_
8786
This section only applies to clusters that were deployed into existing VPCs. If you did not deploy your cluster into an existing VPC, skip this section and proceed to the installation section below.
8887
====
8988

90-
. Set the below variables to the proper values for your ROSA deployment:
89+
. Set the below variables to the proper values for your cluster deployment:
9190
+
9291
[source,terminal]
9392
----
@@ -131,7 +130,7 @@ $ aws ec2 create-tags \
131130
+
132131
[NOTE]
133132
====
134-
The policy is sourced from link:https://raw.githubusercontent.com/kubernetes-sigs/aws-load-balancer-controller/v2.4.4/docs/install/iam_policy.json[the upstream AWS Load Balancer Controller policy] plus permission to create tags on subnets. This is required by the operator to function.
133+
The policy is sourced from link:https://raw.githubusercontent.com/kubernetes-sigs/aws-load-balancer-controller/v2.4.4/docs/install/iam_policy.json[the upstream AWS Load Balancer Controller policy] plus permission to create tags on subnets. This is required by the Operator to function.
135134
====
136135
+
137136
[source,terminal]
@@ -235,7 +234,7 @@ spec:
235234
EOF
236235
----
237236
+
238-
. Deploy an instance of the AWS Load Balancer Controller using the operator:
237+
. Deploy an instance of the AWS Load Balancer Controller using the Operator:
239238
+
240239
[NOTE]
241240
====
@@ -255,7 +254,7 @@ spec:
255254
EOF
256255
----
257256
+
258-
. Check the that the operator and controller pods are both running:
257+
. Check the that the Operator and controller pods are both running:
259258
+
260259
[source,terminal]
261260
----

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

0 commit comments

Comments
 (0)