Link to list of allowed configurations in produce/consume (#2684)

confluentinc · Mar 14, 2024 · 47604c9 · 47604c9
1 parent 0e7706f
commit 47604c9
Show file tree

Hide file tree

Showing 13 changed files with 18 additions and 12 deletions.
diff --git a/cmd/lint/main.go b/cmd/lint/main.go
@@ -59,6 +59,7 @@ var flagRules = []linter.FlagRule{
 		linter.RequireFlagUsageEndWithPunctuation,
 		linter.ExcludeFlag(
 			"batch-size",
+			"config",
 			"enable-systest-events",
 			"formatter",
 			"isolation-level",
@@ -212,7 +213,10 @@ var vocabWords = []string{
 	"geo",
 	"gzip",
 	"hostname",
+	"https",
+	"html",
 	"iam",
+	"io",
 	"ip",
 	"ips",
 	"json",
@@ -227,9 +231,11 @@ var vocabWords = []string{
 	"ksql",
 	"ksqldb",
 	"ktor",
+	"librdkafka",
 	"lifecycle",
 	"lkc",
 	"lz4",
+	"md",
 	"mds",
 	"netrc",
 	"nodejs",

diff --git a/internal/kafka/command_topic_consume.go b/internal/kafka/command_topic_consume.go
@@ -53,7 +53,7 @@ func (c *command) newConsumeCommand() *cobra.Command {
 	cmd.Flags().Bool("full-header", false, "Print complete content of message headers.")
 	cmd.Flags().String("delimiter", "\t", "The delimiter separating each key and value.")
 	cmd.Flags().Bool("timestamp", false, "Print message timestamp in milliseconds.")
-	cmd.Flags().StringSlice("config", nil, `A comma-separated list of configuration overrides ("key=value") for the consumer client.`)
+	cmd.Flags().StringSlice("config", nil, `A comma-separated list of configuration overrides ("key=value") for the consumer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html`)
 	pcmd.AddConsumerConfigFileFlag(cmd)
 	cmd.Flags().String("schema-registry-endpoint", "", "Endpoint for Schema Registry cluster.")
 

diff --git a/internal/kafka/command_topic_produce.go b/internal/kafka/command_topic_produce.go
@@ -57,7 +57,7 @@ func (c *command) newProduceCommand() *cobra.Command {
 	cmd.Flags().String("references", "", "The path to the message value schema references file.")
 	cmd.Flags().Bool("parse-key", false, "Parse key from the message.")
 	cmd.Flags().String("delimiter", ":", "The delimiter separating each key and value.")
-	cmd.Flags().StringSlice("config", nil, `A comma-separated list of configuration overrides ("key=value") for the producer client.`)
+	cmd.Flags().StringSlice("config", nil, `A comma-separated list of configuration overrides ("key=value") for the producer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html`)
 	pcmd.AddProducerConfigFileFlag(cmd)
 	cmd.Flags().String("schema-registry-endpoint", "", "Endpoint for Schema Registry cluster.")
 

diff --git a/internal/local/command_kafka_topic_consume.go b/internal/local/command_kafka_topic_consume.go
@@ -38,7 +38,7 @@ func (c *command) newKafkaTopicConsumeCommand() *cobra.Command {
 	cmd.Flags().Bool("print-key", false, "Print key of the message.")
 	cmd.Flags().Bool("timestamp", false, "Print message timestamp in milliseconds.")
 	cmd.Flags().String("delimiter", "\t", "The delimiter separating each key and value.")
-	cmd.Flags().StringSlice("config", nil, `A comma-separated list of configuration overrides ("key=value") for the consumer client.`)
+	cmd.Flags().StringSlice("config", nil, `A comma-separated list of configuration overrides ("key=value") for the consumer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html`)
 	pcmd.AddConsumerConfigFileFlag(cmd)
 
 	cobra.CheckErr(cmd.MarkFlagFilename("config-file", "avsc", "json"))

diff --git a/internal/local/command_kafka_topic_produce.go b/internal/local/command_kafka_topic_produce.go
@@ -32,7 +32,7 @@ func (c *command) newKafkaTopicProduceCommand() *cobra.Command {
 
 	cmd.Flags().Bool("parse-key", false, "Parse key from the message.")
 	cmd.Flags().String("delimiter", ":", "The delimiter separating each key and value.")
-	cmd.Flags().StringSlice("config", nil, `A comma-separated list of configuration overrides ("key=value") for the producer client.`)
+	cmd.Flags().StringSlice("config", nil, `A comma-separated list of configuration overrides ("key=value") for the producer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html`)
 	pcmd.AddProducerConfigFileFlag(cmd)
 
 	cobra.CheckErr(cmd.MarkFlagFilename("config-file", "avsc", "json"))

diff --git a/test/fixtures/output/kafka/topic/consume-help-onprem.golden b/test/fixtures/output/kafka/topic/consume-help-onprem.golden
@@ -27,7 +27,7 @@ Flags:
       --full-header                         Print complete content of message headers.
       --delimiter string                    The delimiter separating each key and value. (default "\t")
       --timestamp                           Print message timestamp in milliseconds.
-      --config strings                      A comma-separated list of configuration overrides ("key=value") for the consumer client.
+      --config strings                      A comma-separated list of configuration overrides ("key=value") for the consumer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html
       --config-file string                  The path to the configuration file for the consumer client, in JSON or Avro format.
       --schema-registry-endpoint string     Endpoint for Schema Registry cluster.
       --api-key string                      API key.

diff --git a/test/fixtures/output/kafka/topic/consume-help.golden b/test/fixtures/output/kafka/topic/consume-help.golden
@@ -27,7 +27,7 @@ Flags:
       --full-header                         Print complete content of message headers.
       --delimiter string                    The delimiter separating each key and value. (default "\t")
       --timestamp                           Print message timestamp in milliseconds.
-      --config strings                      A comma-separated list of configuration overrides ("key=value") for the consumer client.
+      --config strings                      A comma-separated list of configuration overrides ("key=value") for the consumer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html
       --config-file string                  The path to the configuration file for the consumer client, in JSON or Avro format.
       --schema-registry-endpoint string     Endpoint for Schema Registry cluster.
       --api-key string                      API key.

diff --git a/test/fixtures/output/kafka/topic/produce-help-onprem.golden b/test/fixtures/output/kafka/topic/produce-help-onprem.golden
@@ -19,7 +19,7 @@ Flags:
       --references string                   The path to the message value schema references file.
       --parse-key                           Parse key from the message.
       --delimiter string                    The delimiter separating each key and value. (default ":")
-      --config strings                      A comma-separated list of configuration overrides ("key=value") for the producer client.
+      --config strings                      A comma-separated list of configuration overrides ("key=value") for the producer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html
       --config-file string                  The path to the configuration file for the producer client, in JSON or Avro format.
       --schema-registry-endpoint string     Endpoint for Schema Registry cluster.
       --key-references string               The path to the message key schema references file.

diff --git a/test/fixtures/output/kafka/topic/produce-help.golden b/test/fixtures/output/kafka/topic/produce-help.golden
@@ -19,7 +19,7 @@ Flags:
       --references string                   The path to the message value schema references file.
       --parse-key                           Parse key from the message.
       --delimiter string                    The delimiter separating each key and value. (default ":")
-      --config strings                      A comma-separated list of configuration overrides ("key=value") for the producer client.
+      --config strings                      A comma-separated list of configuration overrides ("key=value") for the producer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html
       --config-file string                  The path to the configuration file for the producer client, in JSON or Avro format.
       --schema-registry-endpoint string     Endpoint for Schema Registry cluster.
       --key-references string               The path to the message key schema references file.

diff --git a/test/fixtures/output/local/kafka/topic/consume-help-onprem.golden b/test/fixtures/output/local/kafka/topic/consume-help-onprem.golden
@@ -18,7 +18,7 @@ Flags:
       --print-key            Print key of the message.
       --timestamp            Print message timestamp in milliseconds.
       --delimiter string     The delimiter separating each key and value. (default "\t")
-      --config strings       A comma-separated list of configuration overrides ("key=value") for the consumer client.
+      --config strings       A comma-separated list of configuration overrides ("key=value") for the consumer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html
       --config-file string   The path to the configuration file for the consumer client, in JSON or Avro format.
 
 Global Flags:

diff --git a/test/fixtures/output/local/kafka/topic/consume-help.golden b/test/fixtures/output/local/kafka/topic/consume-help.golden
@@ -18,7 +18,7 @@ Flags:
       --print-key            Print key of the message.
       --timestamp            Print message timestamp in milliseconds.
       --delimiter string     The delimiter separating each key and value. (default "\t")
-      --config strings       A comma-separated list of configuration overrides ("key=value") for the consumer client.
+      --config strings       A comma-separated list of configuration overrides ("key=value") for the consumer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html
       --config-file string   The path to the configuration file for the consumer client, in JSON or Avro format.
 
 Global Flags:

diff --git a/test/fixtures/output/local/kafka/topic/produce-help-onprem.golden b/test/fixtures/output/local/kafka/topic/produce-help-onprem.golden
@@ -13,7 +13,7 @@ Produce message to topic "test" providing key.
 Flags:
       --parse-key            Parse key from the message.
       --delimiter string     The delimiter separating each key and value. (default ":")
-      --config strings       A comma-separated list of configuration overrides ("key=value") for the producer client.
+      --config strings       A comma-separated list of configuration overrides ("key=value") for the producer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html
       --config-file string   The path to the configuration file for the producer client, in JSON or Avro format.
 
 Global Flags:

diff --git a/test/fixtures/output/local/kafka/topic/produce-help.golden b/test/fixtures/output/local/kafka/topic/produce-help.golden
@@ -13,7 +13,7 @@ Produce message to topic "test" providing key.
 Flags:
       --parse-key            Parse key from the message.
       --delimiter string     The delimiter separating each key and value. (default ":")
-      --config strings       A comma-separated list of configuration overrides ("key=value") for the producer client.
+      --config strings       A comma-separated list of configuration overrides ("key=value") for the producer client. For a full list, see https://docs.confluent.io/platform/current/clients/librdkafka/html/md_CONFIGURATION.html
       --config-file string   The path to the configuration file for the producer client, in JSON or Avro format.
 
 Global Flags: