Skip to content

Commit e071753

Browse files
committed
Repaired the links in Introduction to ROSA book
1 parent 0599ec9 commit e071753

11 files changed

+135
-160
lines changed

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,8 @@ Name: Install ROSA with HCP clusters
178178
Dir: rosa_hcp
179179
Distros: openshift-rosa-hcp
180180
Topics:
181+
- Name: ROSA with HCP quick start guide
182+
File: rosa-hcp-quickstart-guide
181183
- Name: Creating ROSA with HCP clusters using the default options
182184
File: rosa-hcp-sts-creating-a-cluster-quickly
183185
- Name: Creating ROSA with HCP clusters using a custom AWS KMS encryption key

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,12 @@ toc::[]
1313

1414
. A Provisioned ROSA cluster
1515
+
16-
This lab assumes you have access to a successfully provisioned a ROSA cluster. If you have not yet created a ROSA cluster, see
1716
ifdef::openshift-rosa-hcp[]
18-
link:https://docs.openshift.com/rosa/rosa_getting_started/rosa-quickstart-guide-ui.html#rosa-getting-started-prerequisites_rosa-quickstart-guide-ui[Red{nbsp}Hat OpenShift Service on AWS quick start guide] for more information.
19-
endif::openshift-rosa-hcp[]
20-
ifndef::openshift-rosa-hcp[]
21-
xref:../../rosa_getting_started/rosa-quickstart-guide-ui.adoc#rosa-getting-started-prerequisites_rosa-quickstart-guide-ui[Red{nbsp}Hat OpenShift Service on AWS 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 with HCP quick start guide] for more information.
2218
endif::openshift-rosa-hcp[]
19+
ifdef::openshift-rosa[]
20+
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.
21+
endif::openshift-rosa[]
2322

2423
. The OpenShift Command Line Interface (CLI)
2524
+
@@ -34,3 +33,7 @@ endif::openshift-rosa-hcp[]
3433
. A GitHub Account
3534
+
3635
Use your existing GitHub account or register at link:https://github.com/signup[https://github.com/signup].
36+
37+
include::modules/rosa-sts-understanding-aws-account-association.adoc[leveloffset=+2]
38+
[discrete]
39+
include::modules/rosa-sts-associating-your-aws-account.adoc[leveloffset=+2]

modules/rosa-getting-started-deleting-a-cluster.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,12 @@ ifeval::["{context}" == "rosa-quickstart"]
1414
:quickstart:
1515
endif::[]
1616

17+
ifdef::openshift-rosa-hcp[]
18+
You can delete a ROSA cluster by using the {product-title} (ROSA) CLI, `rosa`. You can also use the ROSA CLI to delete the AWS Identity and Access Management (IAM) account-wide roles, the cluster-specific Operator roles, and the OpenID Connect (OIDC) provider. To delete the account-wide inline and Operator policies, you can use the AWS IAM Console.
19+
endif::openshift-rosa-hcp[]
20+
ifndef::openshift-rosa-hcp[]
1721
You can delete a ROSA cluster that uses the AWS Security Token Service (STS) by using the {product-title} (ROSA) CLI, `rosa`. You can also use the ROSA CLI to delete the AWS Identity and Access Management (IAM) account-wide roles, the cluster-specific Operator roles, and the OpenID Connect (OIDC) provider. To delete the account-wide inline and Operator policies, you can use the AWS IAM Console.
22+
endif::openshift-rosa-hcp[]
1823

1924
[IMPORTANT]
2025
====
@@ -77,7 +82,13 @@ $ rosa delete account-roles --prefix <prefix> --mode auto <1>
7782
----
7883
<1> You must include the `--<prefix>` argument. Replace `<prefix>` with the prefix of the account-wide roles to delete. If you did not specify a custom prefix when you created the account-wide roles, specify the default prefix, `ManagedOpenShift`.
7984

85+
ifdef::openshift-rosa-hcp[]
86+
. Delete the account-wide inline and Operator IAM policies that you created for ROSA deployments:
87+
endif::openshift-rosa-hcp[]
88+
ifndef::openshift-rosa-hcp[]
8089
. Delete the account-wide inline and Operator IAM policies that you created for ROSA deployments that use STS:
90+
endif::openshift-rosa-hcp[]
91+
+
8192
.. Log in to the link:https://console.aws.amazon.com/iamv2/home#/home[AWS IAM Console].
8293
.. Navigate to *Access management* -> *Policies* and select the checkbox for one of the account-wide policies.
8394
.. With the policy selected, click on *Actions* -> *Delete* to open the delete policy dialog.

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

Lines changed: 28 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@
44
// * rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc
55
// * rosa_getting_started/rosa-quickstart-guide-ui.adoc
66

7-
ifeval::["{context}" == "rosa-hcp-sts-creating-a-cluster-quickly"]
8-
:rosa-hcp:
9-
endif::[]
10-
ifeval::["{context}" == "rosa-sts-creating-a-cluster-quickly"]
11-
:rosa-classic:
12-
endif::[]
137
ifeval::["{context}" == "rosa-classic-creating-a-cluster-quickly-terraform"]
148
:tf-classic:
159
endif::[]
@@ -23,21 +17,21 @@ endif::[]
2317

2418
ifndef::tf-classic,tf-hcp[]
2519
You can quickly create a
26-
ifdef::rosa-hcp[]
27-
{hcp-title}
28-
endif::rosa-hcp[]
29-
ifndef::rosa-hcp[]
30-
{product-title} (ROSA)
31-
endif::rosa-hcp[]
32-
cluster with the {sts-first} by using the default installation options. The following summary describes the default cluster specifications.
20+
ifdef::openshift-rosa-hcp[]
21+
{product-title} cluster by using the default installation options.
22+
endif::openshift-rosa-hcp[]
23+
ifdef::openshift-rosa[]
24+
{product-title} (ROSA) cluster with the {sts-first} by using the default installation options.
25+
endif::openshift-rosa[]
26+
The following summary describes the default cluster specifications.
3327
endif::tf-classic,tf-hcp[]
3428

35-
ifdef::rosa-hcp[]
36-
.Default {hcp-title} cluster specifications
37-
endif::rosa-hcp[]
38-
ifdef::rosa-classic[]
29+
ifdef::openshift-rosa-hcp[]
30+
.Default {product-title} cluster specifications
31+
endif::openshift-rosa-hcp[]
32+
ifdef::openshift-rosa[]
3933
.Default ROSA with STS cluster specifications
40-
endif::rosa-classic[]
34+
endif::openshift-rosa[]
4135

4236
[cols=".^1,.^3a",options="header"]
4337
|===
@@ -66,13 +60,13 @@ ifdef::tf-classic,tf-hcp[]
6660
endif::tf-classic,tf-hcp[]
6761
ifndef::tf-classic,tf-hcp[]
6862
* Default cluster version: Latest
69-
ifndef::rosa-hcp[]
63+
ifdef::openshift-rosa[]
7064
* Default AWS region for installations using the {cluster-manager-first} {hybrid-console-second}: us-east-1 (US East, North Virginia)
71-
endif::rosa-hcp[]
72-
ifdef::rosa-hcp[]
65+
endif::openshift-rosa[]
66+
ifdef::openshift-rosa-hcp[]
7367
* Default AWS region for installations using the ROSA CLI (`rosa`): Defined by your `aws` CLI configuration
7468
* Default EC2 IMDS endpoints (both v1 and v2) are enabled
75-
endif::rosa-hcp[]
69+
endif::openshift-rosa-hcp[]
7670
* Availability: Single zone for the data plane
7771
endif::tf-classic,tf-hcp[]
7872
ifndef::rosa-hcp,tf-hcp[]
@@ -83,22 +77,22 @@ endif::rosa-hcp,tf-hcp[]
8377
|Encryption
8478
|* Cloud storage is encrypted at rest
8579
* Additional etcd encryption is not enabled
86-
ifndef::rosa-hcp,tf-hcp[]
80+
ifdef::openshift-rosa,tf-classic[]
8781
* The default AWS Key Management Service (KMS) key is used as the encryption key for persistent data
88-
endif::rosa-hcp,tf-hcp[]
89-
ifdef::rosa-hcp,tf-hcp[]
90-
* AWS Key Management Service (KMS) key encryption is not enabled by default.
91-
endif::rosa-hcp,tf-hcp[]
82+
endif::openshift-rosa,tf-classic[]
83+
ifdef::openshift-rosa-hcp,tf-hcp[]
84+
* AWS Key Management Service (KMS) key encryption is not enabled by default
85+
endif::openshift-rosa-hcp,tf-hcp[]
9286

93-
ifndef::rosa-hcp,tf-hcp[]
87+
ifdef::openshift-rosa,tf-classic[]
9488
|Control plane node configuration
9589
|* Control plane node instance type: m5.2xlarge (8 vCPU, 32 GiB RAM)
9690
* Control plane node count: 3
9791

9892
|Infrastructure node configuration
9993
|* Infrastructure node instance type: r5.xlarge (4 vCPU, 32 GiB RAM)
10094
* Infrastructure node count: 2
101-
endif::rosa-hcp,tf-hcp[]
95+
endif::openshift-rosa,tf-classic[]
10296

10397
|Compute node machine pool
10498
|* Compute node instance type: m5.xlarge (4 vCPU 16, GiB RAM)
@@ -120,9 +114,9 @@ ifdef::tf-classic,tf-hcp[]
120114
* Cluster privacy: public or private
121115
* You can choose to create a new VPC during the Terraform cluster creation process.
122116
endif::tf-classic,tf-hcp[]
123-
ifdef::rosa-hcp[]
117+
ifdef::openshift-rosa[]
124118
* You must have configured your own Virtual Private Cloud (VPC)
125-
endif::rosa-hcp[]
119+
endif::openshift-rosa[]
126120
* No cluster-wide proxy is configured
127121

128122
|Classless Inter-Domain Routing (CIDR) ranges
@@ -139,12 +133,12 @@ ifndef::tf-classic,tf-hcp[]
139133
endif::tf-classic,tf-hcp[]
140134
* Host prefix: /23
141135
+
142-
ifdef::rosa-hcp[]
136+
ifdef::openshift-rosa-hcp[]
143137
[NOTE]
144138
====
145-
When using {hcp-title}, the static IP address `172.20.0.1` is reserved for the internal Kubernetes API address. The machine, pod, and service CIDRs ranges must not conflict with this IP address.
139+
The static IP address `172.20.0.1` is reserved for the internal Kubernetes API address. The machine, pod, and service CIDRs ranges must not conflict with this IP address.
146140
====
147-
endif::rosa-hcp[]
141+
endif::openshift-rosa-hcp[]
148142

149143
|Cluster roles and policies
150144
|* Mode used to create the Operator roles and the OpenID Connect (OIDC) provider: `auto`
@@ -166,12 +160,6 @@ endif::tf-classic,tf-hcp[]
166160

167161
|===
168162

169-
ifeval::["{context}" == "rosa-hcp-sts-creating-a-cluster-quickly"]
170-
:!rosa-hcp:
171-
endif::[]
172-
ifeval::["{context}" == "rosa-sts-creating-a-cluster-quickly"]
173-
:!rosa-classic:
174-
endif::[]
175163
ifeval::["{context}" == "rosa-classic-creating-a-cluster-quickly-terraform"]
176164
:!tf-classic:
177165
endif::[]

nodes/index.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ image::295_OpenShift_Nodes_Overview_1222.png[Overview of control plane and worke
3434

3535
The read operations allow an administrator or a developer to get information about nodes in an {product-title} cluster.
3636

37-
ifndef::openshift-rosa-hcp,openshift-rosa[]
37+
ifndef::openshift-enterprise,openshift-rosa-hcp,openshift-rosa[]
3838
* xref:../nodes/nodes/nodes-nodes-viewing.adoc#nodes-nodes-viewing-listing_nodes-nodes-viewing[List all the nodes in a cluster].
3939
* Get information about a node, such as memory and CPU usage, health, status, and age.
4040
* xref:../nodes/nodes/nodes-nodes-viewing.adoc#nodes-nodes-viewing-listing-pods_nodes-nodes-viewing[List pods running on a node].
41-
endif::openshift-rosa-hcp,openshift-rosa[]
41+
endif::openshift-enterprise,openshift-rosa-hcp,openshift-rosa[]
4242

43-
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
43+
ifndef::openshift-enterprise,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
4444
[discrete]
4545
=== Management operations
4646

@@ -54,24 +54,24 @@ through several tasks:
5454
* xref:../nodes/nodes/nodes-nodes-managing-max-pods.adoc#nodes-nodes-managing-max-pods-proc_nodes-nodes-managing-max-pods[Configure the number of pods that can run on a node] based on the number of processor cores on the node, a hard limit, or both.
5555
* Reboot a node gracefully using xref:../nodes/nodes/nodes-nodes-rebooting.adoc#nodes-nodes-rebooting-affinity_nodes-nodes-rebooting[pod anti-affinity].
5656
* xref:../nodes/nodes/nodes-nodes-working.adoc#deleting-nodes[Delete a node from a cluster] by scaling down the cluster using a compute machine set. To delete a node from a bare-metal cluster, you must first drain all pods on the node and then manually delete the node.
57-
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
57+
endif::openshift-enterprise,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
5858

5959
[discrete]
6060
=== Enhancement operations
6161

6262
{product-title} allows you to do more than just access and manage nodes; as an administrator, you can perform the following tasks on nodes to make the cluster more efficient, application-friendly, and to provide a better environment for your developers.
6363

6464
* Manage node-level tuning for high-performance applications that require some level of kernel tuning by
65-
ifndef::openshift-rosa-hcp,openshift-rosa[]
65+
ifndef::openshift-enterprise,openshift-rosa-hcp,openshift-rosa[]
6666
xref:../nodes/nodes/nodes-node-tuning-operator.adoc#nodes-node-tuning-operator[using the Node Tuning Operator].
6767
* xref:../nodes/jobs/nodes-pods-daemonsets.adoc#nodes-pods-daemonsets[Run background tasks on nodes automatically with daemon sets]. You can create and use daemon sets to create shared storage, run a logging pod on every node, or deploy a monitoring agent on all nodes.
68-
endif::openshift-rosa-hcp,openshift-rosa[]
69-
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
68+
endif::openshift-enterprise,openshift-rosa-hcp,openshift-rosa[]
69+
ifndef::openshift-enterprise,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
7070
* Enable TLS security profiles on the node to protect communication between the kubelet and the Kubernetes API server.
7171
* xref:../nodes/nodes/nodes-nodes-garbage-collection.adoc#nodes-nodes-garbage-collection[Free node resources using garbage collection]. You can ensure that your nodes are running efficiently by removing terminated containers and the images not referenced by any running pods.
7272
* xref:../nodes/nodes/nodes-nodes-managing.adoc#nodes-nodes-kernel-arguments_nodes-nodes-managing[Add kernel arguments to a set of nodes].
7373
* Configure an {product-title} cluster to have worker nodes at the network edge (remote worker nodes). For information on the challenges of having remote worker nodes in an {product-title} cluster and some recommended approaches for managing pods on a remote worker node, see xref:../nodes/edge/nodes-edge-remote-workers.adoc#nodes-edge-remote-workers[Using remote worker nodes at the network edge].
74-
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
74+
endif::openshift-enterprise,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
7575
ifdef::openshift-rosa-hcp,openshift-rosa[]
7676
* link:https://docs.openshift.com/rosa/nodes/jobs/nodes-pods-daemonsets.html#nodes-pods-daemonsets[Run background tasks on nodes automatically with daemon sets]. You can create and use daemon sets to create shared storage, run a logging pod on every node, or deploy a monitoring agent on all nodes.
7777
endif::openshift-rosa-hcp,openshift-rosa[]

0 commit comments

Comments
 (0)