Merge pull request #22003 from smarterclayton/cleanup_upgrade

Cleanup `oc adm` help for clarity

pkg/oc/cli/admin/admin.go

@@ -46,8 +46,7 @@ import (
 var adminLong = ktemplates.LongDesc(`
 	Administrative Commands
 
-	Commands for managing a cluster are exposed here. Many administrative
-	actions involve interaction with the command-line client as well.`)
+	Actions for administering an OpenShift cluster are exposed here.`)
 
 func NewCommandAdmin(name, fullName string, f kcmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command {
 	// Main command
@@ -63,35 +62,33 @@ func NewCommandAdmin(name, fullName string, f kcmdutil.Factory, streams genericc
 			Message: "Cluster Management:",
 			Commands: []*cobra.Command{
 				upgrade.New(f, fullName, streams),
-				release.NewCmd(f, fullName, streams),
-			},
-		},
-		{
-			Message: "Security and Policy:",
-			Commands: []*cobra.Command{
-				project.NewCmdNewProject(project.NewProjectRecommendedName, fullName+" "+project.NewProjectRecommendedName, f, streams),
-				policy.NewCmdPolicy(policy.PolicyRecommendedName, fullName+" "+policy.PolicyRecommendedName, f, streams),
-				groups.NewCmdGroups(groups.GroupsRecommendedName, fullName+" "+groups.GroupsRecommendedName, f, streams),
-				cert.NewCmdCert(cert.CertRecommendedName, fullName+" "+cert.CertRecommendedName, streams),
-				kubecmd.NewCmdCertificate(f, streams),
+				top.NewCommandTop(top.TopRecommendedName, fullName+" "+top.TopRecommendedName, f, streams),
 			},
 		},
 		{
 			Message: "Node Management:",
 			Commands: []*cobra.Command{
+				cmdutil.ReplaceCommandName("kubectl", fullName, kubecmd.NewCmdDrain(f, streams)),
 				cmdutil.ReplaceCommandName("kubectl", fullName, ktemplates.Normalize(kubecmd.NewCmdCordon(f, streams))),
 				cmdutil.ReplaceCommandName("kubectl", fullName, ktemplates.Normalize(kubecmd.NewCmdUncordon(f, streams))),
-				cmdutil.ReplaceCommandName("kubectl", fullName, kubecmd.NewCmdDrain(f, streams)),
 				cmdutil.ReplaceCommandName("kubectl", fullName, ktemplates.Normalize(kubecmd.NewCmdTaint(f, streams))),
-				network.NewCmdPodNetwork(network.PodNetworkCommandName, fullName+" "+network.PodNetworkCommandName, f, streams),
 				logs.NewCmdLogs(fullName, f, streams),
 			},
 		},
+		{
+			Message: "Security and Policy:",
+			Commands: []*cobra.Command{
+				project.NewCmdNewProject(project.NewProjectRecommendedName, fullName+" "+project.NewProjectRecommendedName, f, streams),
+				policy.NewCmdPolicy(policy.PolicyRecommendedName, fullName+" "+policy.PolicyRecommendedName, f, streams),
+				groups.NewCmdGroups(groups.GroupsRecommendedName, fullName+" "+groups.GroupsRecommendedName, f, streams),
+				withShortDescription(kubecmd.NewCmdCertificate(f, streams), "Approve or reject certificate requests"),
+				network.NewCmdPodNetwork(network.PodNetworkCommandName, fullName+" "+network.PodNetworkCommandName, f, streams),
+			},
+		},
 		{
 			Message: "Maintenance:",
 			Commands: []*cobra.Command{
 				prune.NewCommandPrune(prune.PruneRecommendedName, fullName+" "+prune.PruneRecommendedName, f, streams),
-				buildchain.NewCmdBuildChain(name, fullName+" "+buildchain.BuildChainRecommendedCommandName, f, streams),
 				migrate.NewCommandMigrate(
 					migrate.MigrateRecommendedName, fullName+" "+migrate.MigrateRecommendedName, f, streams,
 					// Migration commands
@@ -101,13 +98,12 @@ func NewCommandAdmin(name, fullName string, f kcmdutil.Factory, streams genericc
 					migratehpa.NewCmdMigrateLegacyHPA("legacy-hpa", fullName+" "+migrate.MigrateRecommendedName+" legacy-hpa", f, streams),
 					migratetemplateinstances.NewCmdMigrateTemplateInstances("template-instances", fullName+" "+migrate.MigrateRecommendedName+" template-instances", f, streams),
 				),
-				top.NewCommandTop(top.TopRecommendedName, fullName+" "+top.TopRecommendedName, f, streams),
-				verifyimagesignature.NewCmdVerifyImageSignature(name, fullName+" "+verifyimagesignature.VerifyRecommendedName, f, streams),
 			},
 		},
 		{
 			Message: "Configuration:",
 			Commands: []*cobra.Command{
+				cert.NewCmdCert(cert.CertRecommendedName, fullName+" "+cert.CertRecommendedName, streams),
 				admin.NewCommandCreateKubeConfig(admin.CreateKubeConfigCommandName, fullName+" "+admin.CreateKubeConfigCommandName, streams),
 				admin.NewCommandCreateClient(admin.CreateClientCommandName, fullName+" "+admin.CreateClientCommandName, streams),
 
@@ -152,6 +148,10 @@ func NewCommandAdmin(name, fullName string, f kcmdutil.Factory, streams genericc
 	}
 
 	cmds.AddCommand(
+		release.NewCmd(f, fullName, streams),
+		buildchain.NewCmdBuildChain(name, fullName+" "+buildchain.BuildChainRecommendedCommandName, f, streams),
+		verifyimagesignature.NewCmdVerifyImageSignature(name, fullName+" "+verifyimagesignature.VerifyRecommendedName, f, streams),
+
 		// part of every root command
 		kubectlwrappers.NewCmdConfig(fullName, "config", f, streams),
 		kubectlwrappers.NewCmdCompletion(fullName, streams),
@@ -166,3 +166,8 @@ func NewCommandAdmin(name, fullName string, f kcmdutil.Factory, streams genericc
 
 	return cmds
 }
+
+func withShortDescription(cmd *cobra.Command, desc string) *cobra.Command {
+	cmd.Short = desc
+	return cmd
+}

pkg/oc/cli/admin/cert/cert.go

@@ -15,7 +15,7 @@ func NewCmdCert(name, fullName string, streams genericclioptions.IOStreams) *cob
 	// Parent command to which all subcommands are added.
 	cmds := &cobra.Command{
 		Use:   name,
-		Short: "Manage certificates and keys",
+		Short: "Create CA certificates",
 		Long:  `Manage certificates and keys`,
 		Run:   cmdutil.DefaultSubCommandRun(streams.ErrOut),
 	}

pkg/oc/cli/admin/policy/policy.go

@@ -36,7 +36,7 @@ func NewCmdPolicy(name, fullName string, f cmdutil.Factory, streams genericcliop
 	// Parent command to which all subcommands are added.
 	cmds := &cobra.Command{
 		Use:   name,
-		Short: "Manage policy",
+		Short: "Manage cluster authorization and security policy",
 		Long:  policyLong,
 		Run:   cmdutil.DefaultSubCommandRun(streams.ErrOut),
 	}