docs: specify all ECE specific commands and add icons to .adoc files (#352)

Adds ECE specific text to all subcommands not just commands as it was before.

Additionally, this text is substituted for {ece-icon} on the .adoc files so our online
documentation looks better with an icon instead of text.

Author: karencfv

cmd/auth/command.go

@@ -26,7 +26,7 @@ import (
 // Command is the auth subcommand
 var Command = &cobra.Command{
 	Use:     "auth",
-	Short:   "Manages the platform auth",
+	Short:   "Manages authentication settings",
 	PreRunE: cobra.MaximumNArgs(0),
 	Run: func(cmd *cobra.Command, args []string) {
 		cmd.Help()

cmd/platform/allocator/list.go

@@ -25,6 +25,7 @@ import (
 	"github.com/elastic/cloud-sdk-go/pkg/api/platformapi/allocatorapi"
 	"github.com/spf13/cobra"
 
+	cmdutil "github.com/elastic/ecctl/cmd/util"
 	"github.com/elastic/ecctl/pkg/ecctl"
 )
 
@@ -88,7 +89,7 @@ func listAllocators(cmd *cobra.Command, args []string) error {
 
 var listAllocatorsCmd = &cobra.Command{
 	Use:     "list",
-	Short:   allocatorListMessage,
+	Short:   cmdutil.AdminReqDescription(allocatorListMessage),
 	Long:    allocatorListMessage + allocatorQueryExample + allocatorFilterExample,
 	PreRunE: cobra.MaximumNArgs(0),
 	RunE:    listAllocators,

cmd/platform/allocator/maintenance.go

@@ -23,12 +23,13 @@ import (
 	"github.com/elastic/cloud-sdk-go/pkg/api/platformapi/allocatorapi"
 	"github.com/spf13/cobra"
 
+	cmdutil "github.com/elastic/ecctl/cmd/util"
 	"github.com/elastic/ecctl/pkg/ecctl"
 )
 
 var maintenanceAllocatorCmd = &cobra.Command{
 	Use:     "maintenance <allocator id>",
-	Short:   "Sets the allocator in Maintenance mode",
+	Short:   cmdutil.AdminReqDescription("Sets the allocator in Maintenance mode"),
 	PreRunE: cobra.MinimumNArgs(1),
 
 	RunE: func(cmd *cobra.Command, args []string) error {

cmd/platform/allocator/search.go

@@ -40,7 +40,7 @@ const (
 // Command represents the allocator search command.
 var searchAllocatorCmd = &cobra.Command{
 	Use:     `search`,
-	Short:   "Performs advanced allocator searching",
+	Short:   cmdutil.AdminReqDescription("Performs advanced allocator searching"),
 	Long:    queryExamples,
 	PreRunE: cobra.MaximumNArgs(0),
 	RunE: func(cmd *cobra.Command, args []string) error {

cmd/platform/allocator/show.go

@@ -23,6 +23,7 @@ import (
 	"github.com/elastic/cloud-sdk-go/pkg/api/platformapi/allocatorapi"
 	"github.com/spf13/cobra"
 
+	cmdutil "github.com/elastic/ecctl/cmd/util"
 	"github.com/elastic/ecctl/pkg/ecctl"
 )
 
@@ -46,7 +47,7 @@ func showAllocator(cmd *cobra.Command, args []string) error {
 
 var showAllocatorCmd = &cobra.Command{
 	Use:     "show <allocator id>",
-	Short:   "Returns information about the allocator",
+	Short:   cmdutil.AdminReqDescription("Returns information about the allocator"),
 	PreRunE: cobra.MinimumNArgs(1),
 	RunE:    showAllocator,
 }

cmd/platform/allocator/vacate.go

@@ -69,7 +69,7 @@ const vacateExamples = `  ecctl platform allocator vacate i-05e245252362f7f1d
 
 var vacateAllocatorCmd = &cobra.Command{
 	Use:     "vacate <allocator-id>",
-	Short:   "Moves all the resources from the specified allocator",
+	Short:   cmdutil.AdminReqDescription("Moves all the resources from the specified allocator"),
 	Example: vacateExamples,
 	PreRunE: cobra.MinimumNArgs(1),
 	Aliases: []string{"move-nodes"},

cmd/platform/command.go

@@ -28,12 +28,13 @@ import (
 	cmdrepository "github.com/elastic/ecctl/cmd/platform/repository"
 	cmdrole "github.com/elastic/ecctl/cmd/platform/role"
 	cmdrunner "github.com/elastic/ecctl/cmd/platform/runner"
+	cmdutil "github.com/elastic/ecctl/cmd/util"
 )
 
 // Command is the platform subcommand
 var Command = &cobra.Command{
 	Use:     "platform",
-	Short:   "Manages the platform",
+	Short:   cmdutil.AdminReqDescription("Manages the platform"),
 	PreRunE: cobra.MaximumNArgs(0),
 	Run: func(cmd *cobra.Command, args []string) {
 		cmd.Help()

cmd/platform/constructor/list.go

@@ -23,12 +23,13 @@ import (
 	"github.com/elastic/cloud-sdk-go/pkg/api/platformapi/constructorapi"
 	"github.com/spf13/cobra"
 
+	cmdutil "github.com/elastic/ecctl/cmd/util"
 	"github.com/elastic/ecctl/pkg/ecctl"
 )
 
 var listConstructorsCmd = &cobra.Command{
 	Use:     "list",
-	Short:   `Returns all of the constructors in the platform`,
+	Short:   cmdutil.AdminReqDescription("Returns all of the constructors in the platform"),
 	PreRunE: cobra.NoArgs,
 	RunE:    listConstructors,
 }

cmd/platform/constructor/maintenance.go

@@ -23,12 +23,13 @@ import (
 	"github.com/elastic/cloud-sdk-go/pkg/api/platformapi/constructorapi"
 	"github.com/spf13/cobra"
 
+	cmdutil "github.com/elastic/ecctl/cmd/util"
 	"github.com/elastic/ecctl/pkg/ecctl"
 )
 
 var maintenanceConstructorCmd = &cobra.Command{
 	Use:     "maintenance <constructor id>",
-	Short:   constructorMaintenanceMessage,
+	Short:   cmdutil.AdminReqDescription(constructorMaintenanceMessage),
 	PreRunE: cobra.ExactArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		unset, _ := cmd.Flags().GetBool("unset")

cmd/platform/constructor/resync.go

@@ -21,16 +21,17 @@ import (
 	"fmt"
 
 	"github.com/elastic/cloud-sdk-go/pkg/api/platformapi/constructorapi"
-	"github.com/elastic/cloud-sdk-go/pkg/util/cmdutil"
+	sdkcmdutil "github.com/elastic/cloud-sdk-go/pkg/util/cmdutil"
 	"github.com/spf13/cobra"
 
+	cmdutil "github.com/elastic/ecctl/cmd/util"
 	"github.com/elastic/ecctl/pkg/ecctl"
 )
 
 var resyncConstructorCmd = &cobra.Command{
 	Use:     "resync {<constructor id> | --all}",
-	Short:   "Resynchronizes the search index and cache for the selected constructor or all",
-	PreRunE: cmdutil.CheckInputHas1ArgsOr0ArgAndAll,
+	Short:   cmdutil.AdminReqDescription("Resynchronizes the search index and cache for the selected constructor or all"),
+	PreRunE: sdkcmdutil.CheckInputHas1ArgsOr0ArgAndAll,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		all, _ := cmd.Flags().GetBool("all")