Commit 5f860db
[chore] Clarify TLS docs: mTLS is optional, not mandatory (#15143)
## Summary
Rewords the TLS configuration documentation to clarify that mutual TLS
(mTLS) is optional and standard TLS works by default.
Fixes #13757
## Problem
The current documentation reads as if `cert_file` and `key_file` are
always required ("the following parameters are also required"), which
leads readers to believe that mTLS is mandatory. This causes confusion
for users who only need standard TLS (server certificate verification).
## Changes
- Clarified upfront that standard TLS works by default with system root
CAs
- Explicitly stated mTLS is optional
- Reworded "the following parameters are also required" to "the
following certificate parameters can be configured"
- Clarified when `cert_file`/`key_file` are actually needed (server:
always for TLS, client: only for mTLS)
- Moved `ca_file` before `cert_file`/`key_file` since it's the more
commonly needed parameter
## Test Plan
- [x] Documentation-only change
Co-authored-by: Bogdan Drutu <bogdandrutu@gmail.com>
Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>1 parent bd1b758 commit 5f860db
1 file changed
Lines changed: 19 additions & 16 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
11 | | - | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
12 | 16 | | |
13 | | - | |
14 | | - | |
| 17 | + | |
| 18 | + | |
15 | 19 | | |
16 | 20 | | |
17 | 21 | | |
| |||
21 | 25 | | |
22 | 26 | | |
23 | 27 | | |
24 | | - | |
| 28 | + | |
25 | 29 | | |
26 | | - | |
27 | | - | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
28 | 38 | | |
29 | 39 | | |
30 | | - | |
31 | | - | |
| 40 | + | |
| 41 | + | |
32 | 42 | | |
33 | 43 | | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | 44 | | |
42 | 45 | | |
43 | 46 | | |
| |||
0 commit comments