Skip to content

docs: administration: yaml: document extended env list form#2543

Open
eschabell wants to merge 1 commit intofluent:masterfrom
eschabell:erics_admin_extended_env_vars_update
Open

docs: administration: yaml: document extended env list form#2543
eschabell wants to merge 1 commit intofluent:masterfrom
eschabell:erics_admin_extended_env_vars_update

Conversation

@eschabell
Copy link
Copy Markdown
Collaborator

@eschabell eschabell commented Apr 13, 2026

  • Add map form and extended list form headings to organize existing and new content
  • Document extended list form properties: name, value, uri, and refresh_interval
  • Add YAML example showing file-backed secrets with automatic refresh
  • Explain runtime refresh behavior for file:// URI-backed variables

This update for code commits without supporting docs PR.

Summary by CodeRabbit

Documentation

  • Environment variables configuration now supports two forms: a map form for static key-value pairs and an extended list form for advanced configurations with new properties (name, value, uri, refresh_interval).
  • Added support for file-backed variables with configurable refresh intervals for periodic value re-reading.

@eschabell eschabell self-assigned this Apr 13, 2026
@eschabell eschabell requested a review from a team as a code owner April 13, 2026 14:06
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0.3 labels Apr 13, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 13, 2026

Warning

Rate limit exceeded

@eschabell has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 49 minutes and 18 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 49 minutes and 18 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6905f6e6-4d1d-4d5a-920c-1f4b29fc2e6a

📥 Commits

Reviewing files that changed from the base of the PR and between 099ba5a and 87c9ab7.

📒 Files selected for processing (1)
  • administration/configuring-fluent-bit/yaml/environment-variables-section.md
📝 Walkthrough

Walkthrough

The documentation for Fluent Bit's env section in YAML configuration has been restructured to describe two configuration forms: a map form for static key-value variables and an extended list form supporting advanced entries with properties like uri and refresh_interval. An example demonstrating file-backed variables with refresh intervals has been added.

Changes

Cohort / File(s) Summary
Documentation Update
administration/configuring-fluent-bit/yaml/environment-variables-section.md
Restructured env section documentation into map form and extended list form subsections. Added new properties (uri, refresh_interval) with validation rules and example of file-backed secret variables with refresh intervals.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

5.0

Suggested reviewers

  • patrick-stephens

Poem

🐰 A tale of variables, both old and new,
Map forms and lists, in every hue,
Files now whisper their secrets true,
Refreshed and ready, the docs shine through!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and specifically describes the main change: documenting the extended env list form in YAML administration configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@administration/configuring-fluent-bit/yaml/environment-variables-section.md`:
- Line 38: The table cell for the `uri` field currently has backticks around
both the `file://` scheme and the plural word "URIs"; update the text so only
the scheme is code-formatted: keep `file://` in backticks but remove backticks
around "URIs" (i.e., change "`URIs`" to URIs) in the line describing the `uri`
property to correct formatting while preserving the example
`file:///run/secrets/my_secret`.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e66cc3b8-871c-473f-954b-19347a9af857

📥 Commits

Reviewing files that changed from the base of the PR and between 67f97c7 and 099ba5a.

📒 Files selected for processing (1)
  • administration/configuring-fluent-bit/yaml/environment-variables-section.md

Comment thread administration/configuring-fluent-bit/yaml/environment-variables-section.md Outdated
  - Add map form and extended list form headings to organize existing and new content
  - Document extended list form properties: name, value, uri, and refresh_interval
  - Add YAML example showing file-backed secrets with automatic refresh
  - Explain runtime refresh behavior for file:// URI-backed variables

  This update for code commits without supporting docs PR.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_admin_extended_env_vars_update branch from 099ba5a to 87c9ab7 Compare April 13, 2026 14:17
@eschabell
Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5.0.3 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant