Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Add clusterclass contract changes to v1alpha3-v1alpha4 conversion guide #5366

Merged
merged 1 commit into from
Oct 1, 2021
Merged

📖 Add clusterclass contract changes to v1alpha3-v1alpha4 conversion guide #5366

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/book/src/developer/providers/v1alpha3-to-v1alpha4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,3 +334,25 @@ should be executed before this changes.
- `spec.infrastructureTemplate` has been moved to `spec.machineTemplate.infrastructureRef`. Thus, cluster templates which include `KubeadmControlPlane`
have to be adjusted accordingly.
- `spec.nodeDrainTimeout` has been moved to `spec.machineTemplate.nodeDrainTimeout`.

## Required spec and status fields for Control Planes using 'version' for ClusterClass support
ControlPlane implementations using version must now [include a 'version' field as defined below in both its spec and its status](../architecture/controllers/control-plane.md#required-spec-fields-for-implementations-using-version).

`spec.version` - is a string representing the Kubernetes version to be used
by the control plane machines. The value must be a valid semantic version;
also if the value provided by the user does not start with the v prefix, it
must be added.

`status.version` - is a string representing the minimum Kubernetes version for the control plane machines in the cluster.

Please note that implementing these fields are a requirement for a control plane provider to be used with ClusterClass and managed topologies.

## Required spec fields for Control Planes using 'Machines' for ClusterClass support
ControlPlane implementations that use an underlying MachineInfrastructure must now [include a 'machineTemplate' as defined below, with subordinate fields, in its Spec.](../architecture/controllers/control-plane.md#required-spec-fields-for-implementations-using-machines)


`machineTemplate` - is a struct containing details of the control plane
machine template.

Please note that implementing this field for control plane providers using machines is a requirement for ClusterClass and managed topologies to work consistently across all providers.