Skip to content

Commit 4c620f2

Browse files
cosmo0920lecaros
andauthored
in_forward: Add descrioptions for secure forward related parameters (#1354)
* in_forward: Add descrioptions for secure forward related parameters To work as secure forward connection, there are a few parameters to be needed to specify: * shared_key * self_hostname * security.users Signed-off-by: Hiroshi Hatake <hiroshi@chronosphere.io> * Update pipeline/inputs/forward.md Co-authored-by: José Lecaros <lecaros@calyptia.com> Signed-off-by: Hiroshi Hatake <hiroshi@chronosphere.io> * in_forward: Add an example for secure forward protocol without TLS Signed-off-by: Hiroshi Hatake <hiroshi@chronosphere.io> --------- Signed-off-by: Hiroshi Hatake <hiroshi@chronosphere.io> Co-authored-by: José Lecaros <lecaros@calyptia.com>
1 parent 8a615cc commit 4c620f2

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

pipeline/inputs/forward.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ The plugin supports the following configuration parameters:
1717
| Buffer\_Chunk\_Size | By default the buffer to store the incoming Forward messages, do not allocate the maximum memory allowed, instead it allocate memory when is required. The rounds of allocations are set by _Buffer\_Chunk\_Size_. The value must be according to the [Unit Size ](../../administration/configuring-fluent-bit/unit-sizes.md)specification. | 1024000 |
1818
| Tag_Prefix | Prefix incoming tag with the defined value.| |
1919
| Tag | Override the tag of the forwarded events with the defined value.| |
20+
| Shared\_Key | Shared key for secure forward authentication. | |
21+
| Self\_Hostname | Hostname for secure forward authentication. | |
22+
| Security.Users | Specify the username and password pairs for secure forward authentication. | |
2023

2124
## Getting Started
2225

@@ -74,6 +77,51 @@ pipeline:
7477
{% endtab %}
7578
{% endtabs %}
7679
80+
## Fluent Bit + Secure Forward Setup
81+
82+
Since Fluent Bit v3, in\_forward can handle secure forward protocol.
83+
84+
For using user-password authentication, it needs to specify `secutiry.users` at least an one-pair.
85+
For using shared key, it needs to specify `shared_key` in both of forward output and forward input.
86+
`self_hostname` is not able to specify with the same hostname between fluent servers and clients.
87+
88+
{% tabs %}
89+
{% tab title="fluent-bit-secure-forward.conf" %}
90+
```python
91+
[INPUT]
92+
Name forward
93+
Listen 0.0.0.0
94+
Port 24224
95+
Buffer_Chunk_Size 1M
96+
Buffer_Max_Size 6M
97+
Security.Users fluentbit changeme
98+
Shared_Key secret
99+
Self_Hostname flb.server.local
100+
101+
[OUTPUT]
102+
Name stdout
103+
Match *
104+
```
105+
{% endtab %}
106+
107+
{% tab title="fluent-bit-secure-forward.yaml" %}
108+
```yaml
109+
pipeline:
110+
inputs:
111+
- name: forward
112+
listen: 0.0.0.0
113+
port: 24224
114+
buffer_chunk_size: 1M
115+
buffer_max_size: 6M
116+
security.users: fluentbit changeme
117+
shared_key: secret
118+
self_hostname: flb.server.local
119+
outputs:
120+
- name: stdout
121+
match: '*'
122+
```
123+
{% endtab %}
124+
{% endtabs %}
77125

78126
## Testing
79127

0 commit comments

Comments
 (0)