Update description and update cli/doc

Signed-off-by: Matei David <[email protected]>
linkerd · Oct 26, 2023 · 573112b · 573112b
1 parent e22c124
commit 573112b
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/charts/linkerd-control-plane/README.md b/charts/linkerd-control-plane/README.md
@@ -241,7 +241,7 @@ Kubernetes: `>=1.21.0-0`
 | proxy.opaquePorts | string | `"25,587,3306,4444,5432,6379,9300,11211"` | Default set of opaque ports - SMTP (25,587) server-first - MYSQL (3306) server-first - Galera (4444) server-first - PostgreSQL (5432) server-first - Redis (6379) server-first - ElasticSearch (9300) server-first - Memcached (11211) clients do not issue any preamble, which breaks detection |
 | proxy.outboundConnectTimeout | string | `"1000ms"` | Maximum time allowed for the proxy to establish an outbound TCP connection |
 | proxy.outboundDiscoveryCacheUnusedTimeout | string | `"5s"` | Maximum time allowed before an unused outbound discovery result is evicted from the cache |
-| proxy.outboundProtocolDetectTimeout | string | `"10s"` | Maximum time allowed for the proxy to determine the client's protocol by peeking from the socket |
+| proxy.outboundProtocolDetectTimeout | string | `"10s"` | Maximum time allowed for the proxy to determine an outbound connection's protocol by peeking from the socket |
 | proxy.ports.admin | int | `4191` | Admin port for the proxy container |
 | proxy.ports.control | int | `4190` | Control port for the proxy container |
 | proxy.ports.inbound | int | `4143` | Inbound port for the proxy container |

diff --git a/charts/linkerd-control-plane/values.yaml b/charts/linkerd-control-plane/values.yaml
@@ -115,8 +115,8 @@ proxy:
   # -- Maximum time allowed before an unused inbound discovery result
   # is evicted from the cache
   inboundDiscoveryCacheUnusedTimeout: "90s"
-  # -- Maximum time allowed for the proxy to determine the client's protocol by
-  # peeking from the socket
+  # -- Maximum time allowed for the proxy to determine an outbound connection's
+  # protocol by peeking from the socket
   outboundProtocolDetectTimeout: "10s"
   # -- Maximum time allowed for the proxy to determine an incoming connection's
   # protocol by peeking from the socket

diff --git a/cli/cmd/doc.go b/cli/cmd/doc.go
@@ -252,6 +252,14 @@ func generateAnnotationsDocs() []annotationDoc {
 			Name:        k8s.ProxyInboundDiscoveryCacheUnusedTimeout,
 			Description: "Maximum time allowed before an unused inbound discovery result is evicted from the cache. Defaults to `90s`",
 		},
+		{
+			Name:        k8s.ProxyOutboundProtocolDetectTimeout,
+			Description: "Maximum time allowed for the proxy to determine an outbound connection's protocol by peeking from the socket",
+		},
+		{
+			Name:        k8s.ProxyInboundProtocolDetectTimeout,
+			Description: "Maximum time allowed for the proxy to determine an inbound connection's protocol by peeking from the socket",
+		},
 		{
 			Name:        k8s.ProxyWaitBeforeExitSecondsAnnotation,
 			Description: "The proxy sidecar will stay alive for at least the given period after receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`. Defaults to `0`",