Kubectl Diff path to GA

[apelisse]

This is describing the steps necessary to move kubectl diff to Beta and GA.

These are the list of features and bugs that need to be addressed before kubectl diff can move to beta and GA.

Please cross-out (do not remove, please) whichever does not seem appropriate for moving to Beta/GA and put your name behind it. If you want to add any notes specific to a task, please list it as a bullet point and again, put your name behind it.

Features

• Simplify and improve existing interface to be more focused kubectl-diff: Simplify interface #68525 @apelisse
• Use server-side dry-run to get the merged version, rather than using Phil's code Use dry-run patch to get the merged version of the object #69162 @apelisse
• Move command out of alpha sub-commands Move diff command from alpha sub-command to root cmd #69167 @apelisse
• Add proper documentation for the command @apelisse
• Find a few places in the documentation where apply is used, and suggest running diff before, to see what will happen @apelisse
• GA: Document the command other than in the command itself Document kubectl diff command as GA #86525

Bugs

• Check server version or availability of the dry-run parameter to prevent unwanted changes to the server (old servers might ignore the dryRun parameter). kubectl: Verify dry run support #69449 @apelisse
• Checking dry-run availability isn't done on "create" path kubectl dry-run: Check for server didn't work on create #69745 @apelisse
• Return errors from "diff" are ignored, including if diff(1) doesn't exist Rename KUBERNETES_EXTERNAL_DIFF to KUBECTL_EXTERNAL_DIFF #69742 @apelisse
• KUBERNETES_EXTERNAL_DIFF should be renamed KUBECTL_EXTERNAL_DIFF Rename KUBERNETES_EXTERNAL_DIFF to KUBECTL_EXTERNAL_DIFF #69742 @apelise
• When using dry-run patch, we need to patch against the same specific resourceVersion of the object, or it might diff two different version Optimistic-locking on diff #71156 @apelisse

Tech Debt

• Change the way options are created [FEATURE-SERVERSIDE-APPLY] Server side kubectl-diff #72204 (suggested by @soltysh)
• Add more tests in test-diff.sh (suggested by @soltysh)
• Test that it works fine against CRDs

[apelisse]

/sig cli

[guineveresaenger]

Hi @apelisse - I'm Enhancements Shadow for 1.13. Could you please update the release team with the likelihood of this enhancement making the 1.13 release? It looks close but when we don't see any updates in a few days, we would appreciate an update.

Code slush begins on 11/9 and code freeze is 11/15.

Thank you!

[apelisse]

Hi @guineveresaenger, this feature is pretty much ready, which is why I don't look super active here :-)

[zx8]

@apelisse I've found what I think is a bug:

$ kubectl version
Client Version: version.Info{Major:"1", Minor:"12", GitVersion:"v1.12.2", GitCommit:"17c77c7898218073f14c8d573582e8d2313dc740", GitTreeState:"clean", BuildDate:"2018-10-30T21:39:16Z", GoVersion:"go1.11.1", Compiler:"gc", Platform:"darwin/amd64"}
Server Version: version.Info{Major:"1", Minor:"11+", GitVersion:"v1.11.2-gke.18", GitCommit:"5796233393d7bc034428de15191ad3d2eaff95fb", GitTreeState:"clean", BuildDate:"2018-11-08T20:49:08Z", GoVersion:"go1.10.3b4", Compiler:"gc", Platform:"linux/amd64"}

$ helm template . | kubectl alpha diff -f - MERGED
error: missmatching non-nil types for the same field: float64 int64

Not sure how to diagnose this. Anything I can do to help figure out the issue? This was the result of doing a helm template . | kubectl apply -f- followed by the above diff command.

[apelisse]

Hey @zx8, thanks for the feedback! kubectl diff beta that is being released right now is significantly different from that version, and so this bug is not very relevant anymore. Please try the new diff version when 1.13 is released and tell me if you like it!

[zx8]

Oops, my mistake! I just rebuilt from master @ a19bf33 and am getting:

$ helm template . | kubectl diff -f-
error: /v1, Kind=ConfigMap doesn't support dry-run

When commenting out the ConfigMap YAML and trying again, I get:

$ helm template . | kubectl diff -f-
error: apps/v1, Kind=Deployment doesn't support dry-run

I assume this requires the server to be running v1.13+ as well? I don't want to spam this issue with feedback so let me know if this is a legitimate bug and I'll raise it through the appropriate channel.

[apelisse]

Right, you need server-side dry-run (kubernetes/enhancements#576) on the server (it's currently alpha so you might be able to try by enabling the feature-gate)

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[apelisse]

/lifecycle frozen

[julianvmodesto]

For properly documenting this feature, I've opened #86525

[julianvmodesto]

We could probably update the dry-run kep w/ a subsection on kubectl diff since we need a KEP for the release for this feature

[apelisse]

Do we really need a KEP? There is a kep for the feature, is it missing something specific?

[julianvmodesto]

Oh nevermind if there's a KEP for the feature already for diff. I was looking at the Enhancements Tracking sheet:

https://docs.google.com/spreadsheets/d/1RtCvByYdcqWc6I_A1cKgeXT2tBS7SyHGvSt_DWXz270/edit#gid=0

[julianvmodesto]

Looks like we're good for everything except for #87600 before code freeze. I'm going to also check integration tests again, but I feel that there is sufficient overlap with integration tests for dry-run verbs at least for the dry-run specific behavior. Otherwise, we only have a little docs left!

[apelisse]

Otherwise, we only have a little docs left!

Do you know specifically what needs to be updated for the tests?

[julianvmodesto]

Hm I want to say we're covered, particularly after you added tests for #87437.

[julianvmodesto]

This is done!

Follow ups:

• Add kubectl diff and server-side dry-run to conformance #88905

/close

[k8s-ci-robot]

@julianvmodesto: Closing this issue.

In response to this:

This is done!

Follow ups:

• Add kubectl diff and server-side dry-run to conformance #88905

/close

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.