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 v1alpha4 to v1beta1 upgrade doc #5264

Merged
merged 1 commit into from
Sep 21, 2021

Conversation

sbueringer
Copy link
Member

What this PR does / why we need it:
This PR adds the initial version of the upgrade doc.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #5262

@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 20, 2021
@sbueringer sbueringer force-pushed the pr-add-upgrade-doc branch 3 times, most recently from 18c62cc to bfdace7 Compare September 21, 2021 08:27
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 21, 2021
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Sep 21, 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

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 21, 2021
@killianmuldoon
Copy link
Contributor

Is this type of change to the contract a worthwhile inclusion: #4949 ?

@fabriziopandini
Copy link
Member

Is this type of change to the contract a worthwhile inclusion: #4949 ?

This is already included in v1alpha4, so no need to document in the v1alpha4 --> v1beta1 doc; however, generally speaking,contract changes should be documented in this doc.

@randomvariable
Copy link
Member

Is it worth adding a comment about potentially supporting conversions from v1alpha3 as well as v1alpha4 to the storage version?

@killianmuldoon
Copy link
Contributor

This is already included in v1alpha4, so no need to document in the v1alpha4 --> v1beta1 doc; however, generally speaking,contract changes should be documented in this doc.

So should that change be included in the v1alpha3 -> v1alpha4 docs?

@sbueringer
Copy link
Member Author

sbueringer commented Sep 21, 2021

This is already included in v1alpha4, so no need to document in the v1alpha4 --> v1beta1 doc; however, generally speaking,contract changes should be documented in this doc.

So should that change be included in the v1alpha3 -> v1alpha4 docs?

This change was introduced during v1alpha4, not from v1alpha3->v1alpha4. I don't think that providers will re-read the v1alpha3=>v1alpha4 migration doc once they migrated to v1alpha4.

Is it worth adding a comment about potentially supporting conversions from v1alpha3 as well as v1alpha4 to the storage version?

I think that makes sense, if the idea is that infra providers also potentially support the migration from v1alpha3=>v1beta1. I added a section about it, I assume it's optional for providers to support it.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 21, 2021
@fabriziopandini
Copy link
Member

/lgtm
/approve

Let document retroactively #4949 on v1alpha3 -> v1alpha4 doc + the need of implementing InfrastructureClusterTemplate or ControlPlaneTemplate for ClusterClass support

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 21, 2021
@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 Sep 21, 2021
@k8s-ci-robot k8s-ci-robot merged commit d54d7ea into kubernetes-sigs:master Sep 21, 2021
@k8s-ci-robot k8s-ci-robot added this to the v0.4 milestone Sep 21, 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.

Document v1alpha4 -> v1beta1 changes for providers in CAPI book
5 participants