Skip to content

Commit

Permalink
Merge pull request #53369 from lahinson/hcp-version-support-osdocs-4297
Browse files Browse the repository at this point in the history
[OSDOCS-4297]: adding module about versioning support for hosted control planes
  • Loading branch information
skrthomas authored Dec 16, 2022
2 parents d418553 + 27014a6 commit fc7381b
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
8 changes: 7 additions & 1 deletion architecture/control-plane.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,10 @@ include::modules/hosted-control-planes-overview.adoc[leveloffset=+1]
.Additional resources
* 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)]
* 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)]
* 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)]
include::modules/hosted-control-planes-version-support.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources
* For more information about the `HostedCluster` and `NodePool` resources, see the link:https://hypershift-docs.netlify.app/reference/api/[HyperShift API Reference].
25 changes: 25 additions & 0 deletions modules/hosted-control-planes-version-support.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Module included in the following assemblies:
//
// * architecture/control-plane.adoc


:_content-type: CONCEPT
[id="hosted-control-planes-version-support_{context}"]
= Versioning support for hosted control planes

With each major, minor, or patch version release of {product-title}, the following components of hosted control planes are released:

* HyperShift Operator
* `HostedCluster` and `NodePool` API resources
* Command-line interface (CLI)
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}.

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.

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.

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].



0 comments on commit fc7381b

Please sign in to comment.