Skip to content

Commit 3da9e70

Browse files
committed
admin/config/yaml/env-variable style updates
Signed-off-by: Lynette Miles <[email protected]>
1 parent fdacfc6 commit 3da9e70

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

administration/configuring-fluent-bit/yaml/environment-variables-section.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
# Environment Variables Section
1+
# Environment variables section
22

3-
The `env` section allows you to define environment variables directly within the configuration file. These variables can then be used to dynamically replace values throughout your configuration using the `${VARIABLE_NAME}` syntax.
3+
The `env` section lets you define environment variables directly within the configuration file. These variables can then be used to dynamically replace values throughout your configuration using the `${VARIABLE_NAME}` syntax.
44

5-
Values set in the `env` section are case-sensitive. However, as a best practice, we recommend using uppercase names for environment variables. The example below defines two variables, `FLUSH_INTERVAL` and `STDOUT_FMT`, which can be accessed in the configuration using `${FLUSH_INTERVAL}` and `${STDOUT_FMT}`:
5+
Values set in the `env` section are case-sensitive. However, as a best practice,
6+
Fluent Bit recommends using uppercase names for environment variables. The following
7+
example defines two variables, `FLUSH_INTERVAL` and `STDOUT_FMT`, which can be
8+
accessed in the configuration using `${FLUSH_INTERVAL}` and `${STDOUT_FMT}`:
69

710
```yaml
811
env:
@@ -23,19 +26,19 @@ pipeline:
2326
format: ${STDOUT_FMT}
2427
```
2528
26-
## Predefined Variables
29+
## Predefined variables
2730
2831
Fluent Bit provides a set of predefined environment variables that can be used in your configuration:
2932
3033
| Name | Description |
31-
|--|--|
34+
| ---- | ----------- |
3235
| `${HOSTNAME}` | The system's hostname. |
3336

34-
## External Variables
37+
## External variables
3538

36-
In addition to variables defined in the configuration file or the predefined ones, Fluent Bit can access system environment variables set in the user space. These external variables can be referenced in the configuration using the same ${VARIABLE_NAME} pattern.
39+
In addition to variables defined in the configuration file or the predefined ones, Fluent Bit can access system environment variables set in the user space. These external variables can be referenced in the configuration using the same `${VARIABLE_NAME}` pattern.
3740

38-
For example, to set the FLUSH_INTERVAL system environment variable to 2 and use it in your configuration:
41+
For example, to set the `FLUSH_INTERVAL` system environment variable to `2` and use it in your configuration:
3942

4043
```bash
4144
export FLUSH_INTERVAL=2
@@ -58,4 +61,4 @@ pipeline:
5861
format: json_lines
5962
```
6063

61-
This approach allows you to easily manage and override configuration values using environment variables, providing flexibility in various deployment environments.
64+
This approach lets you manage and override configuration values using environment variables, providing flexibility in various deployment environments.

0 commit comments

Comments
 (0)