Skip to content

Admin:config:yaml:includes Style updates #1655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 14, 2025
Merged

Admin:config:yaml:includes Style updates #1655

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e1f204f
Admin:config:yaml:includes Style updates
esmerel May 14, 2025
5d97cb6
forgot something:
esmerel May 14, 2025
ae71c43
Update administration/configuring-fluent-bit/yaml/includes-section.md
esmerel May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 9 additions & 13 deletions administration/configuring-fluent-bit/yaml/includes-section.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,28 @@
# Includes Section
# Includes section

The `includes` section allows you to specify additional YAML configuration files to be merged into the current configuration. These files are identified as a list of filenames and can include relative or absolute paths. If no absolute path is provided, the file is assumed to be located in a directory relative to the file that references it.
The `includes` section lets you specify additional YAML configuration files to be merged into the current configuration. These files are identified as a list of filenames and can include relative or absolute paths. If no absolute path is provided, the file is assumed to be located in a directory relative to the file that references it.

This feature is useful for organizing complex configurations into smaller, manageable files and including them as needed.
Use this section to organize complex configurations into smaller, manageable files and include them as needed.

### Usage
## Usage

Below is an example demonstrating how to include additional YAML files using relative path references. This is the file system path structure
The following example demonstrates how to include additional YAML files using relative path references. This is the file system path structure:

```
```text
├── fluent-bit.yaml
├── inclusion-1.yaml
└── subdir
└── inclusion-2.yaml
```

The content of `fluent-bit.yaml`
The content of `fluent-bit.yaml`:

```yaml
includes:
- inclusion-1.yaml
- subdir/inclusion-2.yaml
```

## Key Points

- Relative Paths: If a path is not specified as absolute, it will be treated as relative to the file that includes it.

- Organized Configurations: Using the includes section helps keep your configuration modular and easier to maintain.
Ensure that the included files are formatted correctly and contain valid YAML configurations for seamless integration.

> note: Ensure that the included files are formatted correctly and contain valid YAML configurations for seamless integration.
If a path isn't specified as absolute, it will be treated as relative to the file that includes it.