Skip to content

Commit 485f36f

Browse files
jab-rhjab-rh
authored
Merge pull request #74581 from xenolinux/move-managing-hcp-sections
OSDOCS#10240: Restructuring the Managing hosted control planes section
2 parents fddb3d7 + 53a863d commit 485f36f

13 files changed

+67
-55
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2318,6 +2318,10 @@ Topics:
23182318
File: hcp-managing
23192319
- Name: Using feature gates in a hosted cluster
23202320
File: hcp-using-feature-gates
2321+
- Name: Updating hosted control planes
2322+
File: hcp-updating
2323+
- Name: Hosted control planes Observability
2324+
File: hcp-observability
23212325
- Name: Backup, restore, and disaster recovery for hosted control planes
23222326
File: hcp-backup-restore-dr
23232327
- Name: Troubleshooting hosted control planes

‎hosted_control_planes/hcp-managing.adoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,6 @@ toc::[]
88

99
After you configure your environment for hosted control planes and create a hosted cluster, you can further manage your clusters and nodes.
1010

11-
include::modules/updates-for-hosted-control-planes.adoc[leveloffset=+1]
12-
include::modules/updating-node-pools-for-hcp.adoc[leveloffset=+1]
13-
//restarting hosted control plane components
14-
include::modules/hosted-control-planes-pause-reconciliation.adoc[leveloffset=+1]
15-
//using service-level DNS for control plane services
16-
include::modules/hosted-control-planes-metrics-sets.adoc[leveloffset=+1]
17-
include::modules/hosted-control-planes-monitoring-dashboard.adoc[leveloffset=+1]
1811
//automated machine management
1912
include::modules/scale-down-data-plane.adoc[leveloffset=+1]
2013
include::modules/delete-hosted-cluster.adoc[leveloffset=+1]

‎hosted_control_planes/hcp-observability.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="hcp-observability"]
3+
= Hosted control planes Observability
4+
include::_attributes/common-attributes.adoc[]
5+
:context: hcp-observability
6+
7+
toc::[]
8+
9+
You can gather metrics for hosted control planes by configuring metrics sets. The HyperShift Operator can create or delete monitoring dashboards in the management cluster for each hosted cluster that it manages.
10+
11+
//using service-level DNS for control plane services
12+
include::modules/hosted-control-planes-metrics-sets.adoc[leveloffset=+1]
13+
include::modules/hosted-control-planes-monitoring-dashboard.adoc[leveloffset=+1]

‎hosted_control_planes/hcp-troubleshooting.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ If you encounter issues with hosted control planes, see the following informatio
1010

1111
include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1]
1212

13+
//restarting hosted control plane components
14+
include::modules/hosted-control-planes-pause-reconciliation.adoc[leveloffset=+1]
15+
1316
[role="_additional-resources"]
1417
.Additional resources
1518

‎hosted_control_planes/hcp-updating.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="hcp-updating"]
3+
= Updating hosted control planes
4+
include::_attributes/common-attributes.adoc[]
5+
:context: hcp-updating
6+
7+
toc::[]
8+
9+
Updates for hosted control planes involve updating the hosted cluster and the node pools. For a cluster to remain fully operational during an update process, you must meet the requirements of the link:https://kubernetes.io/releases/version-skew-policy/[Kubernetes version skew policy] while completing the control plane and node updates.
10+
11+
// Updates for the hosted cluster
12+
include::modules/hcp-updates-hosted-cluster.adoc[leveloffset=+1]
13+
14+
// Updates for node pools
15+
include::modules/hcp-updates-node-pools.adoc[leveloffset=+1]
16+
17+
// Updating node pools for hosted control planes
18+
include::modules/updating-node-pools-for-hcp.adoc[leveloffset=+1]

‎modules/configuring-node-pools-for-hcp.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
// Module included in the following assemblies:
22
//
33
// * updates/updating_a_cluster/updating-hosted-control-planes.adoc
4-
// * hosted_control_planes/hcp-managing.adoc
54

65
:_mod-docs-content-type: PROCEDURE
76
[id="configuring-node-pools-for-hcp_{context}"]
@@ -58,7 +57,3 @@ spec:
5857
//.Verification
5958

6059
// Does the user need to do anything to verify that the procedure was successful?
61-
62-
63-
64-

‎modules/hcp-updates-hosted-cluster.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * updates/updating_a_cluster/updating-hosted-control-planes.adoc
4+
// * hosted_control_planes/hcp-updating.adoc
5+
6+
:_mod-docs-content-type: CONCEPT
7+
[id="hcp-updates-hosted-cluster_{context}"]
8+
= Updates for the hosted cluster
9+
10+
The `spec.release` value dictates the version of the control plane. The `HostedCluster` object transmits the intended `spec.release` value to the `HostedControlPlane.spec.release` value and runs the appropriate Control Plane Operator version.
11+
12+
The hosted control plane manages the rollout of the new version of the control plane components along with any {product-title} components through the new version of the Cluster Version Operator (CVO).

‎modules/updates-for-hosted-control-planes.adoc renamed to ‎modules/hcp-updates-node-pools.adoc

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,11 @@
11
// Module included in the following assemblies:
22
//
33
// * updates/updating_a_cluster/updating-hosted-control-planes.adoc
4-
// * hosted_control_planes/hcp-managing.adoc
4+
// * hosted_control_planes/hcp-updating.adoc
55

66
:_mod-docs-content-type: CONCEPT
7-
[id="updates-for-hosted-control-planes_{context}"]
8-
= Updates for hosted control planes
9-
10-
Updates for hosted control planes involve updating the hosted cluster and the node pools. For a cluster to remain fully operational during an update process, you must meet the requirements of the link:https://kubernetes.io/releases/version-skew-policy/[Kubernetes version skew policy] while completing the control plane and node updates.
11-
12-
[id="updates-for-hosted-control-planes-hostedcluster_{context}"]
13-
== Updates for the hosted cluster
14-
15-
The `spec.release` value dictates the version of the control plane. The `HostedCluster` object transmits the intended `spec.release` value to the `HostedControlPlane.spec.release` value and runs the appropriate Control Plane Operator version.
16-
17-
The hosted control plane manages the rollout of the new version of the control plane components along with any {product-title} components through the new version of the Cluster Version Operator (CVO).
18-
19-
[id="updates-for-hosted-control-planes-nodepools_{context}"]
20-
== Updates for node pools
7+
[id="hcp-updates-node-pools_{context}"]
8+
= Updates for node pools
219

2210
With node pools, you can configure the software that is running in the nodes by exposing the `spec.release` and `spec.config` values. You can start a rolling node pool update in the following ways:
2311

@@ -29,15 +17,15 @@ Node pools support replace updates and in-place updates. The `nodepool.spec.rele
2917

3018
After you create a node pool, you cannot change the update type. If you want to change the update type, you must create a node pool and delete the other one.
3119

32-
[id="updates-for-nodepools-replace_{context}"]
33-
=== Replace updates for node pools
20+
[id="hcp-updates-node-pools-replace_{context}"]
21+
== Replace updates for node pools
3422

3523
A _replace_ update creates instances in the new version while it removes old instances from the previous version. This update type is effective in cloud environments where this level of immutability is cost effective.
3624

3725
Replace updates do not preserve any manual changes because the node is entirely re-provisioned.
3826

39-
[id="updates-for-nodepools-inplace_{context}"]
40-
=== In place updates for node pools
27+
[id="hcp-updates-node-pools-inplace_{context}"]
28+
== In place updates for node pools
4129

4230
An _in-place_ update directly updates the operating systems of the instances. This type is suitable for environments where the infrastructure constraints are higher, such as bare metal.
4331

‎modules/hosted-control-planes-metrics-sets.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * hosted_control_planes/hcp-managing.adoc
3+
// * hosted_control_planes/hcp-observability.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="hosted-control-planes-metrics-sets_{context}"]
@@ -123,4 +123,4 @@ cvo:
123123
- action: drop
124124
regex: "etcd_(debugging|disk|server).*"
125125
sourceLabels: ["__name__"]
126-
----
126+
----

‎modules/hosted-control-planes-monitoring-dashboard.adoc

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// * hosted_control_planes/hcp-managing.adoc
3+
// * hosted_control_planes/hcp-observability.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="hosted-control-planes-monitoring-dashboard_{context}"]
7-
= Creating monitoring dashboards for hosted clusters
8-
9-
The HyperShift Operator can create or delete monitoring dashboards in the management cluster for each hosted cluster that it manages.
10-
11-
[#hosted-control-planes-enable-dashboard]
12-
== Enabling monitoring dashboards
7+
= Enabling monitoring dashboards in a hosted cluster
138

149
To enable monitoring dashboards in a hosted cluster, complete the following steps:
1510

@@ -33,6 +28,7 @@ data:
3328
. Wait a couple of minutes for the HyperShift Operator deployment in the `hypershift` namespace to be updated to include the following environment variable:
3429

3530
+
31+
[source,yaml]
3632
----
3733
- name: MONITORING_DASHBOARDS
3834
value: "1"
@@ -58,4 +54,4 @@ When a dashboard is generated, the following strings are replaced with values th
5854
| [x-]`__NAMESPACE__` | The namespace of the hosted cluster
5955
| [x-]`__CONTROL_PLANE_NAMESPACE__` | The namespace where the control plane pods of the hosted cluster are placed
6056
| [x-]`__CLUSTER_ID__` | The UUID of the hosted cluster, which matches the `_id` label of the hosted cluster metrics
61-
|===
57+
|===

0 commit comments

Comments
 (0)