Merge pull request kubernetes#76638 from SataQiu/clean-command-kubeadm-20190416

[kubeadm] clean up command description information for consistency and readability

Author: k8s-ci-robot

cmd/kubeadm/app/cmd/alpha/certs.go

@@ -34,12 +34,12 @@ import (
 
 var (
 	genericLongDesc = normalizer.LongDesc(`
-		Renews the %[1]s, and saves them into %[2]s.cert and %[2]s.key files.
+		Renew the %[1]s, and save them into %[2]s.cert and %[2]s.key files.
 
     Extra attributes such as SANs will be based on the existing certificates, there is no need to resupply them.
 `)
 	allLongDesc = normalizer.LongDesc(`
-    Renews all known certificates necessary to run the control plane. Renewals are run unconditionally, regardless
+    Renew all known certificates necessary to run the control plane. Renewals are run unconditionally, regardless
     of expiration date. Renewals can also be run individually for more control.
 `)
 )
@@ -60,7 +60,7 @@ func newCmdCertsUtility() *cobra.Command {
 func newCmdCertsRenewal() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "renew",
-		Short: "Renews certificates for a Kubernetes cluster",
+		Short: "Renew certificates for a Kubernetes cluster",
 		Long:  cmdutil.MacroCommandLongDescription,
 		RunE:  cmdutil.SubCmdRunE("renew"),
 	}
@@ -107,7 +107,7 @@ func getRenewSubCommands() []*cobra.Command {
 
 	allCmd := &cobra.Command{
 		Use:   "all",
-		Short: "renew all available certificates",
+		Short: "Renew all available certificates",
 		Long:  allLongDesc,
 		Run: func(*cobra.Command, []string) {
 			for _, f := range funcList {
@@ -156,7 +156,7 @@ func generateRenewalFunction(cert *certsphase.KubeadmCert, caCert *certsphase.Ku
 func generateRenewalCommand(cert *certsphase.KubeadmCert, cfg *renewConfig) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   cert.Name,
-		Short: fmt.Sprintf("Generates the %s", cert.LongName),
+		Short: fmt.Sprintf("Generate the %s", cert.LongName),
 		Long:  fmt.Sprintf(genericLongDesc, cert.LongName, cert.BaseName),
 	}
 	addFlags(cmd, cfg)

cmd/kubeadm/app/cmd/alpha/kubeconfig.go

@@ -37,11 +37,11 @@ var (
 	` + cmdutil.AlphaDisclaimer)
 
 	userKubeconfigLongDesc = normalizer.LongDesc(`
-	Outputs a kubeconfig file for an additional user.
+	Output a kubeconfig file for an additional user.
 	` + cmdutil.AlphaDisclaimer)
 
 	userKubeconfigExample = normalizer.Examples(`
-	# Outputs a kubeconfig file for an additional user named foo
+	# Output a kubeconfig file for an additional user named foo
 	kubeadm alpha kubeconfig user --client-name=foo
 	`)
 )
@@ -72,7 +72,7 @@ func newCmdUserKubeConfig(out io.Writer) *cobra.Command {
 	// Creates the UX Command
 	cmd := &cobra.Command{
 		Use:     "user",
-		Short:   "Outputs a kubeconfig file for an additional user",
+		Short:   "Output a kubeconfig file for an additional user",
 		Long:    userKubeconfigLongDesc,
 		Example: userKubeconfigExample,
 		Run: func(cmd *cobra.Command, args []string) {

cmd/kubeadm/app/cmd/alpha/kubelet.go

@@ -35,21 +35,21 @@ import (
 
 var (
 	kubeletConfigDownloadLongDesc = normalizer.LongDesc(`
-		Downloads the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster,
+		Download the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster,
 		where X is the minor version of the kubelet. Either kubeadm autodetects the kubelet version by exec-ing
 		"kubelet --version" or respects the --kubelet-version parameter.
 		` + cmdutil.AlphaDisclaimer)
 
 	kubeletConfigDownloadExample = normalizer.Examples(fmt.Sprintf(`
-		# Downloads the kubelet configuration from the ConfigMap in the cluster. Autodetects the kubelet version.
+		# Download the kubelet configuration from the ConfigMap in the cluster. Autodetect the kubelet version.
 		kubeadm alpha phase kubelet config download
 
-		# Downloads the kubelet configuration from the ConfigMap in the cluster. Uses a specific desired kubelet version.
+		# Download the kubelet configuration from the ConfigMap in the cluster. Use a specific desired kubelet version.
 		kubeadm alpha phase kubelet config download --kubelet-version %s
 		`, constants.CurrentKubernetesVersion))
 
 	kubeletConfigEnableDynamicLongDesc = normalizer.LongDesc(`
-		Enables or updates dynamic kubelet configuration for a Node, against the kubelet-config-1.X ConfigMap in the cluster,
+		Enable or update dynamic kubelet configuration for a Node, against the kubelet-config-1.X ConfigMap in the cluster,
 		where X is the minor version of the desired kubelet version.
 
 		WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it
@@ -58,7 +58,7 @@ var (
 		` + cmdutil.AlphaDisclaimer)
 
 	kubeletConfigEnableDynamicExample = normalizer.Examples(fmt.Sprintf(`
-		# Enables dynamic kubelet configuration for a Node.
+		# Enable dynamic kubelet configuration for a Node.
 		kubeadm alpha phase kubelet enable-dynamic-config --node-name node-1 --kubelet-version %s
 
 		WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it
@@ -99,7 +99,7 @@ func newCmdKubeletConfigDownload() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:     "download",
-		Short:   "Downloads the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet.",
+		Short:   "Download the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet",
 		Long:    kubeletConfigDownloadLongDesc,
 		Example: kubeletConfigDownloadExample,
 		Run: func(cmd *cobra.Command, args []string) {
@@ -134,7 +134,7 @@ func newCmdKubeletConfigEnableDynamic() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:     "enable-dynamic",
-		Short:   "EXPERIMENTAL: Enables or updates dynamic kubelet configuration for a Node",
+		Short:   "EXPERIMENTAL: Enable or update dynamic kubelet configuration for a Node",
 		Long:    kubeletConfigEnableDynamicLongDesc,
 		Example: kubeletConfigEnableDynamicExample,
 		Run: func(cmd *cobra.Command, args []string) {

cmd/kubeadm/app/cmd/alpha/selfhosting.go

@@ -46,14 +46,14 @@ import (
 
 var (
 	selfhostingLongDesc = normalizer.LongDesc(`
-		Converts static Pod files for control plane components into self-hosted DaemonSets configured via the Kubernetes API.
+		Convert static Pod files for control plane components into self-hosted DaemonSets configured via the Kubernetes API.
 
 		See the documentation for self-hosting limitations.
 
 		` + cmdutil.AlphaDisclaimer)
 
 	selfhostingExample = normalizer.Examples(`
-		# Converts a static Pod-hosted control plane into a self-hosted one.
+		# Convert a static Pod-hosted control plane into a self-hosted one.
 
 		kubeadm alpha phase self-hosting convert-from-staticpods
 		`)
@@ -64,7 +64,7 @@ func NewCmdSelfhosting(in io.Reader) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "selfhosting",
 		Aliases: []string{"selfhosted", "self-hosting"},
-		Short:   "Makes a kubeadm cluster self-hosted",
+		Short:   "Make a kubeadm cluster self-hosted",
 		Long:    cmdutil.MacroCommandLongDescription,
 	}
 
@@ -86,7 +86,7 @@ func getSelfhostingSubCommand(in io.Reader) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "pivot",
 		Aliases: []string{"from-staticpods"},
-		Short:   "Converts a static Pod-hosted control plane into a self-hosted one",
+		Short:   "Convert a static Pod-hosted control plane into a self-hosted one",
 		Long:    selfhostingLongDesc,
 		Example: selfhostingExample,
 		Run: func(cmd *cobra.Command, args []string) {

cmd/kubeadm/app/cmd/completion.go

@@ -102,7 +102,7 @@ func GetSupportedShells() []string {
 func NewCmdCompletion(out io.Writer, boilerPlate string) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "completion SHELL",
-		Short:   "Output shell completion code for the specified shell (bash or zsh).",
+		Short:   "Output shell completion code for the specified shell (bash or zsh)",
 		Long:    completionLong,
 		Example: completionExample,
 		Run: func(cmd *cobra.Command, args []string) {

cmd/kubeadm/app/cmd/config.go

@@ -64,7 +64,7 @@ func NewCmdConfig(out io.Writer) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "config",
-		Short: "Manage configuration for a kubeadm cluster persisted in a ConfigMap in the cluster.",
+		Short: "Manage configuration for a kubeadm cluster persisted in a ConfigMap in the cluster",
 		Long: fmt.Sprintf(dedent.Dedent(`
 			There is a ConfigMap in the %s namespace called %q that kubeadm uses to store internal configuration about the
 			cluster. kubeadm CLI v1.8.0+ automatically creates this ConfigMap with the config used with 'kubeadm init', but if you
@@ -223,7 +223,7 @@ func NewCmdConfigMigrate(out io.Writer) *cobra.Command {
 	var oldCfgPath, newCfgPath string
 	cmd := &cobra.Command{
 		Use:   "migrate",
-		Short: "Read an older version of the kubeadm configuration API types from a file, and output the similar config object for the newer version.",
+		Short: "Read an older version of the kubeadm configuration API types from a file, and output the similar config object for the newer version",
 		Long: fmt.Sprintf(dedent.Dedent(`
 			This command lets you convert configuration objects of older versions to the latest supported version,
 			locally in the CLI tool without ever touching anything in the cluster.
@@ -267,7 +267,7 @@ func NewCmdConfigMigrate(out io.Writer) *cobra.Command {
 func NewCmdConfigUpload(out io.Writer, kubeConfigFile *string) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "upload",
-		Short: "Upload configuration about the current state, so that 'kubeadm upgrade' can later know how to configure the upgraded cluster.",
+		Short: "Upload configuration about the current state, so that 'kubeadm upgrade' can later know how to configure the upgraded cluster",
 		RunE:  cmdutil.SubCmdRunE("upload"),
 	}
 
@@ -280,7 +280,7 @@ func NewCmdConfigUpload(out io.Writer, kubeConfigFile *string) *cobra.Command {
 func NewCmdConfigView(out io.Writer, kubeConfigFile *string) *cobra.Command {
 	return &cobra.Command{
 		Use:   "view",
-		Short: "View the kubeadm configuration stored inside the cluster.",
+		Short: "View the kubeadm configuration stored inside the cluster",
 		Long: fmt.Sprintf(dedent.Dedent(`
 			Using this command, you can view the ConfigMap in the cluster where the configuration for kubeadm is located.
 
@@ -303,7 +303,7 @@ func NewCmdConfigUploadFromFile(out io.Writer, kubeConfigFile *string) *cobra.Co
 	var cfgPath string
 	cmd := &cobra.Command{
 		Use:   "from-file",
-		Short: "Upload a configuration file to the in-cluster ConfigMap for kubeadm configuration.",
+		Short: "Upload a configuration file to the in-cluster ConfigMap for kubeadm configuration",
 		Long: fmt.Sprintf(dedent.Dedent(`
 			Using this command, you can upload configuration to the ConfigMap in the cluster using the same config file you gave to 'kubeadm init'.
 			If you initialized your cluster using a v1.7.x or lower kubeadm client and used the --config option, you need to run this command with the
@@ -343,7 +343,7 @@ func NewCmdConfigUploadFromFlags(out io.Writer, kubeConfigFile *string) *cobra.C
 
 	cmd := &cobra.Command{
 		Use:   "from-flags",
-		Short: "Create the in-cluster configuration file for the first time from using flags.",
+		Short: "Create the in-cluster configuration file for the first time from using flags",
 		Long: fmt.Sprintf(dedent.Dedent(`
 			Using this command, you can upload configuration to the ConfigMap in the cluster using the same flags you gave to 'kubeadm init'.
 			If you initialized your cluster using a v1.7.x or lower kubeadm client and set certain flags, you need to run this command with the
@@ -397,7 +397,7 @@ func RunConfigView(out io.Writer, client clientset.Interface) error {
 func NewCmdConfigImages(out io.Writer) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "images",
-		Short: "Interact with container images used by kubeadm.",
+		Short: "Interact with container images used by kubeadm",
 		RunE:  cmdutil.SubCmdRunE("images"),
 	}
 	cmd.AddCommand(NewCmdConfigImagesList(out, nil))
@@ -414,7 +414,7 @@ func NewCmdConfigImagesPull() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "pull",
-		Short: "Pull images used by kubeadm.",
+		Short: "Pull images used by kubeadm",
 		Run: func(_ *cobra.Command, _ []string) {
 			externalcfg.ClusterConfiguration.FeatureGates, err = features.NewFeatureGate(&features.InitFeatureGates, featureGatesString)
 			kubeadmutil.CheckErr(err)
@@ -472,7 +472,7 @@ func NewCmdConfigImagesList(out io.Writer, mockK8sVersion *string) *cobra.Comman
 
 	cmd := &cobra.Command{
 		Use:   "list",
-		Short: "Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized.",
+		Short: "Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized",
 		Run: func(_ *cobra.Command, _ []string) {
 			externalcfg.ClusterConfiguration.FeatureGates, err = features.NewFeatureGate(&features.InitFeatureGates, featureGatesString)
 			kubeadmutil.CheckErr(err)

cmd/kubeadm/app/cmd/init.go

@@ -135,7 +135,7 @@ func NewCmdInit(out io.Writer, initOptions *initOptions) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "init",
-		Short: "Run this command in order to set up the Kubernetes control plane.",
+		Short: "Run this command in order to set up the Kubernetes control plane",
 		Run: func(cmd *cobra.Command, args []string) {
 			c, err := initRunner.InitData(args)
 			kubeadmutil.CheckErr(err)

cmd/kubeadm/app/cmd/phases/init/addons.go

@@ -31,38 +31,38 @@ import (
 
 var (
 	coreDNSAddonLongDesc = normalizer.LongDesc(`
-		Installs the CoreDNS addon components via the API server.
+		Install the CoreDNS addon components via the API server.
 		Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed.
 		`)
 
 	kubeProxyAddonLongDesc = normalizer.LongDesc(`
-		Installs the kube-proxy addon components via the API server.
+		Install the kube-proxy addon components via the API server.
 		`)
 )
 
 // NewAddonPhase returns the addon Cobra command
 func NewAddonPhase() workflow.Phase {
 	return workflow.Phase{
 		Name:  "addon",
-		Short: "Installs required addons for passing Conformance tests",
+		Short: "Install required addons for passing Conformance tests",
 		Long:  cmdutil.MacroCommandLongDescription,
 		Phases: []workflow.Phase{
 			{
 				Name:           "all",
-				Short:          "Installs all the addons",
+				Short:          "Install all the addons",
 				InheritFlags:   getAddonPhaseFlags("all"),
 				RunAllSiblings: true,
 			},
 			{
 				Name:         "coredns",
-				Short:        "Installs the CoreDNS addon to a Kubernetes cluster",
+				Short:        "Install the CoreDNS addon to a Kubernetes cluster",
 				Long:         coreDNSAddonLongDesc,
 				InheritFlags: getAddonPhaseFlags("coredns"),
 				Run:          runCoreDNSAddon,
 			},
 			{
 				Name:         "kube-proxy",
-				Short:        "Installs the kube-proxy addon to a Kubernetes cluster",
+				Short:        "Install the kube-proxy addon to a Kubernetes cluster",
 				Long:         kubeProxyAddonLongDesc,
 				InheritFlags: getAddonPhaseFlags("kube-proxy"),
 				Run:          runKubeProxyAddon,

cmd/kubeadm/app/cmd/phases/init/bootstraptoken.go

@@ -38,7 +38,7 @@ var (
 		`)
 
 	bootstrapTokenExamples = normalizer.Examples(`
-		# Makes all the bootstrap token configurations and creates an initial token, functionally
+		# Make all the bootstrap token configurations and create an initial token, functionally
 		# equivalent to what generated by kubeadm init.
 		kubeadm init phase bootstrap-token
 		`)

cmd/kubeadm/app/cmd/phases/init/certs.go

@@ -37,13 +37,13 @@ import (
 
 var (
 	saKeyLongDesc = fmt.Sprintf(normalizer.LongDesc(`
-		Generates the private key for signing service account tokens along with its public key, and saves them into
+		Generate the private key for signing service account tokens along with its public key, and save them into
 		%s and %s files.
 		If both files already exist, kubeadm skips the generation step and existing files will be used.
 		`+cmdutil.AlphaDisclaimer), kubeadmconstants.ServiceAccountPrivateKeyName, kubeadmconstants.ServiceAccountPublicKeyName)
 
 	genericLongDesc = normalizer.LongDesc(`
-		Generates the %[1]s, and saves them into %[2]s.cert and %[2]s.key files.%[3]s
+		Generate the %[1]s, and save them into %[2]s.cert and %[2]s.key files.%[3]s
 
 		If both files already exist, kubeadm skips the generation step and existing files will be used.
 		` + cmdutil.AlphaDisclaimer)
@@ -79,7 +79,7 @@ func newCertSubPhases() []workflow.Phase {
 	// All subphase
 	allPhase := workflow.Phase{
 		Name:           "all",
-		Short:          "Generates all certificates",
+		Short:          "Generate all certificates",
 		InheritFlags:   getCertPhaseFlags("all"),
 		RunAllSiblings: true,
 	}
@@ -102,7 +102,7 @@ func newCertSubPhases() []workflow.Phase {
 	// SA creates the private/public key pair, which doesn't use x509 at all
 	saPhase := workflow.Phase{
 		Name:         "sa",
-		Short:        "Generates a private key for signing service account tokens along with its public key",
+		Short:        "Generate a private key for signing service account tokens along with its public key",
 		Long:         saKeyLongDesc,
 		Run:          runCertsSa,
 		InheritFlags: []string{options.CertificatesDir},
@@ -116,7 +116,7 @@ func newCertSubPhases() []workflow.Phase {
 func newCertSubPhase(certSpec *certsphase.KubeadmCert, run func(c workflow.RunData) error) workflow.Phase {
 	phase := workflow.Phase{
 		Name:  certSpec.Name,
-		Short: fmt.Sprintf("Generates the %s", certSpec.LongName),
+		Short: fmt.Sprintf("Generate the %s", certSpec.LongName),
 		Long: fmt.Sprintf(
 			genericLongDesc,
 			certSpec.LongName,