Skip to content

Commit 5bf998d

Browse files
authored
Merge pull request #84335 from lahinson/osdocs-11350-hcp-versioning
[OSDOCS-11350]: Adding more versioning details to HCP docs
2 parents 59b7b40 + 8e80057 commit 5bf998d

File tree

2 files changed

+43
-5
lines changed

2 files changed

+43
-5
lines changed

hosted_control_planes/index.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ include::modules/hosted-control-planes-version-support.adoc[leveloffset=+1]
1414

1515
[role="_additional-resources"]
1616
.Additional resources
17-
18-
* xref:../scalability_and_performance/using-node-tuning-operator.adoc#node-tuning-hosted-cluster_node-tuning-operator[Configuring node tuning in a hosted cluster]
19-
* xref:../scalability_and_performance/using-node-tuning-operator.adoc#advanced-node-tuning-hosted-cluster_node-tuning-operator[Advanced node tuning for hosted clusters by setting kernel boot parameters]
17+
* link:https://amd64.ocp.releases.ci.openshift.org/[AMD64 release images]
18+
* link:https://arm64.ocp.releases.ci.openshift.org/[ARM64 release images]
19+
* link:https://multi.ocp.releases.ci.openshift.org/[Multi-arch release images]
20+
//* xref:../scalability_and_performance/using-node-tuning-operator.adoc#node-tuning-hosted-cluster_node-tuning-operator[Configuring node tuning in a hosted cluster]
21+
//* xref:../scalability_and_performance/using-node-tuning-operator.adoc#advanced-node-tuning-hosted-cluster_node-tuning-operator[Advanced node tuning for hosted clusters by setting kernel boot parameters]
2022
2123
include::modules/hosted-control-planes-concepts-personas.adoc[leveloffset=+1]

modules/hosted-control-planes-version-support.adoc

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,32 @@
88
[id="hosted-control-planes-version-support_{context}"]
99
= Versioning for {hcp}
1010

11+
The {hcp} feature includes the following components, which might require independent versioning and support levels:
12+
13+
* Management cluster
14+
* HyperShift Operator
15+
* {hcp-capital} (`hcp`) command-line interface (CLI)
16+
* `hypershift.openshift.io` API
17+
* Control Plane Operator
18+
19+
[id="hcp-versioning-mgmt_{context}"]
20+
== Management cluster
21+
22+
In management clusters for production use, you need {mce}, which is available through OperatorHub. The {mce-short} bundles a supported build of the HyperShift Operator. For your management clusters to remain supported, you must use the version of {product-title} that {mce-short} runs on. In general, a new release of {mce-short} runs on the following versions of {product-title}:
23+
24+
* The latest General Availability version of {product-title}
25+
* Two versions before the latest General Availability version of {product-title}
26+
27+
The full list of {product-title} versions that you can install through the HyperShift Operator on a management cluster depends on the version of your HyperShift Operator. However, the list always includes at least the same {product-title} version as the management cluster and two previous minor versions relative to the management cluster. For example, if the management cluster is running 4.17 and a supported version of {mce-short}, the HyperShift Operator can install 4.17, 4.16, 4.15, and 4.14 hosted clusters.
28+
1129
With each major, minor, or patch version release of {product-title}, two components of {hcp} are released:
1230

1331
* The HyperShift Operator
1432
* The `hcp` command-line interface (CLI)
1533

34+
[id="hcp-versioning-ho_{context}"]
35+
== HyperShift Operator
36+
1637
The HyperShift Operator manages the lifecycle of hosted clusters that are represented by the `HostedCluster` API resources. The HyperShift Operator is released with each {product-title} release. The HyperShift Operator creates the `supported-versions` config map in the `hypershift` namespace. The config map contains the supported hosted cluster versions.
1738

1839
You can host different versions of control planes on the same management cluster.
@@ -31,10 +52,25 @@ You can host different versions of control planes on the same management cluster
3152
namespace: hypershift
3253
----
3354

34-
You can use the `hcp` CLI to create hosted clusters.
55+
[id="hcp-versioning-cli_{context}"]
56+
== {hcp} CLI
57+
58+
You can use the `hcp` CLI to create hosted clusters. You can download the CLI from {mce-short}. When you run the `hcp version` command, the output shows the latest {product-title} that the CLI supports against your `kubeconfig` file.
59+
60+
[id="hcp-versioning-api_{context}"]
61+
== hypershift.openshift.io API
3562

3663
You can use the `hypershift.openshift.io` API resources, such as, `HostedCluster` and `NodePool`, to create and manage {product-title} clusters at scale. A `HostedCluster` resource contains the control plane and common data plane configuration. When you create a `HostedCluster` resource, you have a fully functional control plane with no attached nodes. A `NodePool` resource is a scalable set of worker nodes that is attached to a `HostedCluster` resource.
3764

3865
The API version policy generally aligns with the policy for link:https://kubernetes.io/docs/reference/using-api/#api-versioning[Kubernetes API versioning].
3966

40-
Updates for {hcp} involve updating the hosted cluster and the node pools. For more information, see "Updates for hosted control planes".
67+
Updates for {hcp} involve updating the hosted cluster and the node pools. For more information, see "Updates for hosted control planes".
68+
69+
[id="hcp-versioning-cpo_{context}"]
70+
== Control Plane Operator
71+
72+
The Control Plane Operator is released as part of each {product-title} payload release image for the following architectures:
73+
74+
* amd64
75+
* arm64
76+
* multi-arch

0 commit comments

Comments
 (0)