Skip to content

docs: administration: transport-security: document certificate reload - #2647

Open
eschabell wants to merge 1 commit into
fluent:masterfrom
eschabell:erics_admin_transport_security_updates
Open

docs: administration: transport-security: document certificate reload#2647
eschabell wants to merge 1 commit into
fluent:masterfrom
eschabell:erics_admin_transport_security_updates

Conversation

@eschabell

@eschabell eschabell commented Aug 1, 2026

Copy link
Copy Markdown
Collaborator

Document that Fluent Bit reloads TLS certificates from disk when it creates a new session, covering the files it watches, how it detects changes including inode swaps from Kubernetes secret updates, that established sessions keep their existing context, and what happens when a reload fails.

Note, updates for code changes without corresponding docs PR.

Summary by CodeRabbit

  • Documentation
    • Added guidance for automatic TLS certificate and CA file reloading in Fluent Bit 5.1 and later.
    • Documented support for both input and output plugins.
    • Clarified that existing sessions remain unchanged while new sessions use updated certificates.
    • Explained error handling and retry behavior when certificate reloading fails.

@eschabell eschabell self-assigned this Aug 1, 2026
@eschabell
eschabell requested a review from a team as a code owner August 1, 2026 11:39
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0.9 labels Aug 1, 2026
@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@eschabell, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 50 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e317905a-92a4-4221-857a-6e1be7f25691

📥 Commits

Reviewing files that changed from the base of the PR and between 2023ce8 and bb4f16c.

📒 Files selected for processing (1)
  • administration/transport-security.md
📝 Walkthrough

Walkthrough

Changes

TLS certificate reload

Layer / File(s) Summary
Document automatic TLS reload behavior
administration/transport-security.md
Documents certificate and CA file change detection, TLS context rebuilding for new sessions, retention of existing session contexts, and retry behavior after reload failures.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: patrick-stephens

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the documentation change for TLS certificate reload behavior.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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 current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@administration/transport-security.md`:
- Line 220: Update the TLS session reload description to distinguish tls.ca_path
as a directory that Fluent Bit scans from tls.ca_file, tls.crt_file, and
tls.key_file as individual files. Describe reload detection accurately without
implying that tls.ca_path itself is a file reference.
🪄 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 Plus

Run ID: f3669a69-33e2-4e49-997f-86f5ebe3b2a6

📥 Commits

Reviewing files that changed from the base of the PR and between 0eb06a6 and 2023ce8.

📒 Files selected for processing (1)
  • administration/transport-security.md

Comment thread administration/transport-security.md Outdated
Document that Fluent Bit reloads TLS certificates from disk when it
creates a new session, covering the files it watches, how it detects
changes including inode swaps from Kubernetes secret updates, that
established sessions keep their existing context, and what happens when
a reload fails. Also clarify tls.ca_path reload detection.

Note, updates for code changes without corresponding docs PR.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
eschabell force-pushed the erics_admin_transport_security_updates branch from 2023ce8 to bb4f16c Compare August 1, 2026 11:49
@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.9 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant