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.

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

Conversation

killianmuldoon
Copy link
Contributor

Update docs to include some changes made to the ControlPlane contract to support ClusterClass.

Signed-off-by: killianmuldoon [email protected]

Fixes #5282

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 30, 2021
Copy link
Contributor Author

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be cherry picked back to the 0.4 docs too.

@killianmuldoon killianmuldoon changed the title :book Add clusterclass contract changes to v1alpha3-v1alpha4 conversion guide 📖 Add clusterclass contract changes to v1alpha3-v1alpha4 conversion guide Sep 30, 2021
@killianmuldoon killianmuldoon force-pushed the pr-update-conversion-docs branch 2 times, most recently from 4e2d5cb to 82fd238 Compare September 30, 2021 18:47
@killianmuldoon killianmuldoon force-pushed the pr-update-conversion-docs branch from 82fd238 to 640c8e6 Compare October 1, 2021 09:42
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this effort!
Overall lgtm, only two nits to provide some more context about/when those changes are required


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

These fields are a requirement for ClusterClass compatibility.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
These fields are a requirement for ClusterClass compatibility.
Please note that implementing those field is a requirement for a control plane provider to be used with ClusterClass and managed topologies.

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

This field is a requirement for ClusterClass compatibility.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This field is a requirement for ClusterClass compatibility.
Please note that implementing those field for control plane providers using machines is a requirement for ClusterClass and managed topologies to work consistently across all the providers.

@killianmuldoon killianmuldoon force-pushed the pr-update-conversion-docs branch from 640c8e6 to bbc8384 Compare October 1, 2021 16:24
@killianmuldoon
Copy link
Contributor Author

@fabriziopandini @sbueringer updated now.

@sbueringer
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 1, 2021
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 1, 2021
@k8s-ci-robot k8s-ci-robot merged commit 286a22f into kubernetes-sigs:main Oct 1, 2021
@k8s-ci-robot k8s-ci-robot added this to the v0.4 milestone Oct 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update v1alpha3->alpha4 conversion guide with recent contract revisions
4 participants