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

Jump to bottom

📖 Document UpgradeAfter #4285

Merged
merged 1 commit into from
Mar 23, 2021
Merged

📖 Document UpgradeAfter #4285

merged 1 commit into from
Mar 23, 2021

Conversation

mig4
Copy link
Contributor

@mig4 mig4 commented Mar 10, 2021

What this PR does / why we need it:

Add a section that documents KubeadmControlPlane.Spec.UpgradeAfter and
how to achieve a similar effect for machines managed by a
MachineDeployment.

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 #3401

@k8s-ci-robot k8s-ci-robot added do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 10, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @mig4!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 10, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @mig4. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 10, 2021
@mig4 mig4 force-pushed the 3401-document-upgradeafter branch from 792dc8d to 3ed56db Compare March 10, 2021 21:34
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Mar 10, 2021
@vincepri
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 11, 2021
@mig4
Copy link
Contributor Author

mig4 commented Mar 12, 2021

/retest

fabriziopandini
fabriziopandini reviewed Mar 12, 2021
View reviewed changes
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.

A small nit not blocking but overall lgtm from my side

docs/book/src/tasks/upgrading-clusters.md Outdated Show resolved Hide resolved
@nader-ziada
Copy link
Contributor

@mig4 would you please squash your commits, other lgtm

@vincepri
Copy link
Member

/milestone v0.4.0

@k8s-ci-robot k8s-ci-robot added this to the v0.4.0 milestone Mar 15, 2021
vincepri
vincepri reviewed Mar 15, 2021
View reviewed changes
docs/book/src/tasks/upgrading-clusters.md
@@ -47,6 +47,28 @@ that if a specific machine image is specified, it has to match the Kubernetes ve
`KubeadmControlPlane` spec. In order to only trigger a single upgrade, the new `MachineTemplate` should be created first
and then both the `Version` and `InfrastructureTemplate` should be modified in a single transaction.

#### How to schedule a machine rollout

A `KubeadmControlPlane` resource has a field `UpgradeAfter` that can be set to a timestamp
Copy link
Member

Choose a reason for hiding this comment

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

Sidenote: We should rename this field to RolloutAfter in v0.4.0, which is a ⚠️ breaking change

Copy link
Member

Choose a reason for hiding this comment

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

@shysank Would you be interested in ^?

Copy link
Contributor

Choose a reason for hiding this comment

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

how urgent is this? I'm kind of occupied with other things right now.

@mig4
📖 Document UpgradeAfter
abdaee5 
Add a section that documents `KubeadmControlPlane.Spec.UpgradeAfter` and
how to achieve a similar effect for machines managed by a
`MachineDeployment`.
@mig4 mig4 force-pushed the 3401-document-upgradeafter branch from 03e3431 to abdaee5 Compare March 15, 2021 19:51
@mig4
Copy link
Contributor Author

mig4 commented Mar 16, 2021

@mig4 would you please squash your commits, other lgtm

Squashed them, thanks.

fabriziopandini
fabriziopandini reviewed Mar 16, 2021
View reviewed changes
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 Mar 16, 2021
fabriziopandini
fabriziopandini reviewed Mar 23, 2021
View reviewed changes
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.

/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 Mar 23, 2021
@k8s-ci-robot k8s-ci-robot merged commit e4aa0c6 into kubernetes-sigs:master Mar 23, 2021
@mig4 mig4 deleted the 3401-document-upgradeafter branch March 26, 2021 01:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shysank shysank shysank left review comments

@fabriziopandini fabriziopandini fabriziopandini left review comments

@vincepri vincepri vincepri left review comments

@detiber detiber detiber left review comments

@CecileRobertMichon CecileRobertMichon Awaiting requested review from CecileRobertMichon

@moshloop moshloop Awaiting requested review from moshloop

Assignees

@fabriziopandini fabriziopandini

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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
v0.4
Development

Successfully merging this pull request may close these issues.

Document rollout support for K Worker Nodes
7 participants
@mig4 @k8s-ci-robot @vincepri @nader-ziada @detiber @fabriziopandini @shysank