doc: add TLS related warnings #12060
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spzala
reviewed
Jun 23, 2020
Documentation/op-guide/gateway.md
Outdated
| @@ -103,5 +103,5 @@ $ etcd gateway start --discovery-srv=example.com | |||
|
|
|||
| #### --trusted-ca-file | |||
|
|
|||
| * Path to the client TLS CA file for the etcd cluster. Used to authenticate endpoints. | |||
| * Path to the client TLS CA file for the etcd cluster to verify the endpoints returned from SRV discovery. Note that it is ONLY used for authenticating the discovered endpoints rather than creating connections for data transfereing. The gateway never terminates TLS connections or create TLS connections on behave of its clients. | |||
There was a problem hiding this comment.
Nit - typo :-) transfereing vs transferring Thanks @xiang90
Documentation/op-guide/gateway.md
Outdated
| @@ -103,5 +103,5 @@ $ etcd gateway start --discovery-srv=example.com | |||
|
|
|||
| #### --trusted-ca-file | |||
|
|
|||
| * Path to the client TLS CA file for the etcd cluster. Used to authenticate endpoints. | |||
| * Path to the client TLS CA file for the etcd cluster to verify the endpoints returned from SRV discovery. Note that it is ONLY used for authenticating the discovered endpoints rather than creating connections for data transfereing. The gateway never terminates TLS connections or create TLS connections on behave of its clients. | |||
There was a problem hiding this comment.
Also, another nit - should we use "behalf" instead of "behave"?
Documentation/op-guide/gateway.md
Outdated
| @@ -4,7 +4,7 @@ title: etcd gateway | |||
|
|
|||
| ## What is etcd gateway | |||
|
|
|||
| etcd gateway is a simple TCP proxy that forwards network data to the etcd cluster. The gateway is stateless and transparent; it neither inspects client requests nor interferes with cluster responses. | |||
| etcd gateway is a simple TCP proxy that forwards network data to the etcd cluster. The gateway is stateless and transparent; it neither inspects client requests nor interferes with cluster responses. It does not terminate TLS connections, do TLS handshakes on behave of its clients, or verify if the connection is secured. | |||
There was a problem hiding this comment.
Nit - should we use "behalf" instead of "behave"?
spzala
approved these changes
Jun 24, 2020
This was referenced Jun 24, 2020
gyuho
added a commit
that referenced
this pull request
Jun 25, 2020
…-upstream-release-3.3 Automated cherry pick of #12060
gyuho
added a commit
that referenced
this pull request
Jun 25, 2020
…-upstream-release-3.4 Automated cherry pick of #12060
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
/cc @gyuho @spzala @mitake