update cmd description and match doc

Signed-off-by: pureiboi <[email protected]>
thanos-io · Sep 21, 2024 · 6878d60 · 6878d60
1 parent 1eede1d
commit 6878d60
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 16 deletions.
diff --git a/cmd/thanos/config.go b/cmd/thanos/config.go
@@ -47,7 +47,7 @@ func (gc *grpcConfig) registerFlag(cmd extkingpin.FlagClause) *grpcConfig {
 		"TLS CA to verify clients against. If no client CA is specified, there is no client verification on server side. (tls.NoClientCert)").
 		Default("").StringVar(&gc.tlsSrvClientCA)
 	cmd.Flag("grpc-server-tls-min-version",
-		"TLS minimum version to gRPC server, unset will default to tls 1.3, allow values: [\"1.0\", \"1.1\", \"1.2\", \"1.3\"]").
+		"TLS supported minimum version for gRPC server. If no version is specified, it'll default to 1.3. Allowed values: [\"1.0\", \"1.1\", \"1.2\", \"1.3\"]").
 		Default("1.3").StringVar(&gc.tlsMinVersion)
 	cmd.Flag("grpc-server-max-connection-age", "The grpc server max connection age. This controls how often to re-establish connections and redo TLS handshakes.").
 		Default("60m").DurationVar(&gc.maxConnectionAge)

diff --git a/docs/components/query.md b/docs/components/query.md
@@ -354,9 +354,10 @@ Flags:
       --grpc-server-tls-key=""   TLS Key for the gRPC server, leave blank to
                                  disable TLS
       --grpc-server-tls-min-version="1.3"
-                                 TLS minimum version to gRPC server, unset will
-                                 default to tls 1.3, allow values: ["1.0",
-                                 "1.1", "1.2", "1.3"]
+                                 TLS supported minimum version for gRPC server.
+                                 If no version is specified, it'll default to
+                                 1.3. Allowed values: ["1.0", "1.1", "1.2",
+                                 "1.3"]
   -h, --help                     Show context-sensitive help (also try
                                  --help-long and --help-man).
       --http-address="0.0.0.0:10902"

diff --git a/docs/components/receive.md b/docs/components/receive.md
@@ -360,9 +360,10 @@ Flags:
       --grpc-server-tls-key=""   TLS Key for the gRPC server, leave blank to
                                  disable TLS
       --grpc-server-tls-min-version="1.3"
-                                 TLS minimum version to gRPC server, unset will
-                                 default to tls 1.3, allow values: ["1.0",
-                                 "1.1", "1.2", "1.3"]
+                                 TLS supported minimum version for gRPC server.
+                                 If no version is specified, it'll default to
+                                 1.3. Allowed values: ["1.0", "1.1", "1.2",
+                                 "1.3"]
       --hash-func=               Specify which hash function to use when
                                  calculating the hashes of produced files.
                                  If no function has been specified, it does not

diff --git a/docs/components/rule.md b/docs/components/rule.md
@@ -353,9 +353,10 @@ Flags:
       --grpc-server-tls-key=""   TLS Key for the gRPC server, leave blank to
                                  disable TLS
       --grpc-server-tls-min-version="1.3"
-                                 TLS minimum version to gRPC server, unset will
-                                 default to tls 1.3, allow values: ["1.0",
-                                 "1.1", "1.2", "1.3"]
+                                 TLS supported minimum version for gRPC server.
+                                 If no version is specified, it'll default to
+                                 1.3. Allowed values: ["1.0", "1.1", "1.2",
+                                 "1.3"]
       --hash-func=               Specify which hash function to use when
                                  calculating the hashes of produced files.
                                  If no function has been specified, it does not

diff --git a/docs/components/sidecar.md b/docs/components/sidecar.md
@@ -119,9 +119,10 @@ Flags:
       --grpc-server-tls-key=""   TLS Key for the gRPC server, leave blank to
                                  disable TLS
       --grpc-server-tls-min-version="1.3"
-                                 TLS minimum version to gRPC server, unset will
-                                 default to tls 1.3, allow values: ["1.0",
-                                 "1.1", "1.2", "1.3"]
+                                 TLS supported minimum version for gRPC server.
+                                 If no version is specified, it'll default to
+                                 1.3. Allowed values: ["1.0", "1.1", "1.2",
+                                 "1.3"]
       --hash-func=               Specify which hash function to use when
                                  calculating the hashes of produced files.
                                  If no function has been specified, it does not

diff --git a/docs/components/store.md b/docs/components/store.md
@@ -112,9 +112,10 @@ Flags:
       --grpc-server-tls-key=""   TLS Key for the gRPC server, leave blank to
                                  disable TLS
       --grpc-server-tls-min-version="1.3"
-                                 TLS minimum version to gRPC server, unset will
-                                 default to tls 1.3, allow values: ["1.0",
-                                 "1.1", "1.2", "1.3"]
+                                 TLS supported minimum version for gRPC server.
+                                 If no version is specified, it'll default to
+                                 1.3. Allowed values: ["1.0", "1.1", "1.2",
+                                 "1.3"]
   -h, --help                     Show context-sensitive help (also try
                                  --help-long and --help-man).
       --http-address="0.0.0.0:10902"