Implement `kubeadm upgrade diff` #63930

liztio · 2018-05-16T16:33:49Z

What this PR does / why we need it:

Some users want to see the changes kubeadm woulda apply before actually running kubeadm upgrade apply. This shows the changes that will be made to the static pod manifests before applying them. This is a narrower case than kubeadm upgrade apply --dry-run, which specifically focuses on the static pod manifests.

Which issue(s) this PR fixes:
Part of kubeadm/489
Fixes kubernetes/kubeadm#830

Special notes for your reviewer:

Release note:

adds the `kubeadm upgrade diff` command to show how static pod manifests will be changed by an upgrade.

liztio · 2018-05-16T16:35:51Z

I couldn't think of any tests that would provide much useful signal here and wouldn't be brittle across versions. If anyone has any suggestions I'm open to them!

liztio · 2018-05-16T16:36:24Z

/cc @kubernetes/sig-cluster-lifecycle-pr-reviews

neolit123 · 2018-05-16T17:53:29Z

cmd/kubeadm/app/cmd/upgrade/diff.go

+
+	k8sVer, err := version.ParseSemantic(flags.newK8sVersionStr)
+	if err != nil {
+		kubeadmutil.CheckErr(err)


it's really hard to write unit tests around CheckErr() as it effectively calls exit(1) on error.
:(

i would return an error from this function an only call a single CheckErr() on that error in the Cobra Run().

Can you please file an issue to improve that? Such unit testing would be a perfect contribution from you 👍

shouldn't a unit test be added as part of this PR? @liztio WDYT?

@neolit123 like I said, I couldn't figure out what good unit tests would look like since the diffs are likely to change a lot between versions. I'm open to ideas on what they could look like.

possible tests:

non existing config path in flags.parent.cfgPath

flags.newK8sVersionStr == "", but no version arg is provided

bad version format in flags.newK8sVersionStr to make ParseSemantic() fail

make kubeadmutil.MarshalToYaml fail somehow.

fail ioutil.ReadFile(path) by providing bad 'path'

i don't think that the diff output itself should be tested - e.g. making sure that a diff buffer looks exactly like another diff buffer.

one problem i have with Lucas' request is that my setup is quite broken at the moment, so if you want me to add tests for this, i would need a fully working master configuration yaml aaand i might ask some questions too - because i simply don't understand some of the things here.

@liztio TLDR if you are out of time and want me to help send me a YAML that returns nil for runDiff().

Those sound good. Unfortunately, I'm out thursday and friday this week, and it's basically the end of my day. So given the choice between adding unit tests and missing the 0.11 deadline, I'll defer the unit tests until I get back. I made an issue so I don't forget to follow up.

luxas

A couple of small comments only, generally LGTM

luxas · 2018-05-16T18:26:43Z

cmd/kubeadm/app/cmd/upgrade/diff.go

+
+	k8sVer, err := version.ParseSemantic(flags.newK8sVersionStr)
+	if err != nil {
+		kubeadmutil.CheckErr(err)


Can you please file an issue to improve that? Such unit testing would be a perfect contribution from you 👍

luxas · 2018-05-16T18:29:00Z

cmd/kubeadm/app/cmd/upgrade/diff.go

+	}
+
+	// Convert to an internal representation
+	internalcfg := &kubeadmapi.MasterConfiguration{}


It already is internal, why have these lines of code here?

whoops, leftover from a rebase.

luxas · 2018-05-16T18:30:26Z

cmd/kubeadm/app/cmd/upgrade/diff.go

+	corev1 "k8s.io/api/core/v1"
+	kubeadmapi "k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm"
+	"k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/scheme"
+	kubeadmapiext "k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1alpha2"


We use kubeadmv1alpha2 as the name everywhere else currently. If you care strongly about the naming there, please open an issue to change it to something else, but please be consistent for now.

luxas · 2018-05-16T18:31:29Z

cmd/kubeadm/app/cmd/upgrade/diff.go

+	var cfg *kubeadmapi.MasterConfiguration
+
+	// If the version is specified in config file, pick up that value.
+	if flags.parent.cfgPath != "" {


Technically I don't think you should need to do this, as ConfigFileAndDefaultsToInternalConfig has this conditional inside of itself.

luxas · 2018-05-16T18:32:25Z

cmd/kubeadm/app/cmd/upgrade/diff.go

+			continue
+		}
+
+		new, err := kubeadmutil.MarshalToYaml(&pod, corev1.SchemeGroupVersion)


is new a keyword? can you make the name a bit longer like newPodYAML?

luxas · 2018-05-16T18:33:11Z

cmd/kubeadm/app/cmd/upgrade/diff.go

+
+	cmd := &cobra.Command{
+		Use:   "diff [version]",
+		Short: "Show what differences would be applied to existing static pod manifests",


Can you please add a reference to apply --dry-run here so that it's more discoverable?

This command takes an upgrade version, and shows how the static pod manifests will be changed by a given upgrade.

neolit123 · 2018-05-16T19:47:36Z

cmd/kubeadm/app/cmd/upgrade/diff.go

+			path = flags.schedulerManifestPath
+		default:
+			glog.Errorf("[diff] unknown spec %v", spec)
+			continue


is it OK to skip unknown specs here?
should we return fmt.Errorf() instead.

I'd prefer to err on the side of not breaking this for users. This shouldn't come up, but in case it does I don't want it to break upgrade diff altogether.

sounds good.

luxas

/lgtm
/approve

Thanks Liz, this is a very useful UX improvement 🎉!

liztio · 2018-05-16T20:04:05Z

/assign @pwittrock
this is just boilerplate it looks like, but the tests grumbled if I didn't add it

luxas · 2018-05-16T21:48:21Z

/retest

I'm just gonna add it manually, makes no sense to have a dedicated approver for that old stuff we don't care about anymore

k8s-ci-robot · 2018-05-16T21:48:36Z

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by: liztio, luxas

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:

~~cmd/kubeadm/OWNERS~~ [luxas]
docs/OWNERS

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

k8s-github-robot · 2018-05-17T07:28:24Z

Automatic merge from submit-queue (batch tested with PRs 63865, 57849, 63932, 63930, 63936). If you want to cherry-pick this change to another branch, please follow the instructions here.

k8s-ci-robot requested review from detiber and xiangpengzhao May 16, 2018 16:34

liztio force-pushed the kubeadm-init-diff branch from 1398348 to 2ef1689 Compare May 16, 2018 16:34

Bazel artifacts

1f49279

liztio force-pushed the kubeadm-init-diff branch from 2ef1689 to e553ae6 Compare May 16, 2018 16:52

luxas self-assigned this May 16, 2018

liztio force-pushed the kubeadm-init-diff branch from e553ae6 to e955c1a Compare May 16, 2018 17:08

k8s-github-robot added the kind/old-docs label May 16, 2018

neolit123 reviewed May 16, 2018

View reviewed changes

luxas reviewed May 16, 2018

View reviewed changes

luxas changed the title ~~Kubeadm init diff~~ Implement kubeadm init diff May 16, 2018

liztio force-pushed the kubeadm-init-diff branch 2 times, most recently from 30e2356 to 2ab79d7 Compare May 16, 2018 19:00

liztio added 2 commits May 16, 2018 15:23

Add a kubeadm upgrade diff command

15bbc4d

This command takes an upgrade version, and shows how the static pod manifests will be changed by a given upgrade.

Generated docs

618a110

liztio force-pushed the kubeadm-init-diff branch from 2ab79d7 to 618a110 Compare May 16, 2018 19:23

neolit123 reviewed May 16, 2018

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 16, 2018

luxas approved these changes May 16, 2018

View reviewed changes

k8s-ci-robot assigned pwittrock May 16, 2018

luxas added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 16, 2018

luxas unassigned pwittrock May 16, 2018

k8s-github-robot merged commit 2fda6e5 into kubernetes:master May 17, 2018

luxas changed the title ~~Implement kubeadm init diff~~ Implement kubeadm upgrade diff May 17, 2018

This was referenced May 17, 2018

Add unit tests to kubeadm upgrade diff and small improvements #63991

Merged

document kubeadm upgrade diff at website kubernetes/kubeadm#832

Closed

jipperinbham mentioned this pull request May 21, 2018

add note prior to interactive confirm of kubeadm upgrade apply #57116

Closed

neolit123 mentioned this pull request May 24, 2018

kubeadm-upgrade.md: include a generated page about 'diff' and adjust notes kubernetes/website#8617

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement `kubeadm upgrade diff` #63930

Implement `kubeadm upgrade diff` #63930

liztio commented May 16, 2018 •

edited by luxas

Loading

liztio commented May 16, 2018

liztio commented May 16, 2018

neolit123 May 16, 2018 •

edited

Loading

luxas May 16, 2018

neolit123 May 16, 2018

liztio May 16, 2018

neolit123 May 16, 2018

neolit123 May 16, 2018

liztio May 16, 2018

luxas left a comment

luxas May 16, 2018

luxas May 16, 2018

liztio May 16, 2018

luxas May 16, 2018

luxas May 16, 2018

luxas May 16, 2018

luxas May 16, 2018

neolit123 May 16, 2018

liztio May 16, 2018

neolit123 May 16, 2018

luxas left a comment

liztio commented May 16, 2018

luxas commented May 16, 2018

k8s-ci-robot commented May 16, 2018

k8s-github-robot commented May 17, 2018

Implement kubeadm upgrade diff #63930

Implement kubeadm upgrade diff #63930

Conversation

liztio commented May 16, 2018 • edited by luxas Loading

liztio commented May 16, 2018

liztio commented May 16, 2018

neolit123 May 16, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luxas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luxas left a comment

Choose a reason for hiding this comment

liztio commented May 16, 2018

luxas commented May 16, 2018

k8s-ci-robot commented May 16, 2018

k8s-github-robot commented May 17, 2018

Implement `kubeadm upgrade diff` #63930

Implement `kubeadm upgrade diff` #63930

liztio commented May 16, 2018 •

edited by luxas

Loading

neolit123 May 16, 2018 •

edited

Loading