Skip to content

Commit 4530560

Browse files
committed
transport section: Add example and more parameters
Signed-off-by: Masahiro Nakagawa <repeatedly@gmail.com>
1 parent 3471476 commit 4530560

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

configuration/transport-section.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Transport section configurations
22

3-
Fluentd's input, output, and filter plugins which use `server` plugin
3+
Fluentd's input, output, and filter plugins which use `server`/`http_server` plugin
44
helper support the `<transport>` section to specify how to handle
55
connection.
66

@@ -11,21 +11,55 @@ Transport section must be in `<match>`, `<source>`, and `<filter>`
1111
sections. It's specifying transport protocol, its version, and
1212
certificates.
1313

14+
```
15+
# tcp
16+
<transport tcp>
17+
</transport>
18+
19+
# udp
20+
<transport udp>
21+
</transport>
22+
23+
# tls
24+
<transport tls>
25+
cert_path /path/to/fluentd.crt
26+
private_key_path /path/to/fluentd.key
27+
private_key_passphrase YOUR_PASSPHRASE
28+
# ... other parameters ...
29+
</transport>
30+
```
1431

1532
## Parameters
1633

1734
- `protocol` \[enum\]
1835
- Default: :tcp
36+
- Specify like `<transport tls>`. Supported values are `tcp`, `udp` and `tls`
37+
38+
### TLS setting
39+
1940
- `version` \[enum\]
2041
- Default: `'TLSv1_2'`
42+
- `min_version` \[enum\]
43+
- Default: nil
44+
- Specify the lower bound of the supported SSL/TLS protocol. Supported values are `TLS1_1`, `TLS1_2` and `TLS1_3`
45+
- `max_version` \[enum\]
46+
- Default: nil
47+
- Specify the upper bound of the supported SSL/TLS protocol. Supported values are `TLS1_1`, `TLS1_2` and `TLS1_3`
2148
- `ciphers` \[string\]
2249
- Default: `"ALL:!aNULL:!eNULL:!SSLv2"`
2350
- OpenSSL 1.0.0 or higher default.
2451
- `insecure` \[bool\]
2552
- Default: false (use secure connection when use tls)
2653

54+
If you want to accept multiple TLS protocols, use `min_version`/`max_version` instead of `version`.
55+
To support old style, fluentd accepts `TLS1_1` and `TLSv1_1` value.
56+
57+
NOTE: `TLS1_3` is available when your system supports TLS 1.3.
58+
2759
### Signed public CA parameters
2860

61+
For `<transport tls>`:
62+
2963
- `ca_path`: \[string\]
3064
- Default: nil
3165
- Specify path to CA certificate file
@@ -50,6 +84,8 @@ certificates.
5084

5185
### Generated and signed by private CA parameters
5286

87+
For `<transport tls>`:
88+
5389
- `ca_cert_path`: \[string\]
5490
- Default: nil
5591
- Specify private CA contained path
@@ -63,6 +99,8 @@ certificates.
6399

64100
### Generated and signed by private CA certs or self-signed parameters
65101

102+
For `<transport tls>`:
103+
66104
- `generate_private_key_length`: \[integer\]
67105
- Default: 2048
68106
- `generate_cert_country`: \[string\]
@@ -79,9 +117,11 @@ certificates.
79117

80118
## Cert digest algorithm parameter
81119

120+
For `<transport tls>`:
121+
82122
- `generate_cert_digest`: \[enum\]
83123
- Default: :sha256
84-
124+
- Supported values are `sha1`, `sha256`, `sha384` and `sha512`
85125

86126
------------------------------------------------------------------------
87127

0 commit comments

Comments
 (0)