Skip to content

Commit fc7381b

Browse files
authored
Merge pull request #53369 from lahinson/hcp-version-support-osdocs-4297
[OSDOCS-4297]: adding module about versioning support for hosted control planes
2 parents d418553 + 27014a6 commit fc7381b

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

architecture/control-plane.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,10 @@ include::modules/hosted-control-planes-overview.adoc[leveloffset=+1]
4949
.Additional resources
5050
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.5/html/multicluster_engine/advanced-config-engine#hypershift-addon-intro[Hypershift add-on (Technology Preview)]
5151
52-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.5/html/clusters/managing-your-clusters#hosted-control-plane-intro[Leveraging hosted control plane clusters (Technology Preview)]
52+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.5/html/clusters/managing-your-clusters#hosted-control-plane-intro[Leveraging hosted control plane clusters (Technology Preview)]
53+
54+
include::modules/hosted-control-planes-version-support.adoc[leveloffset=+2]
55+
56+
[role="_additional-resources"]
57+
.Additional resources
58+
* For more information about the `HostedCluster` and `NodePool` resources, see the link:https://hypershift-docs.netlify.app/reference/api/[HyperShift API Reference].
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * architecture/control-plane.adoc
4+
5+
6+
:_content-type: CONCEPT
7+
[id="hosted-control-planes-version-support_{context}"]
8+
= Versioning support for hosted control planes
9+
10+
With each major, minor, or patch version release of {product-title}, the following components of hosted control planes are released:
11+
12+
* HyperShift Operator
13+
* `HostedCluster` and `NodePool` API resources
14+
* Command-line interface (CLI)
15+
16+
The HyperShift Operator manages the lifecycle of hosted clusters that are represented by `HostedCluster` resources. The HyperShift Operator is released with each {product-title} release. Any HyperShift Operator that is released with a minor _n_ version of {product-title} must support _n_, _n-1_, and _n-2_ minor versions of {product-title}.
17+
18+
The CLI is a helper utility for development purposes. The CLI is released as part of any HyperShift Operator release. No compatibility policies are guaranteed.
19+
20+
The API, `hypershift.openshift.io`, provides a way to create and manage lightweight, flexible, heterogeneous {product-title} clusters at scale. The API exposes two user-facing resources: `HostedCluster` and `NodePool`. A `HostedCluster` resource encapsulates 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.
21+
22+
The `HostedCluster` and `NodePool` resources are released with each {product-title} release. Any `HostedCluster` or `NodePool` resources that are released for a minor _n_ version of {product-title} must support _n_, _n-1_, and _n-2_ minor versions of {product-title}. The API version policy generally aligns with the link:https://kubernetes.io/docs/reference/using-api/#api-versioning[Kubernetes API versioning].
23+
24+
25+

0 commit comments

Comments
 (0)