Skip to content

Commit 8b4d4fd

Browse files
authored
Merge pull request #1657 from fluent/lynettemiles/sc-135606/update-fluent-bit-fluent-bit-docs-administration
2 parents 9fe4552 + 537f66f commit 8b4d4fd

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
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, Fluent Bit recommends using uppercase names for environment variables. The following example defines two variables, `FLUSH_INTERVAL` and `STDOUT_FMT`, which can be accessed in the configuration using `${FLUSH_INTERVAL}` and `${STDOUT_FMT}`:
66

77
```yaml
88
env:
@@ -23,19 +23,19 @@ pipeline:
2323
format: ${STDOUT_FMT}
2424
```
2525
26-
## Predefined Variables
26+
## Predefined variables
2727
2828
Fluent Bit provides a set of predefined environment variables that can be used in your configuration:
2929
3030
| Name | Description |
31-
|--|--|
31+
| ---- | ----------- |
3232
| `${HOSTNAME}` | The system's hostname. |
3333

34-
## External Variables
34+
## External variables
3535

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.
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.
3737

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

4040
```bash
4141
export FLUSH_INTERVAL=2
@@ -58,4 +58,4 @@ pipeline:
5858
format: json_lines
5959
```
6060

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

0 commit comments

Comments
 (0)