add more examples, add other missing commands

cmd/client/commandv2/general.go

@@ -22,6 +22,7 @@ import (
  "net/http"
  "os"
  "sort"
+ "strings"
 
  "github.com/megaease/easegress/cmd/client/general"
  "github.com/megaease/easegress/pkg/api"
@@ -106,3 +107,58 @@ func APIsCmd() *cobra.Command {
 
  return cmd
 }
+
+func APIResourcesCmd() *cobra.Command {
+ resourceCmds := []*cobra.Command{
+ GetCmd(),
+ ApplyCmd(),
+ CreateCmd(),
+ DeleteCmd(),
+ DescribeCmd(),
+ }
+
+ actionMap := map[string][]string{}
+ aliasMap := map[string]string{}
+ for _, cmd := range resourceCmds {
+ action, resources, resourceAlias := getApiResource(cmd)
+ for i, r := range resources {
+ actionMap[r] = append(actionMap[r], action)
+ aliasMap[r] = resourceAlias[i]
+ }
+ }
+
+ for _, v := range actionMap {
+ sort.Strings(v)
+ }
+
+ cmd := &cobra.Command{
+ Use: "api-resources",
+ Short: "View all API resources",
+ Run: func(cmd *cobra.Command, args []string) {
+ tables := [][]string{}
+ for resource, actions := range actionMap {
+ tables = append(tables, []string{resource, aliasMap[resource], strings.Join(actions, ",")})
+ }
+ sort.Slice(tables, func(i, j int) bool {
+ return tables[i][0] < tables[j][0]
+ })
+ tables = append([][]string{{"RESOURCE", "ALIAS", "ACTIONS"}}, tables...)
+ general.PrintTable(tables)
+ },
+ }
+ return cmd
+}
+
+func getApiResource(actionCmd *cobra.Command) (string, []string, []string) {
+ resources := []string{}
+ resourceAlias := []string{}
+ for _, cmd := range actionCmd.Commands() {
+ resources = append(resources, cmd.Name())
+ alias := cmd.Aliases
+ sort.Slice(alias, func(i, j int) bool {
+ return len(alias[i]) < len(alias[j])
+ })
+ resourceAlias = append(resourceAlias, strings.Join(alias, ","))
+ }
+ return actionCmd.Name(), resources, resourceAlias
+}

cmd/client/main.go

@@ -69,10 +69,10 @@ func main() {
 
  addCommandWithGroup(
  basicGroup,
- commandv2.GetCmd(),
- commandv2.DescribeCmd(),
  commandv2.CreateCmd(),
  commandv2.DeleteCmd(),
+ commandv2.GetCmd(),
+ commandv2.DescribeCmd(),
  commandv2.ApplyCmd(),
  )
 
@@ -82,6 +82,7 @@ func main() {
  commandv2.CompletionCmd(),
  commandv2.HealthCmd(),
  commandv2.ProfileCmd(),
+ commandv2.APIResourcesCmd(),
  )
 
  addCommandWithGroup(

cmd/client/resources/alias.go

@@ -22,3 +22,4 @@ import "github.com/megaease/easegress/cmd/client/general"
 var makeURL = general.MakeURL
 var handleReq = general.HandleRequest
 var createExample = general.CreateExample
+var createMultiExample = general.CreateMultiExample

cmd/client/resources/customdata.go

@@ -70,6 +70,11 @@ func customDataKindApplyCmd() []*cobra.Command {
 }
 
 func describeCustomDataKinds() *cobra.Command {
+ examples := []general.Example{
+ {Desc: "Describe all custom data kinds", Command: "egctl describe customdatakind"},
+ {Desc: "Describe certain custom data kind", Command: "egctl describe customdatakind <custom-data-kind>"},
+ }
+
  cmd := &cobra.Command{
  Use: CustomDataKindName,
  Short: "Describe one or many custom data kinds",
@@ -80,6 +85,7 @@ func describeCustomDataKinds() *cobra.Command {
  }
  return nil
  },
+ Example: createMultiExample(examples),
  Run: func(cmd *cobra.Command, args []string) {
  body, err := httpGetCustomDataKind(cmd, args)
  if err != nil {
@@ -113,6 +119,11 @@ func httpGetCustomDataKind(cmd *cobra.Command, args []string) ([]byte, error) {
 }
 
 func getCustomDataKinds() *cobra.Command {
+ examples := []general.Example{
+ {Desc: "Get all custom data kinds", Command: "egctl get customdatakind"},
+ {Desc: "Get certain custom data kind", Command: "egctl get customdatakind <custom-data-kind>"},
+ }
+
  cmd := &cobra.Command{
  Use: CustomDataKindName,
  Short: "Display one or many custom data kinds",
@@ -123,6 +134,7 @@ func getCustomDataKinds() *cobra.Command {
  }
  return nil
  },
+ Example: createMultiExample(examples),
  Run: func(cmd *cobra.Command, args []string) {
  body, err := httpGetCustomDataKind(cmd, args)
  if err != nil {
@@ -187,6 +199,7 @@ func createCustomDataKind() *cobra.Command {
  Use: CustomDataKindName,
  Short: "Create a custom data kind from a yaml file or stdin",
  Aliases: CustomDataKindAlias(),
+ Example: createExample("Create a custom data kind from a yaml file", "egctl create -f <custom-data-kind>.yaml"),
  Run: func(cmd *cobra.Command, args []string) {
  visitor := buildYAMLVisitor(specFile, cmd)
  visitor.Visit(func(yamlDoc []byte) error {
@@ -203,7 +216,6 @@ func createCustomDataKind() *cobra.Command {
  }
 
  cmd.Flags().StringVarP(&specFile, "file", "f", "", "A yaml file containing custom data kind spec")
-
  return cmd
 }
 
@@ -218,6 +230,7 @@ func deleteCustomDataKind() *cobra.Command {
  }
  return nil
  },
+ Example: createExample("Delete a custom data kind", "egctl delete customdatakind <custom-data-kind>"),
  Run: func(cmd *cobra.Command, args []string) {
  _, err := handleReq(http.MethodDelete, makeURL(general.CustomDataKindItemURL, args[0]), nil, cmd)
  if err != nil {
@@ -257,6 +270,7 @@ func applyCustomDataKind() *cobra.Command {
  Use: CustomDataKindName,
  Short: "Apply a custom data kind from a yaml file or stdin",
  Aliases: CustomDataKindAlias(),
+ Example: createExample("Apply a custom data kind from a yaml file", "egctl apply -f <custom-data-kind>.yaml"),
  Run: func(cmd *cobra.Command, args []string) {
  visitor := buildYAMLVisitor(specFile, cmd)
  visitor.Visit(func(yamlDoc []byte) error {
@@ -354,6 +368,11 @@ func getCertainCustomDataKind(cmd *cobra.Command, kindName string) (*customdata.
 }
 
 func getCustomData() *cobra.Command {
+ examples := []general.Example{
+ {Desc: "Get all custom data of certain kind", Command: "egctl get customdata <custom-data-kind>"},
+ {Desc: "Get a certain custom data of certain kind", Command: "egctl get customdata <custom-data-kind> <custom-data-id>"},
+ }
+
  cmd := &cobra.Command{
  Use: CustomDataName,
  Short: "Display one or many custom data of given kind",
@@ -364,6 +383,7 @@ func getCustomData() *cobra.Command {
  }
  return nil
  },
+ Example: createMultiExample(examples),
  Run: func(cmd *cobra.Command, args []string) {
  body, err := httpGetCustomData(cmd, args)
  if err != nil {
@@ -392,6 +412,11 @@ func getCustomData() *cobra.Command {
 }
 
 func describeCustomData() *cobra.Command {
+ examples := []general.Example{
+ {Desc: "Describe all custom data of certain kind", Command: "egctl describe customdata <custom-data-kind>"},
+ {Desc: "Describe a certain custom data of certain kind", Command: "egctl describe customdata <custom-data-kind> <custom-data-id>"},
+ }
+
  cmd := &cobra.Command{
  Use: CustomDataName,
  Short: "Describe one or many custom data of given kind",
@@ -402,6 +427,7 @@ func describeCustomData() *cobra.Command {
  }
  return nil
  },
+ Example: createMultiExample(examples),
  Run: func(cmd *cobra.Command, args []string) {
  body, err := httpGetCustomData(cmd, args)
  if err != nil {
@@ -462,6 +488,7 @@ func createCustomData() *cobra.Command {
  }
  return nil
  },
+ Example: createExample("Create a custom data from a yaml file", "egctl create customdata <custom-data-kind> -f <custom-data>.yaml"),
  Run: func(cmd *cobra.Command, args []string) {
  visitor := buildYAMLVisitor(specFile, cmd)
  visitor.Visit(func(yamlDoc []byte) error {
@@ -492,6 +519,7 @@ func deleteCustomData() *cobra.Command {
  }
  return nil
  },
+ Example: createExample("Delete a custom data item", "egctl delete customdata <custom-data-kind> <custom-data-id>"),
  Run: func(cmd *cobra.Command, args []string) {
  _, err := handleReq(http.MethodDelete, makeURL(general.CustomDataItemURL, args[0], args[1]), nil, cmd)
  if err != nil {
@@ -506,6 +534,11 @@ func deleteCustomData() *cobra.Command {
 }
 
 func applyCustomData() *cobra.Command {
+ examples := []general.Example{
+ {Desc: "Apply a custom data from a yaml file", Command: "egctl apply customdata <custom-data-kind> -f <custom-data>.yaml"},
+ {Desc: "Apply a batch update for custom data", Command: "egctl apply customdata <custom-data-kind> -f <custom-data>.yaml --batch-update"},
+ }
+
  var specFile string
  var batchUpdate bool
 
@@ -585,6 +618,7 @@ func applyCustomData() *cobra.Command {
  }
  return nil
  },
+ Example: createMultiExample(examples),
  Run: func(cmd *cobra.Command, args []string) {
  if batchUpdate {
  applyBatch(cmd, args)

cmd/client/resources/member.go

@@ -19,6 +19,7 @@ package resources
 
 import (
  "errors"
+ "fmt"
  "net/http"
  "reflect"
  "strings"
@@ -42,12 +43,19 @@ func memberCmd(cmdType general.CmdType) []*cobra.Command {
  return memberGetCmd()
  case general.DescribeCmd:
  return memberDescribeCmd()
+ case general.DeleteCmd:
+ return memberDeleteCmd()
  default:
  return nil
  }
 }
 
 func memberDescribeCmd() []*cobra.Command {
+ examples := []general.Example{
+ {Desc: "Describe all members", Command: "egctl describe member"},
+ {Desc: "Describe one member", Command: "egctl describe member <member-name>"},
+ }
+
  cmd := &cobra.Command{
  Use: MemberName,
  Short: "Describe one or many members",
@@ -58,6 +66,7 @@ func memberDescribeCmd() []*cobra.Command {
  }
  return nil
  },
+ Example: createMultiExample(examples),
  Run: func(cmd *cobra.Command, args []string) {
  body, err := handleReq(http.MethodGet, makeURL(general.MembersURL), nil, cmd)
  if err != nil {
@@ -118,7 +127,35 @@ func printMemberStatusDescription(memberStatus []*cluster.MemberStatus) {
  })
 }
 
+func memberDeleteCmd() []*cobra.Command {
+ cmd := &cobra.Command{
+ Use: MemberName,
+ Aliases: MemberAlias(),
+ Short: "Purge a Easegress member. This command should be run after the easegress node uninstalled",
+ Example: createExample("Purge a Easegress member. This command should be run after the easegress node uninstalled", "egctl delete member <member-name>"),
+ Args: func(cmd *cobra.Command, args []string) error {
+ if len(args) != 1 {
+ return errors.New("requires one member name to be deleted")
+ }
+ return nil
+ },
+ Run: func(cmd *cobra.Command, args []string) {
+ _, err := handleReq(http.MethodDelete, makeURL(general.MemberItemURL, args[0]), nil, cmd)
+ if err != nil {
+ general.ExitWithErrorf("purge member failed: %v", err)
+ }
+ fmt.Printf("purge member %s successfully\n", args[0])
+ },
+ }
+ return []*cobra.Command{cmd}
+}
+
 func memberGetCmd() []*cobra.Command {
+ examples := []general.Example{
+ {Desc: "Get all members", Command: "egctl get member"},
+ {Desc: "Get one member", Command: "egctl get member <member-name>"},
+ }
+
  cmd := &cobra.Command{
  Use: MemberName,
  Short: "Display one or many members",
@@ -129,6 +166,7 @@ func memberGetCmd() []*cobra.Command {
  }
  return nil
  },
+ Example: createMultiExample(examples),
  Run: func(cmd *cobra.Command, args []string) {
  body, err := handleReq(http.MethodGet, makeURL(general.MembersURL), nil, cmd)
  if err != nil {