Merge pull request kubernetes#53631 from dixudx/enforce_cobra_require…

…d_flags

Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>.

update vendor spf13/cobra to enforce required flags

**What this PR does / why we need it**:

spf13/cobra#502 has enforced checking flags that marked as required, an error will be raised if unset.

**Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*:fixes kubernetes#54855
xref kubernetes#48400
fixes kubernetes/kubectl#121 

**Special notes for your reviewer**:
/assign @liggitt @eparis 

**Release note**:

```release-note
kubectl now enforces required flags at a more fundamental level
```

cmd/genkubedocs/postprocessing.go

@@ -27,7 +27,7 @@ import (
 // MarkdownPostProcessing goes though the generated files
 func MarkdownPostProcessing(cmd *cobra.Command, dir string, processor func(string) string) error {
 	for _, c := range cmd.Commands() {
-		if !c.IsAvailableCommand() || c.IsHelpCommand() {
+		if !c.IsAvailableCommand() || c.IsAdditionalHelpTopicCommand() {
 			continue
 		}
 		if err := MarkdownPostProcessing(c, dir, processor); err != nil {

cmd/kubeadm/app/cmd/join.go

@@ -111,7 +111,7 @@ func NewCmdJoin(out io.Writer) *cobra.Command {
 	var ignorePreflightErrors []string
 
 	cmd := &cobra.Command{
-		Use:   "join [flags]",
+		Use:   "join",
 		Short: "Run this on any machine you wish to join an existing cluster",
 		Long:  joinLongDescription,
 		Run: func(cmd *cobra.Command, args []string) {

cmd/kubeadm/app/cmd/token.go

@@ -102,7 +102,8 @@ func NewCmdToken(out io.Writer, errW io.Writer) *cobra.Command {
 	var description string
 	var printJoinCommand bool
 	createCmd := &cobra.Command{
-		Use:   "create [token]",
+		Use: "create [token]",
+		DisableFlagsInUseLine: true,
 		Short: "Create bootstrap tokens on the server.",
 		Long: dedent.Dedent(`
 			This command will create a bootstrap token for you.
@@ -156,7 +157,8 @@ func NewCmdToken(out io.Writer, errW io.Writer) *cobra.Command {
 	tokenCmd.AddCommand(listCmd)
 
 	deleteCmd := &cobra.Command{
-		Use:   "delete [token-value]",
+		Use: "delete [token-value]",
+		DisableFlagsInUseLine: true,
 		Short: "Delete bootstrap tokens on the server.",
 		Long: dedent.Dedent(`
 			This command will delete a given bootstrap token for you.

cmd/kubeadm/app/cmd/upgrade/apply.go

@@ -69,7 +69,8 @@ func NewCmdApply(parentFlags *cmdUpgradeFlags) *cobra.Command {
 	}
 
 	cmd := &cobra.Command{
-		Use:   "apply [version]",
+		Use: "apply [version]",
+		DisableFlagsInUseLine: true,
 		Short: "Upgrade your Kubernetes cluster to the specified version.",
 		Run: func(cmd *cobra.Command, args []string) {
 			var err error

pkg/kubectl/cmd/annotate.go

@@ -113,7 +113,8 @@ func NewCmdAnnotate(f cmdutil.Factory, out io.Writer) *cobra.Command {
 	}
 
 	cmd := &cobra.Command{
-		Use:     "annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]",
+		Use: "annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Update the annotations on a resource"),
 		Long:    annotateLong + "\n\n" + cmdutil.ValidResourceTypeList(f),
 		Example: annotateExample,

pkg/kubectl/cmd/apply.go

@@ -105,7 +105,8 @@ func NewCmdApply(baseName string, f cmdutil.Factory, out, errOut io.Writer) *cob
 	options.cmdBaseName = baseName
 
 	cmd := &cobra.Command{
-		Use:     "apply -f FILENAME",
+		Use: "apply -f FILENAME",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Apply a configuration to a resource by filename or stdin"),
 		Long:    applyLong,
 		Example: applyExample,

pkg/kubectl/cmd/apply_edit_last_applied.go

@@ -76,7 +76,8 @@ func NewCmdApplyEditLastApplied(f cmdutil.Factory, out, errOut io.Writer) *cobra
 	}
 
 	cmd := &cobra.Command{
-		Use:     "edit-last-applied (RESOURCE/NAME | -f FILENAME)",
+		Use: "edit-last-applied (RESOURCE/NAME | -f FILENAME)",
+		DisableFlagsInUseLine: true,
 		Short:   "Edit latest last-applied-configuration annotations of a resource/object",
 		Long:    applyEditLastAppliedLong,
 		Example: applyEditLastAppliedExample,

pkg/kubectl/cmd/apply_set_last_applied.go

@@ -84,7 +84,8 @@ var (
 func NewCmdApplySetLastApplied(f cmdutil.Factory, out, err io.Writer) *cobra.Command {
 	options := &SetLastAppliedOptions{Out: out, ErrOut: err}
 	cmd := &cobra.Command{
-		Use:     "set-last-applied -f FILENAME",
+		Use: "set-last-applied -f FILENAME",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Set the last-applied-configuration annotation on a live object to match the contents of a file."),
 		Long:    applySetLastAppliedLong,
 		Example: applySetLastAppliedExample,

pkg/kubectl/cmd/apply_view_last_applied.go

@@ -60,7 +60,8 @@ var (
 func NewCmdApplyViewLastApplied(f cmdutil.Factory, out, err io.Writer) *cobra.Command {
 	options := &ViewLastAppliedOptions{Out: out, ErrOut: err}
 	cmd := &cobra.Command{
-		Use:     "view-last-applied (TYPE [NAME | -l label] | TYPE/NAME | -f FILENAME)",
+		Use: "view-last-applied (TYPE [NAME | -l label] | TYPE/NAME | -f FILENAME)",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("View latest last-applied-configuration annotations of a resource/object"),
 		Long:    applyViewLastAppliedLong,
 		Example: applyViewLastAppliedExample,

pkg/kubectl/cmd/attach.go

@@ -71,7 +71,8 @@ func NewCmdAttach(f cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer)
 		Attach: &DefaultRemoteAttach{},
 	}
 	cmd := &cobra.Command{
-		Use:     "attach (POD | TYPE/NAME) -c CONTAINER",
+		Use: "attach (POD | TYPE/NAME) -c CONTAINER",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Attach to a running container"),
 		Long:    "Attach to a process that is already running inside an existing container.",
 		Example: attachExample,

pkg/kubectl/cmd/auth/cani.go

@@ -88,7 +88,8 @@ func NewCmdCanI(f cmdutil.Factory, out, err io.Writer) *cobra.Command {
 	}
 
 	cmd := &cobra.Command{
-		Use:     "can-i VERB [TYPE | TYPE/NAME | NONRESOURCEURL]",
+		Use: "can-i VERB [TYPE | TYPE/NAME | NONRESOURCEURL]",
+		DisableFlagsInUseLine: true,
 		Short:   "Check whether an action is allowed",
 		Long:    canILong,
 		Example: canIExample,

pkg/kubectl/cmd/auth/reconcile.go

@@ -64,7 +64,8 @@ func NewCmdReconcile(f cmdutil.Factory, out, err io.Writer) *cobra.Command {
 	}
 
 	cmd := &cobra.Command{
-		Use:     "reconcile -f FILENAME",
+		Use: "reconcile -f FILENAME",
+		DisableFlagsInUseLine: true,
 		Short:   "Reconciles rules for RBAC Role, RoleBinding, ClusterRole, and ClusterRole binding objects",
 		Long:    reconcileLong,
 		Example: reconcileExample,

pkg/kubectl/cmd/autoscale.go

@@ -52,7 +52,8 @@ func NewCmdAutoscale(f cmdutil.Factory, out io.Writer) *cobra.Command {
 	argAliases := kubectl.ResourceAliases(validArgs)
 
 	cmd := &cobra.Command{
-		Use:     "autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]",
+		Use: "autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU]",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Auto-scale a Deployment, ReplicaSet, or ReplicationController"),
 		Long:    autoscaleLong,
 		Example: autoscaleExample,

pkg/kubectl/cmd/certificates.go

@@ -32,7 +32,8 @@ import (
 
 func NewCmdCertificate(f cmdutil.Factory, out io.Writer) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "certificate SUBCOMMAND",
+		Use: "certificate SUBCOMMAND",
+		DisableFlagsInUseLine: true,
 		Short: i18n.T("Modify certificate resources."),
 		Long:  "Modify certificate resources.",
 		Run: func(cmd *cobra.Command, args []string) {
@@ -68,7 +69,8 @@ func (options *CertificateOptions) Validate() error {
 func NewCmdCertificateApprove(f cmdutil.Factory, out io.Writer) *cobra.Command {
 	options := CertificateOptions{}
 	cmd := &cobra.Command{
-		Use:   "approve (-f FILENAME | NAME)",
+		Use: "approve (-f FILENAME | NAME)",
+		DisableFlagsInUseLine: true,
 		Short: i18n.T("Approve a certificate signing request"),
 		Long: templates.LongDesc(`
 		Approve a certificate signing request.
@@ -118,7 +120,8 @@ func (options *CertificateOptions) RunCertificateApprove(f cmdutil.Factory, out
 func NewCmdCertificateDeny(f cmdutil.Factory, out io.Writer) *cobra.Command {
 	options := CertificateOptions{}
 	cmd := &cobra.Command{
-		Use:   "deny (-f FILENAME | NAME)",
+		Use: "deny (-f FILENAME | NAME)",
+		DisableFlagsInUseLine: true,
 		Short: i18n.T("Deny a certificate signing request"),
 		Long: templates.LongDesc(`
 		Deny a certificate signing request.

pkg/kubectl/cmd/completion.go

@@ -97,7 +97,8 @@ func NewCmdCompletion(out io.Writer, boilerPlate string) *cobra.Command {
 	}
 
 	cmd := &cobra.Command{
-		Use:     "completion SHELL",
+		Use: "completion SHELL",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Output shell completion code for the specified shell (bash or zsh)"),
 		Long:    completion_long,
 		Example: completion_example,

pkg/kubectl/cmd/config/config.go

@@ -37,7 +37,8 @@ func NewCmdConfig(f cmdutil.Factory, pathOptions *clientcmd.PathOptions, out, er
 	}
 
 	cmd := &cobra.Command{
-		Use:   "config SUBCOMMAND",
+		Use: "config SUBCOMMAND",
+		DisableFlagsInUseLine: true,
 		Short: i18n.T("Modify kubeconfig files"),
 		Long: templates.LongDesc(`
 			Modify kubeconfig files using subcommands like "kubectl config set current-context my-context"

pkg/kubectl/cmd/config/create_authinfo.go

@@ -100,7 +100,8 @@ func NewCmdConfigSetAuthInfo(out io.Writer, configAccess clientcmd.ConfigAccess)
 
 func newCmdConfigSetAuthInfo(out io.Writer, options *createAuthInfoOptions) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     fmt.Sprintf("set-credentials NAME [--%v=path/to/certfile] [--%v=path/to/keyfile] [--%v=bearer_token] [--%v=basic_user] [--%v=basic_password] [--%v=provider_name] [--%v=key=value]", clientcmd.FlagCertFile, clientcmd.FlagKeyFile, clientcmd.FlagBearerToken, clientcmd.FlagUsername, clientcmd.FlagPassword, flagAuthProvider, flagAuthProviderArg),
+		Use: fmt.Sprintf("set-credentials NAME [--%v=path/to/certfile] [--%v=path/to/keyfile] [--%v=bearer_token] [--%v=basic_user] [--%v=basic_password] [--%v=provider_name] [--%v=key=value]", clientcmd.FlagCertFile, clientcmd.FlagKeyFile, clientcmd.FlagBearerToken, clientcmd.FlagUsername, clientcmd.FlagPassword, flagAuthProvider, flagAuthProviderArg),
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Sets a user entry in kubeconfig"),
 		Long:    create_authinfo_long,
 		Example: create_authinfo_example,

pkg/kubectl/cmd/config/create_cluster.go

@@ -63,7 +63,8 @@ func NewCmdConfigSetCluster(out io.Writer, configAccess clientcmd.ConfigAccess)
 	options := &createClusterOptions{configAccess: configAccess}
 
 	cmd := &cobra.Command{
-		Use:     fmt.Sprintf("set-cluster NAME [--%v=server] [--%v=path/to/certificate/authority] [--%v=true]", clientcmd.FlagAPIServer, clientcmd.FlagCAFile, clientcmd.FlagInsecure),
+		Use: fmt.Sprintf("set-cluster NAME [--%v=server] [--%v=path/to/certificate/authority] [--%v=true]", clientcmd.FlagAPIServer, clientcmd.FlagCAFile, clientcmd.FlagInsecure),
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Sets a cluster entry in kubeconfig"),
 		Long:    create_cluster_long,
 		Example: create_cluster_example,

pkg/kubectl/cmd/config/create_context.go

@@ -54,7 +54,8 @@ func NewCmdConfigSetContext(out io.Writer, configAccess clientcmd.ConfigAccess)
 	options := &createContextOptions{configAccess: configAccess}
 
 	cmd := &cobra.Command{
-		Use:     fmt.Sprintf("set-context NAME [--%v=cluster_nickname] [--%v=user_nickname] [--%v=namespace]", clientcmd.FlagClusterName, clientcmd.FlagAuthInfoName, clientcmd.FlagNamespace),
+		Use: fmt.Sprintf("set-context NAME [--%v=cluster_nickname] [--%v=user_nickname] [--%v=namespace]", clientcmd.FlagClusterName, clientcmd.FlagAuthInfoName, clientcmd.FlagNamespace),
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Sets a context entry in kubeconfig"),
 		Long:    create_context_long,
 		Example: create_context_example,

pkg/kubectl/cmd/config/delete_cluster.go

@@ -35,7 +35,8 @@ var (
 
 func NewCmdConfigDeleteCluster(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "delete-cluster NAME",
+		Use: "delete-cluster NAME",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Delete the specified cluster from the kubeconfig"),
 		Long:    "Delete the specified cluster from the kubeconfig",
 		Example: delete_cluster_example,

pkg/kubectl/cmd/config/delete_context.go

@@ -35,7 +35,8 @@ var (
 
 func NewCmdConfigDeleteContext(out, errOut io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "delete-context NAME",
+		Use: "delete-context NAME",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Delete the specified context from the kubeconfig"),
 		Long:    "Delete the specified context from the kubeconfig",
 		Example: delete_context_example,

pkg/kubectl/cmd/config/get_contexts.go

@@ -61,7 +61,8 @@ func NewCmdConfigGetContexts(out io.Writer, configAccess clientcmd.ConfigAccess)
 	options := &GetContextsOptions{configAccess: configAccess}
 
 	cmd := &cobra.Command{
-		Use:     "get-contexts [(-o|--output=)name)]",
+		Use: "get-contexts [(-o|--output=)name)]",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Describe one or many contexts"),
 		Long:    getContextsLong,
 		Example: getContextsExample,

pkg/kubectl/cmd/config/rename_context.go

@@ -61,7 +61,8 @@ func NewCmdConfigRenameContext(out io.Writer, configAccess clientcmd.ConfigAcces
 	options := &RenameContextOptions{configAccess: configAccess}
 
 	cmd := &cobra.Command{
-		Use:     renameContextUse,
+		Use: renameContextUse,
+		DisableFlagsInUseLine: true,
 		Short:   renameContextShort,
 		Long:    renameContextLong,
 		Example: renameContextExample,

pkg/kubectl/cmd/config/set.go

@@ -56,7 +56,8 @@ func NewCmdConfigSet(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.
 	options := &setOptions{configAccess: configAccess}
 
 	cmd := &cobra.Command{
-		Use:   "set PROPERTY_NAME PROPERTY_VALUE",
+		Use: "set PROPERTY_NAME PROPERTY_VALUE",
+		DisableFlagsInUseLine: true,
 		Short: i18n.T("Sets an individual value in a kubeconfig file"),
 		Long:  set_long,
 		Run: func(cmd *cobra.Command, args []string) {

pkg/kubectl/cmd/config/unset.go

@@ -44,7 +44,8 @@ func NewCmdConfigUnset(out io.Writer, configAccess clientcmd.ConfigAccess) *cobr
 	options := &unsetOptions{configAccess: configAccess}
 
 	cmd := &cobra.Command{
-		Use:   "unset PROPERTY_NAME",
+		Use: "unset PROPERTY_NAME",
+		DisableFlagsInUseLine: true,
 		Short: i18n.T("Unsets an individual value in a kubeconfig file"),
 		Long:  unset_long,
 		Run: func(cmd *cobra.Command, args []string) {

pkg/kubectl/cmd/config/use_context.go

@@ -45,7 +45,8 @@ func NewCmdConfigUseContext(out io.Writer, configAccess clientcmd.ConfigAccess)
 	options := &useContextOptions{configAccess: configAccess}
 
 	cmd := &cobra.Command{
-		Use:     "use-context CONTEXT_NAME",
+		Use: "use-context CONTEXT_NAME",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Sets the current-context in a kubeconfig file"),
 		Aliases: []string{"use"},
 		Long:    `Sets the current-context in a kubeconfig file`,

pkg/kubectl/cmd/convert.go

@@ -65,7 +65,8 @@ func NewCmdConvert(f cmdutil.Factory, out io.Writer) *cobra.Command {
 	options := &ConvertOptions{}
 
 	cmd := &cobra.Command{
-		Use:     "convert -f FILENAME",
+		Use: "convert -f FILENAME",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Convert config files between different API versions"),
 		Long:    convert_long,
 		Example: convert_example,

pkg/kubectl/cmd/cp.go

@@ -64,7 +64,8 @@ var (
 // NewCmdCp creates a new Copy command.
 func NewCmdCp(f cmdutil.Factory, cmdOut, cmdErr io.Writer) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "cp <file-spec-src> <file-spec-dest>",
+		Use: "cp <file-spec-src> <file-spec-dest>",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Copy files and directories to and from containers."),
 		Long:    "Copy files and directories to and from containers.",
 		Example: cpExample,

pkg/kubectl/cmd/create.go

@@ -65,7 +65,8 @@ func NewCmdCreate(f cmdutil.Factory, out, errOut io.Writer) *cobra.Command {
 	var options CreateOptions
 
 	cmd := &cobra.Command{
-		Use:     "create -f FILENAME",
+		Use: "create -f FILENAME",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Create a resource from a file or from stdin."),
 		Long:    createLong,
 		Example: createExample,

pkg/kubectl/cmd/create_clusterrole.go

@@ -66,7 +66,8 @@ func NewCmdCreateClusterRole(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command
 		},
 	}
 	cmd := &cobra.Command{
-		Use:     "clusterrole NAME --verb=verb --resource=resource.group [--resource-name=resourcename] [--dry-run]",
+		Use: "clusterrole NAME --verb=verb --resource=resource.group [--resource-name=resourcename] [--dry-run]",
+		DisableFlagsInUseLine: true,
 		Short:   clusterRoleLong,
 		Long:    clusterRoleLong,
 		Example: clusterRoleExample,

pkg/kubectl/cmd/create_clusterrolebinding.go

@@ -39,7 +39,8 @@ var (
 // ClusterRoleBinding is a command to ease creating ClusterRoleBindings.
 func NewCmdCreateClusterRoleBinding(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "clusterrolebinding NAME --clusterrole=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]",
+		Use: "clusterrolebinding NAME --clusterrole=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]",
+		DisableFlagsInUseLine: true,
 		Short:   i18n.T("Create a ClusterRoleBinding for a particular ClusterRole"),
 		Long:    clusterRoleBindingLong,
 		Example: clusterRoleBindingExample,

pkg/kubectl/cmd/create_configmap.go

@@ -60,11 +60,12 @@ var (
 // ConfigMap is a command to ease creating ConfigMaps.
 func NewCmdCreateConfigMap(f cmdutil.Factory, cmdOut io.Writer) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]",
-		Aliases: []string{"cm"},
-		Short:   i18n.T("Create a configmap from a local file, directory or literal value"),
-		Long:    configMapLong,
-		Example: configMapExample,
+		Use: "configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]",
+		DisableFlagsInUseLine: true,
+		Aliases:               []string{"cm"},
+		Short:                 i18n.T("Create a configmap from a local file, directory or literal value"),
+		Long:                  configMapLong,
+		Example:               configMapExample,
 		Run: func(cmd *cobra.Command, args []string) {
 			err := CreateConfigMap(f, cmdOut, cmd, args)
 			cmdutil.CheckErr(err)

pkg/kubectl/cmd/create_deployment.go

@@ -41,11 +41,12 @@ var (
 // Note that this command overlaps significantly with the `kubectl run` command.
 func NewCmdCreateDeployment(f cmdutil.Factory, cmdOut, cmdErr io.Writer) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "deployment NAME --image=image [--dry-run]",
-		Aliases: []string{"deploy"},
-		Short:   i18n.T("Create a deployment with the specified name."),
-		Long:    deploymentLong,
-		Example: deploymentExample,
+		Use: "deployment NAME --image=image [--dry-run]",
+		DisableFlagsInUseLine: true,
+		Aliases:               []string{"deploy"},
+		Short:                 i18n.T("Create a deployment with the specified name."),
+		Long:                  deploymentLong,
+		Example:               deploymentExample,
 		Run: func(cmd *cobra.Command, args []string) {
 			err := createDeployment(f, cmdOut, cmdErr, cmd, args)
 			cmdutil.CheckErr(err)