Skip to content

Commit 8d6994f

Browse files
authored
Merge pull request #68683 from EricPonvelle/OSDOCS-6139-2_HCP-GA-Updates
OSDOCS-6139.2: Updating ROSA with HCP docs for GA
2 parents 2c69494 + e1c6555 commit 8d6994f

21 files changed

+490
-60
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ Topics:
6565
File: rosa-service-definition
6666
- Name: ROSA update life cycle
6767
File: rosa-life-cycle
68+
- Name: ROSA with HCP service definition
69+
File: rosa-hcp-service-definition
70+
- Name: ROSA with HCP update life cycle
71+
File: rosa-hcp-life-cycle
6872
- Name: Understanding security for ROSA
6973
File: rosa-policy-process-security
7074
- Name: SRE and service account access
@@ -271,6 +275,8 @@ Topics:
271275
# File: troubleshooting-installations
272276
- Name: Troubleshooting ROSA installations
273277
File: rosa-troubleshooting-installations
278+
- Name: Troubleshooting networking
279+
File: rosa-troubleshooting-networking
274280
- Name: Verifying node health
275281
File: verifying-node-health
276282
# cannot create resource "namespaces", cannot patch resource "nodes"

modules/custom-tuning-specification.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ The list items `match` and `machineConfigLabels` are connected by the logical OR
191191
When using machine config pool based matching, it is advised to group nodes with the same hardware configuration into the same machine config pool. Not following this practice might result in TuneD operands calculating conflicting kernel parameters for two or more nodes sharing the same machine config pool.
192192
====
193193

194-
.Example: node or pod label based matching
194+
.Example: Node or pod label based matching
195195

196196
ifndef::rosa-hcp-tuning[]
197197
[source,yaml]
@@ -263,7 +263,7 @@ Finally, the profile `openshift-node` has the lowest priority of `30`. It lacks
263263

264264
image::node-tuning-operator-workflow-revised.png[Decision workflow]
265265

266-
.Example: machine config pool based matching
266+
.Example: Machine config pool based matching
267267
ifndef::rosa-hcp-tuning[]
268268
[source,yaml]
269269
----

modules/life-cycle-dates.adoc

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,33 @@
11
// Module included in the following assemblies:
22
//
3-
// * osd_architecture/osd_policy/osd-life-cycle.adoc
43
// * rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc
4+
// * rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc
5+
// * osd_architecture/osd_policy/osd-life-cycle.adoc
6+
7+
ifeval::["{context}" == "rosa-hcp-life-cycle"]
8+
:rosa-with-hcp:
9+
endif::[]
510

611
[id="sd-life-cycle-dates_{context}"]
712
= Life cycle dates
813

914
[options="header"]
1015
|===
1116
|Version |General availability |End of life
17+
ifdef::rosa-with-hcp[]
18+
|4.14 |Dec 4, 2023 |Feb 28, 2025
19+
endif::rosa-with-hcp[]
20+
ifndef::rosa-with-hcp[]
1221
|4.14 |Oct 31, 2023 |Feb 28, 2025
1322
|4.13 |May 17, 2023 |Sep 17, 2024
1423
|4.12 |Jan 17, 2023 |May 17, 2024
1524
|4.11 |Aug 10, 2022 |Dec 10, 2023
1625
|4.10 |Mar 10, 2022 |Sep 10, 2023
1726
|4.9 |Oct 18, 2021 |Dec 18, 2022
1827
|4.8 |Jul 27, 2021 |Sep 27, 2022
19-
28+
endif::rosa-with-hcp[]
2029
|===
30+
31+
ifeval::["{context}" == "rosa-hcp-life-cycle"]
32+
:!rosa-with-hcp:
33+
endif::[]
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,30 @@
11
// Module included in the following assemblies:
22
//
33
// * rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc
4+
// * rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc
45
// * osd_architecture/osd_policy/osd-life-cycle.adoc
56

7+
ifeval::["{context}" == "rosa-hcp-life-cycle"]
8+
:rosa-with-hcp:
9+
endif::[]
10+
611
[id="rosa-limited-support_{context}"]
712
= Limited support status
813

914
When a cluster transitions to a _Limited Support_ status, Red Hat no longer proactively monitors the cluster, the SLA is no longer applicable, and credits requested against the SLA are denied. It does not mean that you no longer have product support. In some cases, the cluster can return to a fully-supported status if you remediate the violating factors. However, in other cases, you might have to delete and recreate the cluster.
1015

1116
A cluster might transition to a Limited Support status for many reasons, including the following scenarios:
1217

18+
ifndef::rosa-with-hcp[]
1319
If you do not upgrade a cluster to a supported version before the end-of-life date:: Red Hat does not make any runtime or SLA guarantees for versions after their end-of-life date. To receive continued support, upgrade the cluster to a supported version prior to the end-of-life date. If you do not upgrade the cluster prior to the end-of-life date, the cluster transitions to a Limited Support status until it is upgraded to a supported version.
1420
+
1521
Red Hat provides commercially reasonable support to upgrade from an unsupported version to a supported version. However, if a supported upgrade path is no longer available, you might have to create a new cluster and migrate your workloads.
22+
endif::rosa-with-hcp[]
1623

1724
If you remove or replace any native {product-title} components or any other component that is installed and managed by Red Hat:: If cluster administrator permissions were used, Red Hat is not responsible for any of your or your authorized users’ actions, including those that affect infrastructure services, service availability, or data loss. If Red Hat detects any such actions, the cluster might transition to a Limited Support status. Red Hat notifies you of the status change and you should either revert the action or create a support case to explore remediation steps that might require you to delete and recreate the cluster.
1825

1926
If you have questions about a specific action that might cause a cluster to transition to a Limited Support status or need further assistance, open a support ticket.
27+
28+
ifeval::["{context}" == "rosa-hcp-life-cycle"]
29+
:!rosa-with-hcp:
30+
endif::[]
Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,27 @@
11
// Module included in the following assemblies:
22
// * rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc
34
// * osd_architecture/osd_policy/osd-life-cycle.adoc
45

6+
ifeval::["{context}" == "rosa-hcp-life-cycle"]
7+
:rosa-with-hcp:
8+
endif::[]
9+
510
:_mod-docs-content-type: REFERENCE
611
[id="rosa-mandatory-upgrades_{context}"]
712
= Mandatory upgrades
813

9-
In the event that a Critical or Important CVE, or other bug identified by Red Hat, significantly
10-
impacts the security or stability of the cluster, the customer must upgrade to the next supported
11-
patch release within two link:https://access.redhat.com/articles/2623321[business days].
14+
If a critical or important CVE, or other bug identified by Red Hat, significantly impacts the security or stability of the cluster, the customer must upgrade to the next supported patch release within two link:https://access.redhat.com/articles/2623321[business days].
15+
16+
In extreme circumstances and based on Red Hat's assessment of the CVE criticality to the environment, Red Hat will notify customers that they have two link:https://access.redhat.com/articles/2623321[business days] to schedule or manually update their cluster to the latest, secure patch release. In the case that an update is not performed after two link:https://access.redhat.com/articles/2623321[business days], Red Hat will automatically update the
17+
ifdef::rosa-with-hcp[]
18+
cluster's control plane
19+
endif::rosa-with-hcp[]
20+
ifndef::rosa-with-hcp[]
21+
cluster
22+
endif::rosa-with-hcp[]
23+
to the latest, secure patch release to mitigate potential security breach(es) or instability. Red Hat might, at its own discretion, temporarily delay an automated update if requested by a customer through a link:https://access.redhat.com/support[support case].
1224

13-
In extreme circumstances and based on Red Hat's assessment of the CVE criticality to the
14-
environment, Red Hat will notify customers that they have two link:https://access.redhat.com/articles/2623321[business days] to schedule or manually update their cluster to the latest, secure patch release.
15-
In the case that an update is not performed after two link:https://access.redhat.com/articles/2623321[business days], Red Hat will automatically update the cluster to the latest, secure patch release to mitigate potential security breach(es) or instability. Red Hat may, at its own discretion, temporarily delay an automated update if requested by a customer through a link:https://access.redhat.com/support[support case].
25+
ifeval::["{context}" == "rosa-hcp-life-cycle"]
26+
:!rosa-with-hcp:
27+
endif::[]
Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,36 @@
11
// Module included in the following assemblies:
22
// * rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc
3+
// * rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc
34
// * osd_architecture/osd_policy/osd-life-cycle.adoc
45

6+
ifeval::["{context}" == "rosa-hcp-life-cycle"]
7+
:rosa-with-hcp:
8+
endif::[]
9+
510
[id="rosa-minor-versions_{context}"]
611
= Minor versions (x.Y.z)
712

8-
Starting with the 4.8 OpenShift Container Platform minor version, Red Hat supports all minor
9-
versions for at least a 16 month period following general availability of the given minor version. Patch
10-
versions are not affected by the support period.
13+
Starting with the 4.8 OpenShift Container Platform minor version, Red Hat supports all minor versions for at least a 16 month period following general availability of the given minor version. Patch versions are not affected by the support period.
1114

12-
Customers are notified 60, 30, and 15 days prior to the end of the support period. Clusters must be upgraded to
13-
a supported minor version prior to the end of the support period, or the cluster will enter
14-
a "Limited Support" status.
15+
Customers are notified 60, 30, and 15 days before the end of the support period. Clusters must be upgraded to the latest patch version of the oldest supported minor version before the end of the support period, or
16+
ifdef::rosa-with-hcp[]
17+
Red Hat will automatically upgrade the control plane to the next supported minor version.
18+
endif::rosa-with-hcp[]
19+
ifndef::rosa-with-hcp[]
20+
the cluster will enter a "Limited Support" status.
21+
endif::rosa-with-hcp[]
1522

1623
.Example
17-
. A customer's cluster is currently running on 4.13.8. The 4.13 minor version became generally
18-
available on May 17, 2023.
19-
. On July 19, August 16, and September 2, 2024, the customer is notified that their cluster will enter "Limited Support" status
20-
on September 17, 2024 if the cluster has not already been upgraded to a supported minor version.
24+
. A customer's cluster is currently running on 4.13.8. The 4.13 minor version became generally available on May 17, 2023.
25+
. On July 19, August 16, and September 2, 2024, the customer is notified that their cluster will enter "Limited Support" status on September 17, 2024 if the cluster has not already been upgraded to a supported minor version.
2126
. The cluster must be upgraded to 4.14 or later by September 17, 2024.
22-
. If the upgrade has not been performed, the cluster will be flagged as being in a "Limited Support" status.
27+
ifdef::rosa-with-hcp[]
28+
. If the upgrade has not been performed, the cluster's control plane will be automatically upgraded to 4.14.26, and there will be no automatic upgrades to the cluster's worker nodes.
29+
endif::rosa-with-hcp[]
30+
ifndef::rosa-with-hcp[]
31+
. If the upgrade has not been performed, the cluster will be flagged as being in a "Limited Support" status.
32+
endif::rosa-with-hcp[]
33+
34+
ifeval::["{context}" == "rosa-hcp-life-cycle"]
35+
:!rosa-with-hcp:
36+
endif::[]

modules/rosa-sdpolicy-am-compute.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,28 @@
22
// Module included in the following assemblies:
33
//
44
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
5+
// * rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc
6+
7+
ifeval::["{context}" == "rosa-hcp-service-definition"]
8+
:rosa-with-hcp:
9+
endif::[]
10+
511
:_mod-docs-content-type: CONCEPT
612
[id="rosa-sdpolicy-instance-types_{context}"]
713
= Instance types
814

15+
ifdef::rosa-with-hcp[]
16+
All {hcp-title} clusters require a minimum of 2 worker nodes. All {hcp-title} clusters support a maximum of 51 worker nodes. Shutting down the underlying infrastructure through the cloud provider console is unsupported and can lead to data loss.
17+
endif::rosa-with-hcp[]
18+
ifndef::rosa-with-hcp[]
919
Single availability zone clusters require a minimum of 3 control plane nodes, 2 infrastructure nodes, and 2 worker nodes deployed to a single availability zone.
1020

1121
Multiple availability zone clusters require a minimum of 3 control plane nodes, 3 infrastructure nodes, and 3 worker nodes. Additional nodes must be purchased in multiples of three to maintain proper node distribution.
1222

1323
All {product-title} clusters support a maximum of 180 worker nodes.
1424

1525
Control plane and infrastructure nodes are deployed and managed by Red Hat. Shutting down the underlying infrastructure through the cloud provider console is unsupported and can lead to data loss. There are at least 3 control plane nodes that handle etcd- and API-related workloads. There are at least 2 infrastructure nodes that handle metrics, routing, the web console, and other workloads. You must not run any workloads on the control and infrastructure nodes. Any workloads you intend to run must be deployed on worker nodes. See the Red Hat Operator support section below for more information about Red Hat workloads that must be deployed on worker nodes.
26+
endif::rosa-with-hcp[]
1627

1728
[NOTE]
1829
====
@@ -22,3 +33,7 @@ Approximately one vCPU core and 1 GiB of memory are reserved on each worker node
2233
2334
For additional information, see the link:https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#system-reserved[Kubernetes documentation].
2435
====
36+
37+
ifeval::["{context}" == "rosa-hcp-service-definition"]
38+
:!rosa-with-hcp:
39+
endif::[]

modules/rosa-sdpolicy-am-limited-support.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
// Module included in the following assemblies:
33
//
44
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
5+
// * rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc
6+
7+
ifeval::["{context}" == "rosa-hcp-service-definition"]
8+
:rosa-with-hcp:
9+
endif::[]
10+
511
:_mod-docs-content-type: CONCEPT
612
[id="rosa-limited-support_{context}"]
713
= Limited support status
@@ -10,10 +16,15 @@ When a cluster transitions to a _Limited Support_ status, Red Hat no longer proa
1016

1117
A cluster might move to a Limited Support status for many reasons, including the following scenarios:
1218

19+
ifndef::rosa-with-hcp[]
1320
If you do not upgrade a cluster to a supported version before the end-of-life date:: Red Hat does not make any runtime or SLA guarantees for versions after their end-of-life date. To receive continued support, upgrade the cluster to a supported version prior to the end-of-life date. If you do not upgrade the cluster prior to the end-of-life date, the cluster transitions to a Limited Support status until it is upgraded to a supported version.
1421
+
1522
Red Hat provides commercially reasonable support to upgrade from an unsupported version to a supported version. However, if a supported upgrade path is no longer available, you might have to create a new cluster and migrate your workloads.
1623

24+
endif::rosa-with-hcp[]
1725
If you remove or replace any native {product-title} components or any other component that is installed and managed by Red Hat:: If cluster administrator permissions were used, Red Hat is not responsible for any of your or your authorized users’ actions, including those that affect infrastructure services, service availability, or data loss. If Red Hat detects any such actions, the cluster might transition to a Limited Support status. Red Hat notifies you of the status change and you should either revert the action or create a support case to explore remediation steps that might require you to delete and recreate the cluster.
1826

19-
If you have questions about a specific action that might cause a cluster to move to a Limited Support status or need further assistance, open a support ticket.
27+
If you have questions about a specific action that might cause a cluster to move to a Limited Support status or need further assistance, open a support ticket.
28+
ifeval::["{context}" == "rosa-hcp-service-definition"]
29+
:!rosa-with-hcp:
30+
endif::[]
Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,27 @@
11

22
// Module included in the following assemblies:
33
//
4-
// * assemblies/rosa-service-definition.adoc
4+
// * rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc
5+
// * rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc
6+
57
:_mod-docs-content-type: CONCEPT
8+
9+
ifeval::["{context}" == "rosa-hcp-service-definition"]
10+
:rosa-with-hcp:
11+
endif::[]
12+
613
[id="rosa-sdpolicy-am-local-zones_{context}"]
714
= Local Zones
815

16+
ifdef::rosa-with-hcp[]
17+
{hcp-title-first} does not support the use of AWS Local Zones.
18+
endif::rosa-with-hcp[]
19+
ifndef::rosa-with-hcp[]
920
{product-title} supports the use of AWS Local Zones, which are metropolis-centralized availability zones where customers can place latency-sensitive application workloads. Local Zones are extensions of AWS Regions that have their own internet connection. For more information about AWS Local Zones, see the AWS documentation link:https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html[How Local Zones work].
1021

11-
For steps to enable AWS Local Zones and add a Local Zone to a machine pool, see xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-configuring.adoc#rosa-nodes-machine-pools-local-zones[Configuring Local Zones for machine pulls].
22+
For steps to enable AWS Local Zones and add a Local Zone to a machine pool, see xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-configuring.adoc#rosa-nodes-machine-pools-local-zones[Configuring Local Zones for machine pulls].
23+
endif::rosa-with-hcp[]
24+
25+
ifeval::["{context}" == "rosa-hcp-service-definition"]
26+
:!rosa-with-hcp:
27+
endif::[]

0 commit comments

Comments
 (0)