Add help with order of keys (#8535)

cmd/config/cache/help.go

@@ -20,12 +20,40 @@ import "github.com/minio/minio/cmd/config"
 
 // Help template for caching feature.
 var (
-	Help = config.HelpKV{
-		Drives:         `List of mounted drives or directories delimited by ";"`,
-		Exclude:        `List of wildcard based cache exclusion patterns delimited by ";"`,
-		Expiry:         `Cache expiry duration in days. eg: "90"`,
-		Quota:          `Maximum permitted usage of the cache in percentage (0-100)`,
-		config.State:   "Indicates if caching is enabled or not",
-		config.Comment: "A comment to describe the caching setting",
+	Help = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Indicates if caching is enabled or not",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         Drives,
+			Description: `List of mounted drives or directories delimited by ";"`,
+			Type:        "delimited-string",
+		},
+		config.HelpKV{
+			Key:         Exclude,
+			Description: `List of wildcard based cache exclusion patterns delimited by ";"`,
+			Optional:    true,
+			Type:        "delimited-string",
+		},
+		config.HelpKV{
+			Key:         Expiry,
+			Description: `Cache expiry duration in days. eg: "90"`,
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         Quota,
+			Description: `Maximum permitted usage of the cache in percentage (0-100)`,
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the 'cache' settings",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 )

cmd/config/compress/help.go

@@ -20,10 +20,29 @@ import "github.com/minio/minio/cmd/config"
 
 // Help template for compress feature.
 var (
-	Help = config.HelpKV{
-		Extensions:     `Comma separated file extensions to compress. eg: ".txt,.log,.csv"`,
-		MimeTypes:      `Comma separate wildcard mime-types to compress. eg: "text/*,application/json,application/xml"`,
-		config.State:   "Indicates if compression is enabled or not",
-		config.Comment: "A comment to describe the compression setting",
+	Help = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Indicates if compression is enabled or not",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         Extensions,
+			Description: `Comma separated file extensions to compress eg: ".txt,.log,.csv"`,
+			Optional:    true,
+			Type:        "delimited-string",
+		},
+		config.HelpKV{
+			Key:         MimeTypes,
+			Description: `Comma separate wildcard mime-types to compress eg: "text/*,application/json,application/xml"`,
+			Optional:    true,
+			Type:        "delimited-string",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the compression setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 )

cmd/config/etcd/help.go

@@ -20,12 +20,40 @@ import "github.com/minio/minio/cmd/config"
 
 // etcd config documented in default config
 var (
-	Help = config.HelpKV{
-		Endpoints:      `(required) Comma separated list of etcd endpoints eg: "http://localhost:2379"`,
-		CoreDNSPath:    `(optional) CoreDNS etcd path location to populate DNS srv records eg: "/skydns"`,
-		ClientCert:     `(optional) Etcd client cert for mTLS authentication`,
-		ClientCertKey:  `(optional) Etcd client cert key for mTLS authentication`,
-		config.State:   "Indicates if etcd config is on or off",
-		config.Comment: "A comment to describe the etcd settings",
+	Help = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Indicates if etcd config is on or off",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         Endpoints,
+			Description: `Comma separated list of etcd endpoints eg: "http://localhost:2379"`,
+			Type:        "delimited-string",
+		},
+		config.HelpKV{
+			Key:         CoreDNSPath,
+			Description: `CoreDNS etcd path location to populate DNS srv records eg: "/skydns"`,
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         ClientCert,
+			Description: `Etcd client cert for mTLS authentication`,
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         ClientCertKey,
+			Description: `Etcd client cert key for mTLS authentication`,
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the etcd settings",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 )

cmd/config/help.go

@@ -18,18 +18,62 @@ package config
 
 // HelpKV - implements help messages for keys
 // with value as description of the keys.
-type HelpKV map[string]string
+type HelpKV struct {
+	Key         string `json:"key"`
+	Type        string `json:"type"`
+	Description string `json:"description"`
+	Optional    bool   `json:"optional"`
+
+	// Indicates if sub-sys supports multiple targets.
+	MultipleTargets bool `json:"multipleTargets"`
+}
+
+// HelpKVS - implement order of keys help messages.
+type HelpKVS []HelpKV
+
+// Lookup - lookup a key from help kvs.
+func (hkvs HelpKVS) Lookup(key string) (HelpKV, bool) {
+	for _, hkv := range hkvs {
+		if hkv.Key == key {
+			return hkv, true
+		}
+	}
+	return HelpKV{}, false
+}
 
 // Region and Worm help is documented in default config
 var (
-	RegionHelp = HelpKV{
-		RegionName: `Region name of this deployment, eg: "us-west-2"`,
-		State:      "Indicates if config region is honored or ignored",
-		Comment:    "A comment to describe the region setting",
+	RegionHelp = HelpKVS{
+		HelpKV{
+			Key:         State,
+			Type:        "on|off",
+			Description: "Indicates if config region is honored or ignored",
+		},
+		HelpKV{
+			Key:         RegionName,
+			Type:        "string",
+			Description: `Region name of this deployment, eg: "us-west-2"`,
+			Optional:    true,
+		},
+		HelpKV{
+			Key:         Comment,
+			Type:        "sentence",
+			Description: "A comment to describe the region setting",
+			Optional:    true,
+		},
 	}
 
-	WormHelp = HelpKV{
-		State:   `Indicates if worm is "on" or "off"`,
-		Comment: "A comment to describe the worm state",
+	WormHelp = HelpKVS{
+		HelpKV{
+			Key:         State,
+			Type:        "on|off",
+			Description: `Indicates if worm is "on" or "off"`,
+		},
+		HelpKV{
+			Key:         Comment,
+			Type:        "sentence",
+			Description: "A comment to describe the worm state",
+			Optional:    true,
+		},
 	}
 )

cmd/config/identity/ldap/config_test.go

@@ -66,6 +66,12 @@ func TestSubstituter(t *testing.T) {
 			SubstitutableStr: "uid=${usernamedn},cn=users,dc=example,dc=com",
 			ErrExpected:      true,
 		},
+		{
+			KV:               []string{"username", "john"},
+			SubstitutableStr: "(&(objectclass=user)(sAMAccountName={username})(memberOf=CN=myorg,OU=Rialto,OU=Application Managed,OU=Groups,DC=amr,DC=corp,DC=myorg,DC=com))",
+			SubstitutedStr:   "(&(objectclass=user)(sAMAccountName=john)(memberOf=CN=myorg,OU=Rialto,OU=Application Managed,OU=Groups,DC=amr,DC=corp,DC=myorg,DC=com))",
+			ErrExpected:      false,
+		},
 	}
 
 	for _, test := range tests {

cmd/config/identity/ldap/help.go

@@ -18,17 +18,59 @@ package ldap
 
 import "github.com/minio/minio/cmd/config"
 
-// Help template for Ldap identity feature.
+// Help template for LDAP identity feature.
 var (
-	Help = config.HelpKV{
-		ServerAddr:         `(Required) AD/LDAP server address eg: "myldapserver.com:636"`,
-		UsernameFormat:     `(Required) AD/LDAP format of full username DN eg: "uid={username},cn=accounts,dc=myldapserver,dc=com"`,
-		GroupSearchFilter:  `Search filter to find groups of a user (optional) eg: "(&(objectclass=groupOfNames)(member={usernamedn}))"`,
-		GroupNameAttribute: `Attribute of search results to use as group name (optional) eg: "cn"`,
-		GroupSearchBaseDN:  `Base DN in AD/LDAP hierarchy to use in search requests (optional) eg: "dc=myldapserver,dc=com"`,
-		STSExpiry:          `AD/LDAP STS credentials validity duration (optional) eg: "1h"`,
-		TLSSkipVerify:      "Set this to 'on', to disable client verification of server certificates",
-		config.State:       "(Required) Enable or disable LDAP/AD identity",
-		config.Comment:     "A comment to describe the LDAP/AD identity setting",
+	Help = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Enable or disable LDAP/AD identity",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         ServerAddr,
+			Description: `AD/LDAP server address eg: "myldapserver.com:636"`,
+			Type:        "address",
+		},
+		config.HelpKV{
+			Key:         UsernameFormat,
+			Description: `AD/LDAP format of full username DN eg: "uid={username},cn=accounts,dc=myldapserver,dc=com"`,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         GroupSearchFilter,
+			Description: `Search filter to find groups of a user (optional) eg: "(&(objectclass=groupOfNames)(member={usernamedn}))"`,
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         GroupNameAttribute,
+			Description: `Attribute of search results to use as group name (optional) eg: "cn"`,
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         GroupSearchBaseDN,
+			Description: `Base DN in AD/LDAP hierarchy to use in search requests (optional) eg: "dc=myldapserver,dc=com"`,
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         STSExpiry,
+			Description: `AD/LDAP STS credentials validity duration eg: "1h"`,
+			Optional:    true,
+			Type:        "duration",
+		},
+		config.HelpKV{
+			Key:         TLSSkipVerify,
+			Description: "Set this to 'on', to disable client verification of server certificates",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the LDAP/AD identity setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 )

cmd/config/identity/openid/help.go

@@ -20,9 +20,22 @@ import "github.com/minio/minio/cmd/config"
 
 // Help template for OpenID identity feature.
 var (
-	Help = config.HelpKV{
-		ConfigURL:      `OpenID discovery documented endpoint. eg: "https://accounts.google.com/.well-known/openid-configuration"`,
-		config.State:   "Indicates if OpenID identity is enabled or not",
-		config.Comment: "A comment to describe the OpenID identity setting",
+	Help = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Indicates if OpenID identity is enabled or not",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         ConfigURL,
+			Description: `OpenID discovery documented endpoint. eg: "https://accounts.google.com/.well-known/openid-configuration"`,
+			Type:        "url",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the OpenID identity setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 )

cmd/config/notify/help.go

@@ -23,141 +23,650 @@ import (
 
 // Help template inputs for all notification targets
 var (
-	HelpAMQP = config.HelpKV{
-		config.State:            "(Required) Is this server endpoint configuration active/enabled",
-		config.Comment:          "A comment to describe the AMQP target setting",
-		target.AmqpURL:          "(Required) AMQP server endpoint, e.g. `amqp://myuser:mypassword@localhost:5672`",
-		target.AmqpExchange:     "Name of the AMQP exchange",
-		target.AmqpExchangeType: "Kind of AMQP exchange type",
-		target.AmqpRoutingKey:   "Routing key for publishing",
-		target.AmqpMandatory:    "Set this to 'on' for server to return an unroutable message with a Return method. If this flag is 'off', the server silently drops the message",
-		target.AmqpDurable:      "Set this to 'on' for queue to surive broker restarts",
-		target.AmqpNoWait:       "When no_wait is 'on', declare without waiting for a confirmation from the server",
-		target.AmqpInternal:     "Set this to 'on' for exchange to be not used directly by publishers, but only when bound to other exchanges",
-		target.AmqpAutoDeleted:  "Set this to 'on' for queue that has had at least one consumer is deleted when last consumer unsubscribes",
-		target.AmqpDeliveryMode: "Delivery queue implementation use non-persistent (1) or persistent (2)",
-		target.AmqpQueueLimit:   "Enable persistent event store queue limit, defaults to '10000'",
-		target.AmqpQueueDir:     "Local directory where events are stored eg: '/home/events'",
+	HelpAMQP = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Is this server endpoint configuration active/enabled",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.AmqpURL,
+			Description: "AMQP server endpoint, e.g. `amqp://myuser:mypassword@localhost:5672`",
+			Type:        "url",
+		},
+		config.HelpKV{
+			Key:         target.AmqpExchange,
+			Description: "Name of the AMQP exchange",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.AmqpExchangeType,
+			Description: "Kind of AMQP exchange type",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.AmqpRoutingKey,
+			Description: "Routing key for publishing",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.AmqpMandatory,
+			Description: "Set this to 'on' for server to return an unroutable message with a Return method. If this flag is 'off', the server silently drops the message",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.AmqpDurable,
+			Description: "Set this to 'on' for queue to survive broker restarts",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.AmqpNoWait,
+			Description: "When no_wait is 'on', declare without waiting for a confirmation from the server",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.AmqpInternal,
+			Description: "Set this to 'on' for exchange to be not used directly by publishers, but only when bound to other exchanges",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.AmqpAutoDeleted,
+			Description: "Set this to 'on' for queue that has had at least one consumer is deleted when last consumer unsubscribes",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.AmqpDeliveryMode,
+			Description: "Delivery queue implementation use non-persistent (1) or persistent (2)",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         target.AmqpQueueDir,
+			Description: "Local directory where events are stored eg: '/home/events'",
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         target.AmqpQueueLimit,
+			Description: "Enable persistent event store queue limit, defaults to '10000'",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the AMQP target setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 
-	HelpKafka = config.HelpKV{
-		config.State:              "(Required) Is this server endpoint configuration active/enabled",
-		config.Comment:            "A comment to describe the Kafka target setting",
-		target.KafkaTopic:         "The Kafka topic for a given message",
-		target.KafkaBrokers:       "Command separated list of Kafka broker addresses",
-		target.KafkaSASLUsername:  "Username for SASL/PLAIN  or SASL/SCRAM authentication",
-		target.KafkaSASLPassword:  "Password for SASL/PLAIN  or SASL/SCRAM authentication",
-		target.KafkaTLSClientAuth: "ClientAuth determines the Kafka server's policy for TLS client auth",
-		target.KafkaSASL:          "Set this to 'on' to enable SASL authentication",
-		target.KafkaTLS:           "Set this to 'on' to enable TLS",
-		target.KafkaTLSSkipVerify: "Set this to 'on' to disable client verification of server certificate chain",
-		target.KafkaQueueLimit:    "Enable persistent event store queue limit, defaults to '10000'",
-		target.KafkaQueueDir:      "Local directory where events are stored eg: '/home/events'",
+	HelpKafka = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Is this server endpoint configuration active/enabled",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.KafkaBrokers,
+			Description: "Command separated list of Kafka broker addresses",
+			Type:        "delimited-string",
+		},
+		config.HelpKV{
+			Key:         target.KafkaTopic,
+			Description: "The Kafka topic for a given message",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.KafkaSASLUsername,
+			Description: "Username for SASL/PLAIN  or SASL/SCRAM authentication",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.KafkaSASLPassword,
+			Description: "Password for SASL/PLAIN  or SASL/SCRAM authentication",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.KafkaTLSClientAuth,
+			Description: "ClientAuth determines the Kafka server's policy for TLS client auth",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.KafkaSASL,
+			Description: "Set this to 'on' to enable SASL authentication",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.KafkaTLS,
+			Description: "Set this to 'on' to enable TLS",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.KafkaTLSSkipVerify,
+			Description: "Set this to 'on' to disable client verification of server certificate chain",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.KafkaQueueDir,
+			Description: "Local directory where events are stored eg: '/home/events'",
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         target.KafkaQueueLimit,
+			Description: "Enable persistent event store queue limit, defaults to '10000'",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the Kafka target setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 
-	HelpMQTT = config.HelpKV{
-		config.State:                 "(Required) Is this server endpoint configuration active/enabled",
-		config.Comment:               "A comment to describe the MQTT target setting",
-		target.MqttBroker:            "(Required) MQTT server endpoint, e.g. `tcp://localhost:1883`",
-		target.MqttTopic:             "(Required) Name of the MQTT topic to publish on, e.g. `minio`",
-		target.MqttUsername:          "Username to connect to the MQTT server (if required)",
-		target.MqttPassword:          "Password to connect to the MQTT server (if required)",
-		target.MqttQoS:               "Set the Quality of Service Level for MQTT endpoint",
-		target.MqttKeepAliveInterval: "Optional keep alive interval for MQTT connections",
-		target.MqttReconnectInterval: "Optional reconnect interval for MQTT connections",
-		target.MqttQueueDir:          "Local directory where events are stored eg: '/home/events'",
-		target.MqttQueueLimit:        "Enable persistent event store queue limit, defaults to '10000'",
+	HelpMQTT = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Is this server endpoint configuration active/enabled",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.MqttBroker,
+			Description: "MQTT server endpoint, e.g. `tcp://localhost:1883`",
+			Type:        "uri",
+		},
+		config.HelpKV{
+			Key:         target.MqttTopic,
+			Description: "Name of the MQTT topic to publish on, e.g. `minio`",
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.MqttUsername,
+			Description: "Username to connect to the MQTT server",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.MqttPassword,
+			Description: "Password to connect to the MQTT server",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.MqttQoS,
+			Description: "Set the Quality of Service Level for MQTT endpoint",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         target.MqttKeepAliveInterval,
+			Description: "Keep alive interval for MQTT connections",
+			Optional:    true,
+			Type:        "duration",
+		},
+		config.HelpKV{
+			Key:         target.MqttReconnectInterval,
+			Description: "Reconnect interval for MQTT connections",
+			Optional:    true,
+			Type:        "duration",
+		},
+		config.HelpKV{
+			Key:         target.MqttQueueDir,
+			Description: "Local directory where events are stored eg: '/home/events'",
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         target.MqttQueueLimit,
+			Description: "Enable persistent event store queue limit, defaults to '10000'",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the MQTT target setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 
-	HelpES = config.HelpKV{
-		config.State:             "(Required) Is this server endpoint configuration active/enabled",
-		config.Comment:           "A comment to describe the Elasticsearch target setting",
-		target.ElasticURL:        "(Required) The Elasticsearch server's address, with optional authentication info",
-		target.ElasticFormat:     "(Required) Either `namespace` or `access`, defaults to 'namespace'",
-		target.ElasticIndex:      "(Required) The name of an Elasticsearch index in which MinIO will store document",
-		target.ElasticQueueDir:   "Local directory where events are stored eg: '/home/events'",
-		target.ElasticQueueLimit: "Enable persistent event store queue limit, defaults to '10000'",
+	HelpES = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Is this server endpoint configuration active/enabled",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.ElasticURL,
+			Description: "The Elasticsearch server's address, with optional authentication info",
+			Type:        "url",
+		},
+		config.HelpKV{
+			Key:         target.ElasticFormat,
+			Description: "Either `namespace` or `access`, defaults to 'namespace'",
+			Type:        "namespace*|access",
+		},
+		config.HelpKV{
+			Key:         target.ElasticIndex,
+			Description: "The name of an Elasticsearch index in which MinIO will store document",
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.ElasticQueueDir,
+			Description: "Local directory where events are stored eg: '/home/events'",
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         target.ElasticQueueLimit,
+			Description: "Enable persistent event store queue limit, defaults to '10000'",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the Elasticsearch target setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 
-	HelpWebhook = config.HelpKV{
-		config.State:             "(Required) Is this server endpoint configuration active/enabled",
-		config.Comment:           "A comment to describe the Webhook target setting",
-		target.WebhookEndpoint:   "Webhook server endpoint eg: http://localhost:8080/minio/events",
-		target.WebhookAuthToken:  "Authorization token used for webhook server endpoint (optional)",
-		target.WebhookQueueLimit: "Enable persistent event store queue limit, defaults to '10000'",
-		target.WebhookQueueDir:   "Local directory where events are stored eg: '/home/events'",
+	HelpWebhook = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Is this server endpoint configuration active/enabled",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.WebhookEndpoint,
+			Description: "Webhook server endpoint eg: http://localhost:8080/minio/events",
+			Type:        "url",
+		},
+		config.HelpKV{
+			Key:         target.WebhookAuthToken,
+			Description: "Authorization token used for webhook server endpoint",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.WebhookQueueDir,
+			Description: "Local directory where events are stored eg: '/home/events'",
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         target.WebhookQueueLimit,
+			Description: "Enable persistent event store queue limit, defaults to '10000'",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the Webhook target setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 
-	HelpRedis = config.HelpKV{
-		config.State:           "(Required) Is this server endpoint configuration active/enabled",
-		config.Comment:         "A comment to describe the Redis target setting",
-		target.RedisFormat:     "Specify how data is populated, a hash is used in case of `namespace` format and a list in case of `access` format, defaults to 'namespace'",
-		target.RedisAddress:    "(Required) The Redis server's address. For example: `localhost:6379`",
-		target.RedisKey:        "The name of the redis key under which events are stored",
-		target.RedisPassword:   "(Optional) The Redis server's password",
-		target.RedisQueueDir:   "Local directory where events are stored eg: '/home/events'",
-		target.RedisQueueLimit: "Enable persistent event store queue limit, defaults to '10000'",
+	HelpRedis = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Is this server endpoint configuration active/enabled",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.RedisAddress,
+			Description: "The Redis server's address. For example: `localhost:6379`",
+			Type:        "address",
+		},
+		config.HelpKV{
+			Key:         target.RedisFormat,
+			Description: "Specify how data is populated, a hash is used in case of `namespace` format and a list in case of `access` format, defaults to 'namespace'",
+			Type:        "namespace|access",
+		},
+		config.HelpKV{
+			Key:         target.RedisKey,
+			Description: "The name of the Redis key under which events are stored",
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.RedisPassword,
+			Description: "The Redis server's password",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.RedisQueueDir,
+			Description: "Local directory where events are stored eg: '/home/events'",
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         target.RedisQueueLimit,
+			Description: "Enable persistent event store queue limit, defaults to '10000'",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the Redis target setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 
-	HelpPostgres = config.HelpKV{
-		config.State:                    "(Required) Is this server endpoint configuration active/enabled",
-		config.Comment:                  "A comment to describe the Postgres target setting",
-		target.PostgresFormat:           "Specify how data is populated, `namespace` format and `access` format, defaults to 'namespace'",
-		target.PostgresConnectionString: "Connection string parameters for the PostgreSQL server",
-		target.PostgresTable:            "(Required) Table name in which events will be stored/updated. If the table does not exist, the MinIO server creates it at start-up",
-		target.PostgresHost:             "(Optional) Host name of the PostgreSQL server. Defaults to `localhost`. IPv6 host should be enclosed with `[` and `]`",
-		target.PostgresPort:             "(Optional) Port on which to connect to PostgreSQL server, defaults to `5432`",
-		target.PostgresUsername:         "Database username, defaults to user running the MinIO process if not specified",
-		target.PostgresPassword:         "Database password",
-		target.PostgresDatabase:         "Database name",
-		target.PostgresQueueDir:         "Local directory where events are stored eg: '/home/events'",
-		target.PostgresQueueLimit:       "Enable persistent event store queue limit, defaults to '10000'",
+	HelpPostgres = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Is this server endpoint configuration active/enabled",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.PostgresConnectionString,
+			Description: "Connection string parameters for the PostgreSQL server",
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.PostgresFormat,
+			Description: "Specify how data is populated, `namespace` format and `access` format, defaults to 'namespace'",
+			Type:        "namespace|access",
+		},
+		config.HelpKV{
+			Key:         target.PostgresTable,
+			Description: "Table name in which events will be stored/updated. If the table does not exist, the MinIO server creates it at start-up",
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.PostgresHost,
+			Description: "Host name of the PostgreSQL server. Defaults to `localhost`. IPv6 host should be enclosed with `[` and `]`",
+			Optional:    true,
+			Type:        "hostname",
+		},
+		config.HelpKV{
+			Key:         target.PostgresPort,
+			Description: "Port on which to connect to PostgreSQL server, defaults to `5432`",
+			Optional:    true,
+			Type:        "port",
+		},
+		config.HelpKV{
+			Key:         target.PostgresUsername,
+			Description: "Database username, defaults to user running the MinIO process if not specified",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.PostgresPassword,
+			Description: "Database password",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.PostgresDatabase,
+			Description: "Postgres Database name",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.PostgresQueueDir,
+			Description: "Local directory where events are stored eg: '/home/events'",
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         target.PostgresQueueLimit,
+			Description: "Enable persistent event store queue limit, defaults to '10000'",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the Postgres target setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 
-	HelpMySQL = config.HelpKV{
-		config.State:           "(Required) Is this server endpoint configuration active/enabled",
-		config.Comment:         "A comment to describe the MySQL target setting",
-		target.MySQLFormat:     "Specify how data is populated, `namespace` format and `access` format, defaults to 'namespace'",
-		target.MySQLHost:       "Host name of the MySQL server (used only if `dsnString` is empty)",
-		target.MySQLPort:       "Port on which to connect to the MySQL server (used only if `dsn_string` is empty)",
-		target.MySQLUsername:   "Database user-name (used only if `dsnString` is empty)",
-		target.MySQLPassword:   "Database password (used only if `dsnString` is empty)",
-		target.MySQLDatabase:   "Database name (used only if `dsnString` is empty)",
-		target.MySQLDSNString:  "Data-Source-Name connection string for the MySQL server",
-		target.MySQLTable:      "(Required) Table name in which events will be stored/updated. If the table does not exist, the MinIO server creates it at start-up",
-		target.MySQLQueueLimit: "Enable persistent event store queue limit, defaults to '10000'",
-		target.MySQLQueueDir:   "Local directory where events are stored eg: '/home/events'",
+	HelpMySQL = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Is this server endpoint configuration active/enabled",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.MySQLDSNString,
+			Description: "Data-Source-Name connection string for the MySQL server",
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.MySQLTable,
+			Description: "Table name in which events will be stored/updated. If the table does not exist, the MinIO server creates it at start-up",
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.MySQLFormat,
+			Description: "Specify how data is populated, `namespace` format and `access` format, defaults to 'namespace'",
+			Type:        "namespace|access",
+		},
+		config.HelpKV{
+			Key:         target.MySQLHost,
+			Description: "Host name of the MySQL server (used only if `dsnString` is empty)",
+			Optional:    true,
+			Type:        "hostname",
+		},
+		config.HelpKV{
+			Key:         target.MySQLPort,
+			Description: "Port on which to connect to the MySQL server (used only if `dsn_string` is empty)",
+			Optional:    true,
+			Type:        "port",
+		},
+		config.HelpKV{
+			Key:         target.MySQLUsername,
+			Description: "Database user-name (used only if `dsnString` is empty)",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.MySQLPassword,
+			Description: "Database password (used only if `dsnString` is empty)",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.MySQLDatabase,
+			Description: "Database name (used only if `dsnString` is empty)",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.MySQLQueueDir,
+			Description: "Local directory where events are stored eg: '/home/events'",
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         target.MySQLQueueLimit,
+			Description: "Enable persistent event store queue limit, defaults to '10000'",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the MySQL target setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 
-	HelpNATS = config.HelpKV{
-		config.State:                           "(Required) Is this server endpoint configuration active/enabled",
-		config.Comment:                         "A comment to describe the NATS target setting",
-		target.NATSAddress:                     "NATS server address eg: '0.0.0.0:4222'",
-		target.NATSSubject:                     "NATS subject that represents this subscription",
-		target.NATSUsername:                    "Username to be used when connecting to the server",
-		target.NATSPassword:                    "Password to be used when connecting to a server",
-		target.NATSToken:                       "Token to be used when connecting to a server",
-		target.NATSSecure:                      "Set this to 'on', enables TLS secure connections that skip server verification (not recommended)",
-		target.NATSPingInterval:                "Client ping commands interval to the server, disabled by default",
-		target.NATSStreaming:                   "Set this to 'on', to use streaming NATS server",
-		target.NATSStreamingAsync:              "Set this to 'on', to enable asynchronous publish, process the ACK or error state",
-		target.NATSStreamingMaxPubAcksInFlight: "Specifies how many messages can be published without getting ACKs back from NATS streaming server",
-		target.NATSStreamingClusterID:          "Unique ID for the NATS streaming cluster",
-		target.NATSQueueLimit:                  "Enable persistent event store queue limit, defaults to '10000'",
-		target.NATSQueueDir:                    "Local directory where events are stored eg: '/home/events'",
-		target.NATSCertAuthority:               "Certificate chain of the target NATS server if self signed certs were used",
-		target.NATSClientCert:                  "TLS Cert used to authenticate against NATS configured to require client certificates",
-		target.NATSClientKey:                   "TLS Key used to authenticate against NATS configured to require client certificates",
+	HelpNATS = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Is this server endpoint configuration active/enabled",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.NATSAddress,
+			Description: "NATS server address eg: '0.0.0.0:4222'",
+			Type:        "address",
+		},
+		config.HelpKV{
+			Key:         target.NATSSubject,
+			Description: "NATS subject that represents this subscription",
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.NATSUsername,
+			Description: "Username to be used when connecting to the server",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.NATSPassword,
+			Description: "Password to be used when connecting to a server",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.NATSToken,
+			Description: "Token to be used when connecting to a server",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.NATSSecure,
+			Description: "Set this to 'on', enables TLS secure connections that skip server verification (not recommended)",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.NATSPingInterval,
+			Description: "Client ping commands interval to the server, disabled by default",
+			Optional:    true,
+			Type:        "duration",
+		},
+		config.HelpKV{
+			Key:         target.NATSStreaming,
+			Description: "Set this to 'on', to use streaming NATS server",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.NATSStreamingAsync,
+			Description: "Set this to 'on', to enable asynchronous publish, process the ACK or error state",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.NATSStreamingMaxPubAcksInFlight,
+			Description: "Specifies how many messages can be published without getting ACKs back from NATS streaming server",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         target.NATSStreamingClusterID,
+			Description: "Unique ID for the NATS streaming cluster",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.NATSQueueLimit,
+			Description: "Enable persistent event store queue limit, defaults to '10000'",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         target.NATSQueueDir,
+			Description: "Local directory where events are stored eg: '/home/events'",
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         target.NATSCertAuthority,
+			Description: "Certificate chain of the target NATS server if self signed certs were used",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.NATSClientCert,
+			Description: "TLS Cert used to authenticate against NATS configured to require client certificates",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.NATSClientKey,
+			Description: "TLS Key used to authenticate against NATS configured to require client certificates",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the NATS target setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 
-	HelpNSQ = config.HelpKV{
-		config.State:            "(Required) Is this server endpoint configuration active/enabled",
-		config.Comment:          "A comment to describe the NSQ target setting",
-		target.NSQAddress:       "NSQ server address eg: '127.0.0.1:4150'",
-		target.NSQTopic:         "NSQ topic unique per target",
-		target.NSQTLS:           "Set this to 'on', to enable TLS negotiation",
-		target.NSQTLSSkipVerify: "Set this to 'on', to disable client verification of server certificates",
-		target.NSQQueueLimit:    "Enable persistent event store queue limit, defaults to '10000'",
-		target.NSQQueueDir:      "Local directory where events are stored eg: '/home/events'",
+	HelpNSQ = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Is this server endpoint configuration active/enabled",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.NSQAddress,
+			Description: "NSQ server address eg: '127.0.0.1:4150'",
+			Type:        "address",
+		},
+		config.HelpKV{
+			Key:         target.NSQTopic,
+			Description: "NSQ topic unique per target",
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         target.NSQTLS,
+			Description: "Set this to 'on', to enable TLS negotiation",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.NSQTLSSkipVerify,
+			Description: "Set this to 'on', to disable client verification of server certificates",
+			Optional:    true,
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         target.NSQQueueDir,
+			Description: "Local directory where events are stored eg: '/home/events'",
+			Optional:    true,
+			Type:        "path",
+		},
+		config.HelpKV{
+			Key:         target.NSQQueueLimit,
+			Description: "Enable persistent event store queue limit, defaults to '10000'",
+			Optional:    true,
+			Type:        "number",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the NSQ target setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 )

cmd/config/policy/opa/help.go

@@ -20,10 +20,28 @@ import "github.com/minio/minio/cmd/config"
 
 // Help template for OPA policy feature.
 var (
-	Help = config.HelpKV{
-		URL:            `Points to URL for OPA HTTP API endpoint. eg: "http://localhost:8181/v1/data/httpapi/authz/allow"`,
-		AuthToken:      "Authorization token for the OPA HTTP API endpoint (optional)",
-		config.State:   "Indicates if OPA policy is enabled or not",
-		config.Comment: "A comment to describe the OPA policy setting",
+	Help = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Indicates if OPA policy is enabled or not",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         URL,
+			Description: `Points to URL for OPA HTTP API endpoint. eg: "http://localhost:8181/v1/data/httpapi/authz/allow"`,
+			Type:        "url",
+		},
+		config.HelpKV{
+			Key:         AuthToken,
+			Description: "Authorization token for the OPA HTTP API endpoint",
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the OPA policy setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 )

cmd/config/storageclass/help.go

@@ -20,10 +20,29 @@ import "github.com/minio/minio/cmd/config"
 
 // Help template for storageclass feature.
 var (
-	Help = config.HelpKV{
-		ClassRRS:       "Set reduced redundancy storage class parity ratio. eg: \"EC:2\"",
-		ClassStandard:  "Set standard storage class parity ratio. eg: \"EC:4\"",
-		config.State:   "Indicates if storageclass is enabled or not",
-		config.Comment: "A comment to describe the storageclass setting",
+	Help = config.HelpKVS{
+		config.HelpKV{
+			Key:         config.State,
+			Description: "Indicates if storageclass is enabled or not",
+			Type:        "on|off",
+		},
+		config.HelpKV{
+			Key:         ClassRRS,
+			Description: `Set reduced redundancy storage class parity ratio. eg: "EC:2"`,
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         ClassStandard,
+			Description: `Set standard storage class parity ratio. eg: "EC:4"`,
+			Optional:    true,
+			Type:        "string",
+		},
+		config.HelpKV{
+			Key:         config.Comment,
+			Description: "A comment to describe the storageclass setting",
+			Optional:    true,
+			Type:        "sentence",
+		},
 	}
 )