Improve Error Message from Using kubectl apply with generateName

[danielhelfand]

Version:

Client Version: version.Info{Major:"1", Minor:"17", GitVersion:"v1.17.3", GitCommit:"06ad960bfd03b39c8310aaf92d1e7c12ce618213", GitTreeState:"clean", BuildDate:"2020-02-11T18:14:22Z", GoVersion:"go1.13.6", Compiler:"gc", Platform:"darwin/amd64"}
Server Version: version.Info{Major:"1", Minor:"17", GitVersion:"v1.17.3", GitCommit:"06ad960bfd03b39c8310aaf92d1e7c12ce618213", GitTreeState:"clean", BuildDate:"2020-02-11T18:07:13Z", GoVersion:"go1.13.6", Compiler:"gc", Platform:"linux/amd64"}

Currently, if kubectl apply -f is used with generateName specified but no name specified in the metadata of an object, the resulting error will be similar to the following:

error: error when retrieving current configuration of:
Resource: "tekton.dev/v1alpha1, Resource=taskruns", GroupVersionKind: "tekton.dev/v1alpha1, Kind=TaskRun"
Name: "", Namespace: "default"
Object: &{...}
from server for: "taskrun.yaml": resource name may not be empty

The issue of the error message has come up in a number of places:

• kubectl apply includes raw and useless data into the error message #197
• Using 'generateName' with Jobs kubernetes#44501
• Improve Error Message From Running kubectl apply -f for PipelineRuns/TaskRuns tektoncd/pipeline#2113
• [Bug] Can't use generateName in pipelineRun tektoncd/pipeline#2170

The solution to this error, very often, is to run kubectl create -f instead of using kubectl apply, but the error message makes it challenging for users to understand what the problem is.

I am proposing adjusting the error message in the case of using kubectl apply with generateName specified but no name specified to be something along the lines of try running kubectl create -f instead.

I think this would provide greater clarity to users for how to use generateName with kubectl and help users address the problem on their own much better.

[zhouya0]

/assign
I'll try to improve this. :)

[seans3]

/sig cli
/area kubectl
/kind bug
/priority P2

@zhouya0 Please feel free to modify the priority as you see fit

[zhouya0]

I tried to send a PR, I don't know if this could solve your porblem. kubernetes/kubernetes#88998

I didn't add some message like try running kubectl create -f instead because you will never know what future changes for kubectl create and other commands.

[danielhelfand]

@zhouya0 Thanks! Added feedback to your pr.

[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

[seans3]

/remove-lifecycle stale

[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

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

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 rotten

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

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

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/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.