help command is now part of mc admin config get/set

Author: harshavardhana

cmd/admin-config-del.go

@@ -18,8 +18,6 @@ package cmd
 
 import (
 	"fmt"
-	"io/ioutil"
-	"os"
 	"strings"
 
 	"github.com/fatih/color"
@@ -29,12 +27,19 @@ import (
 	"github.com/minio/mc/pkg/probe"
 )
 
+var adminConfigEnvFlags = []cli.Flag{
+	cli.BoolFlag{
+		Name:  "env",
+		Usage: "list all the env only help",
+	},
+}
+
 var adminConfigDelCmd = cli.Command{
 	Name:   "del",
 	Usage:  "delete a key from MinIO server/cluster.",
 	Before: setGlobalsFromContext,
 	Action: mainAdminConfigDel,
-	Flags:  globalFlags,
+	Flags:  append(adminConfigEnvFlags, globalFlags...),
 	CustomHelpTemplate: `NAME:
   {{.HelpName}} - {{.Usage}}
 
@@ -100,13 +105,22 @@ func mainAdminConfigDel(ctx *cli.Context) error {
 	client, err := newAdminClient(aliasedURL)
 	fatalIf(err, "Unable to initialize admin connection.")
 
+	if len(ctx.Args()) == 1 {
+		// Call get config API
+		hr, e := client.HelpConfigKV("", "", ctx.IsSet("env"))
+		fatalIf(probe.NewError(e), "Cannot get help for the sub-system")
+
+		// Print
+		printMsg(configHelpMessage{
+			Value:   hr,
+			envOnly: ctx.IsSet("env"),
+		})
+
+		return nil
+	}
+
 	// Call del config API
 	input := strings.Join(args.Tail(), " ")
-	if len(input) == 0 {
-		b, e := ioutil.ReadAll(os.Stdin)
-		fatalIf(probe.NewError(e), "Cannot read from the os.Stdin")
-		input = string(b)
-	}
 	fatalIf(probe.NewError(client.DelConfigKV(input)),
 		"Cannot delete '%s' on the server", input)
 

cmd/admin-config-get.go

@@ -80,7 +80,7 @@ func (u configGetMessage) JSON() string {
 
 // checkAdminConfigGetSyntax - validate all the passed arguments
 func checkAdminConfigGetSyntax(ctx *cli.Context) {
-	if !ctx.Args().Present() || len(ctx.Args()) > 2 {
+	if !ctx.Args().Present() || len(ctx.Args()) < 1 {
 		cli.ShowCommandHelpAndExit(ctx, "get", 1) // last argument is exit code
 	}
 }
@@ -97,6 +97,20 @@ func mainAdminConfigGet(ctx *cli.Context) error {
 	client, err := newAdminClient(aliasedURL)
 	fatalIf(err, "Unable to initialize admin connection.")
 
+	if len(ctx.Args()) == 1 {
+		// Call get config API
+		hr, e := client.HelpConfigKV("", "", false)
+		fatalIf(probe.NewError(e), "Cannot get help for the sub-system")
+
+		// Print
+		printMsg(configHelpMessage{
+			Value:   hr,
+			envOnly: false,
+		})
+
+		return nil
+	}
+
 	// Call get config API
 	buf, e := client.GetConfigKV(strings.Join(args.Tail(), " "))
 	fatalIf(probe.NewError(e), "Cannot get server '%s' config", args.Tail())

cmd/admin-config-help.go

@@ -17,75 +17,41 @@
 package cmd
 
 import (
+	"encoding/json"
 	"strings"
 	"text/tabwriter"
 	"text/template"
 
 	"github.com/fatih/color"
-	"github.com/minio/cli"
-	json "github.com/minio/mc/pkg/colorjson"
 	"github.com/minio/mc/pkg/probe"
+	"github.com/minio/minio/pkg/madmin"
 )
 
-var helpFlags = []cli.Flag{
-	cli.BoolFlag{
-		Name:  "env",
-		Usage: "list all the env only help",
-	},
-}
-
-// Help template used by all sub-systems
-const Help = `{{colorBlueBold "Key"}}{{"\t"}}{{colorBlueBold "Description"}}
-{{colorYellowBold "----"}}{{"\t"}}{{colorYellowBold "----"}}
-{{range $key, $value := .}}{{colorCyanBold $key}}{{ "\t" }}{{$value}}
-{{end}}`
+// HelpTmpl template used by all sub-systems
+const HelpTmpl = `{{if ne .SubSys ""}}{{colorBlueBold "KEY:"}}
+{{if .MultipleTargets}}{{colorYellowBold .SubSys}}[:target]{{"\t"}}{{else}}{{colorYellowBold .SubSys}}{{"\t"}}{{end}}{{.Description}}
 
-// HelpEnv template used by all sub-systems
-const HelpEnv = `{{colorBlueBold "KeyEnv"}}{{"\t"}}{{colorBlueBold "Description"}}
-{{colorYellowBold "----"}}{{"\t"}}{{colorYellowBold "----"}}
-{{range $key, $value := .}}{{colorCyanBold $key}}{{ "\t" }}{{$value}}
-{{end}}`
+{{colorBlueBold "ARGS:"}}{{range .KeysHelp}}
+{{if .Optional}}{{colorYellowBold .Key}}{{else}}{{colorRedBold .Key}}*{{end}}{{"\t"}}({{.Type}}){{"\t"}}{{.Description}}{{end}}{{else}}{{colorBlueBold "KEYS:"}}{{range .KeysHelp}}
+{{colorRedBold .Key}}*{{"\t"}}{{.Description}}{{end}}{{end}}`
 
 var funcMap = template.FuncMap{
 	"colorBlueBold":   color.New(color.FgBlue, color.Bold).SprintfFunc(),
 	"colorYellowBold": color.New(color.FgYellow, color.Bold).SprintfFunc(),
 	"colorCyanBold":   color.New(color.FgCyan, color.Bold).SprintFunc(),
+	"colorRedBold":    color.New(color.FgRed, color.Bold).SprintfFunc(),
 }
 
 // HelpTemplate - captures config help template
-var HelpTemplate = template.Must(template.New("config-help").Funcs(funcMap).Parse(Help))
+var HelpTemplate = template.Must(template.New("config-help").Funcs(funcMap).Parse(HelpTmpl))
 
 // HelpEnvTemplate - captures config help template
-var HelpEnvTemplate = template.Must(template.New("config-help-env").Funcs(funcMap).Parse(HelpEnv))
-
-var adminConfigHelpCmd = cli.Command{
-	Name:   "help",
-	Usage:  "show help for each sub-system and keys",
-	Before: setGlobalsFromContext,
-	Action: mainAdminConfigHelp,
-	Flags:  append(append([]cli.Flag{}, globalFlags...), helpFlags...),
-	CustomHelpTemplate: `NAME:
-  {{.HelpName}} - {{.Usage}}
-
-USAGE:
-  {{.HelpName}} TARGET
-
-FLAGS:
-  {{range .VisibleFlags}}{{.}}
-  {{end}}
-EXAMPLES:
-  1. Return help for 'region' settings on MinIO server.
-     {{.Prompt}} {{.HelpName}} play/ region
-
-  2. Return help for 'compression' settings, specifically 'extensions' key on MinIO server.
-     {{.Prompt}} {{.HelpName}} myminio/ compression extensions
-`,
-}
+var HelpEnvTemplate = template.Must(template.New("config-help-env").Funcs(funcMap).Parse(HelpTmpl))
 
 // configHelpMessage container to hold locks information.
 type configHelpMessage struct {
-	Status  string            `json:"status"`
-	Value   map[string]string `json:"help"`
+	Status  string      `json:"status"`
+	Value   madmin.Help `json:"help"`
 	envOnly bool
 }
 
@@ -114,35 +80,3 @@ func (u configHelpMessage) JSON() string {
 
 	return string(statusJSONBytes)
 }
-
-// checkAdminConfigHelpSyntax - validate all the passed arguments
-func checkAdminConfigHelpSyntax(ctx *cli.Context) {
-	if !ctx.Args().Present() || len(ctx.Args()) > 3 {
-		cli.ShowCommandHelpAndExit(ctx, "help", 1) // last argument is exit code
-	}
-}
-
-func mainAdminConfigHelp(ctx *cli.Context) error {
-
-	checkAdminConfigHelpSyntax(ctx)
-
-	// Help the alias parameter from cli
-	args := ctx.Args()
-	aliasedURL := args.Get(0)
-
-	// Create a new MinIO Admin Client
-	client, err := newAdminClient(aliasedURL)
-	fatalIf(err, "Unable to initialize admin connection.")
-
-	// Call get config API
-	hr, e := client.HelpConfigKV(args.Get(1), args.Get(2), ctx.IsSet("env"))
-	fatalIf(probe.NewError(e), "Cannot get help for the sub-system")
-
-	// Print
-	printMsg(configHelpMessage{
-		Value:   hr,
-		envOnly: ctx.IsSet("env"),
-	})
-
-	return nil
-}

cmd/admin-config-set.go

@@ -18,23 +18,22 @@ package cmd
 
 import (
 	"fmt"
-	"io/ioutil"
-	"os"
 	"strings"
 
 	"github.com/fatih/color"
 	"github.com/minio/cli"
 	json "github.com/minio/mc/pkg/colorjson"
 	"github.com/minio/mc/pkg/console"
 	"github.com/minio/mc/pkg/probe"
+	"github.com/minio/minio/pkg/madmin"
 )
 
 var adminConfigSetCmd = cli.Command{
 	Name:   "set",
 	Usage:  "set key to MinIO server/cluster.",
 	Before: setGlobalsFromContext,
 	Action: mainAdminConfigSet,
-	Flags:  globalFlags,
+	Flags:  append(adminConfigEnvFlags, globalFlags...),
 	CustomHelpTemplate: `NAME:
   {{.HelpName}} - {{.Usage}}
 
@@ -80,7 +79,7 @@ func (u configSetMessage) JSON() string {
 
 // checkAdminConfigSetSyntax - validate all the passed arguments
 func checkAdminConfigSetSyntax(ctx *cli.Context) {
-	if !ctx.Args().Present() {
+	if !ctx.Args().Present() && len(ctx.Args()) < 1 {
 		cli.ShowCommandHelpAndExit(ctx, "set", 1) // last argument is exit code
 	}
 }
@@ -102,13 +101,24 @@ func mainAdminConfigSet(ctx *cli.Context) error {
 	client, err := newAdminClient(aliasedURL)
 	fatalIf(err, "Unable to initialize admin connection.")
 
-	// Call set config API
 	input := strings.Join(args.Tail(), " ")
-	if len(input) == 0 {
-		b, e := ioutil.ReadAll(os.Stdin)
-		fatalIf(probe.NewError(e), "Cannot read from the os.Stdin")
-		input = string(b)
+
+	if !strings.Contains(input, madmin.KvSeparator) {
+		// Call get config API
+		hr, e := client.HelpConfigKV(args.Get(1), args.Get(2), ctx.IsSet("env"))
+		fatalIf(probe.NewError(e), "Cannot get help for the sub-system")
+
+		// Print
+		printMsg(configHelpMessage{
+			Value:   hr,
+			envOnly: ctx.IsSet("env"),
+		})
+
+		return nil
+
 	}
+
+	// Call set config API
 	fatalIf(probe.NewError(client.SetConfigKV(input)),
 		"Cannot set '%s' to server", input)
 

cmd/admin-config.go

@@ -28,7 +28,6 @@ var adminConfigCmd = cli.Command{
 		adminConfigSetCmd,
 		adminConfigGetCmd,
 		adminConfigDelCmd,
-		adminConfigHelpCmd,
 		adminConfigHistoryCmd,
 	},
 	HideHelpCommand: true,

go.mod

@@ -3,19 +3,21 @@ module github.com/minio/mc
 go 1.13
 
 require (
+	contrib.go.opencensus.io/exporter/ocagent v0.6.0 // indirect
+	github.com/DataDog/zstd v1.4.4 // indirect
 	github.com/cheggaaa/pb v1.0.28
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible
 	github.com/dustin/go-humanize v1.0.0
 	github.com/fatih/color v1.7.0
 	github.com/golang/groupcache v0.0.0-20191002201903-404acd9df4cc // indirect
 	github.com/grpc-ecosystem/go-grpc-middleware v1.1.0 // indirect
-	github.com/grpc-ecosystem/grpc-gateway v1.9.4 // indirect
+	github.com/hashicorp/go-retryablehttp v0.6.3 // indirect
 	github.com/inconshreveable/go-update v0.0.0-20160112193335-8152e7eb6ccf
 	github.com/mattn/go-colorable v0.1.1
 	github.com/mattn/go-isatty v0.0.7
 	github.com/mattn/go-runewidth v0.0.5 // indirect
 	github.com/minio/cli v1.22.0
-	github.com/minio/minio v0.0.0-20191114013805-26a866a20245
+	github.com/minio/minio v0.0.0-20191119214813-7cdb67680e72
 	github.com/minio/minio-go/v6 v6.0.41
 	github.com/minio/sha256-simd v0.1.1
 	github.com/mitchellh/go-homedir v1.1.0
@@ -27,7 +29,6 @@ require (
 	go.uber.org/zap v1.11.0 // indirect
 	golang.org/x/net v0.0.0-20190923162816-aa69164e4478
 	golang.org/x/text v0.3.2
-	google.golang.org/grpc v1.22.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127
 	gopkg.in/h2non/filetype.v1 v1.0.5
 	gopkg.in/yaml.v2 v2.2.2