Skip to content

Commit 7cfa640

Browse files
authored
Merge pull request #1660 from fluent/lynettemiles/sc-135603/update-fluent-bit-fluent-bit-docs-administration
2 parents 89a0f4c + 7fafd07 commit 7cfa640

File tree

1 file changed

+19
-20
lines changed

1 file changed

+19
-20
lines changed
Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
1-
# Upstream Servers
1+
# Upstream servers
22

3-
It's common that Fluent Bit [output plugins](../../pipeline/outputs/) aims to connect to external services to deliver the logs over the network, this is the case of [HTTP](../../../pipeline/outputs/http.md), [Elasticsearch](../../../pipeline/outputs/elasticsearch.md) and [Forward](../../../pipeline/outputs/forward.md) within others. Being able to connect to one node \(host\) is normal and enough for more of the use cases, but there are other scenarios where balancing across different nodes is required. The _Upstream_ feature provides such capability.
3+
Fluent Bit [output plugins](../../pipeline/outputs/) aim to connect to external services to deliver logs over the network. Being able to connect to one node (host) is normal and enough for more of the use cases, but there are other scenarios where balancing across different nodes is required. The `Upstream` feature provides this capability.
44

5-
An _Upstream_ defines a set of nodes that will be targeted by an output plugin, by the nature of the implementation an output plugin **must** support the _Upstream_ feature. The following plugin\(s\) have _Upstream_ support:
5+
An `Upstream` defines a set of nodes that will be targeted by an output plugin, by the nature of the implementation an output plugin must support the `Upstream` feature. The following plugin has `Upstream` support:
66

7-
* [Forward](../../../pipeline/outputs/forward.md)
7+
- [Forward](../../../pipeline/outputs/forward.md)
88

9-
The current balancing mode implemented is _round-robin_.
9+
The current balancing mode implemented is `round-robin`.
1010

1111
## Configuration
1212

13-
To define an _Upstream_ it's required to create an specific configuration file that contains an UPSTREAM and one or multiple NODE sections. The following table describe the properties associated to each section. Note that all of them are mandatory:
13+
To define an `Upstream` you must create an specific configuration file that contains an `UPSTREAM` and one or multiple `NODE` sections. The following table describes the properties associated with each section. All properties are mandatory:
1414

1515
| Section | Key | Description |
1616
| :--- | :--- | :--- |
17-
| UPSTREAM | name | Defines a name for the _Upstream_ in question. |
18-
| NODE | name | Defines a name for the _Node_ in question. |
19-
| | host | IP address or hostname of the target host. |
20-
| | port | TCP port of the target service. |
17+
| `UPSTREAM` | `name` | Defines a name for the `Upstream in question. |
18+
| `NODE` | `name` | Defines a name for the `Node` in question. |
19+
| | `host` | IP address or hostname of the target host. |
20+
| | `port` | TCP port of the target service. |
2121

2222
### Nodes and specific plugin configuration
2323

24-
A _Node_ might contain additional configuration keys required by the plugin, on that way we provide enough flexibility for the output plugin, a common use case is Forward output where if TLS is enabled, it requires a shared key \(more details in the example below\).
24+
A `Node` might contain additional configuration keys required by the plugin, to provide enough flexibility for the output plugin. A common use case is a `Forward` output where if TLS is enabled, it requires a shared key.
2525

26-
### Nodes and TLS \(Transport Layer Security\)
26+
### Nodes and TLS (Transport Layer Security)
2727

28-
In addition to the properties defined in the table above, the network operations against a defined node can optionally be done through the use of TLS for further encryption and certificates use.
28+
In addition to the properties defined in the configuration table, the network operations against a defined node can optionally be done through the use of TLS for further encryption and certificates use.
2929

3030
The TLS options available are described in the [TLS/SSL](../../transport-security.md) section and can be added to the any _Node_ section.
3131

32-
### Configuration File Example
32+
### Configuration file example
3333

34-
The following example defines an _Upstream_ called forward-balancing which aims to be used by Forward output plugin, it register three _Nodes_:
34+
The following example defines an `Upstream` called forward-balancing which aims to be used by Forward output plugin, it register three `Nodes`:
3535

36-
* node-1: connects to 127.0.0.1:43000
37-
* node-2: connects to 127.0.0.1:44000
38-
* node-3: connects to 127.0.0.1:45000 using TLS without verification. It also defines a specific configuration option required by Forward output called _shared\_key_.
36+
- node-1: connects to 127.0.0.1:43000
37+
- node-2: connects to 127.0.0.1:44000
38+
- node-3: connects to 127.0.0.1:45000 using TLS without verification. It also defines a specific configuration option required by Forward output called `shared_key`.
3939

4040
```python
4141
[UPSTREAM]
@@ -60,5 +60,4 @@ The following example defines an _Upstream_ called forward-balancing which aims
6060
shared_key secret
6161
```
6262

63-
Note that every _Upstream_ definition **must** exists on it own configuration file in the file system. Adding multiple _Upstreams_ in the same file or different files is not allowed.
64-
63+
Every `Upstream` definition must exists in its own configuration file in the file system. Adding multiple `Upstream` configurations in the same file or different files isn't allowed.

0 commit comments

Comments
 (0)