linkerd
/
linkerd2
mirror of https://github.com/linkerd/linkerd2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add default values to `proxy-*-connect-timeout` annotations docs (#12155) 

* Add default values to proxy connect description

Finding these values in the docs site is pretty painful

Update the documentation to follow other proxy fields in providing
a default value at the end of the description for the field

Fixes #12154

---------

Signed-off-by: Akshay Dongaonkar <akshaydon93@gmail.com>
Co-authored-by: Alejandro Pedraza <alejandro.pedraza@gmail.com>
This commit is contained in:
Akshay Dongaonkar 2024-03-14 14:17:26 -07:00 committed by GitHub
parent bc9af2d6a9
commit e920389503
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
cli/cmd/doc.go
View File

@ -238,11 +238,11 @@ func generateAnnotationsDocs() []annotationDoc {
},
{
Name: k8s.ProxyOutboundConnectTimeout,
Description: "Used to configure the outbound TCP connection timeout in the proxy",
Description: "Used to configure the outbound TCP connection timeout in the proxy. Defaults to `1000ms`",
},
{
Name: k8s.ProxyInboundConnectTimeout,
Description: "Inbound TCP connection timeout in the proxy",
Description: "Inbound TCP connection timeout in the proxy. Defaults to `100ms`",
},
{
Name: k8s.ProxyOutboundDiscoveryCacheUnusedTimeout,