Skip to content

docs: sync tls.crl_file version annotation into TLS tables - #2733

Merged
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_docs_tls_crl_file_updates
Sep 26, 2026
Merged

eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_docs_tls_crl_file_updates

Conversation

@eschabell

@eschabell eschabell commented Sep 26, 2026 •

Copy link
Copy Markdown
Collaborator

tls.crl_file is not present in v5.1.2 or any earlier tag. It landed on
fluent-bit master after that release and ships in v5.1.3, so the tables
that document it currently offer a setting no released build accepts.

Append "Supported in v5.1.3 or later." to the tls.crl_file description
in each table, matching the convention already used for tls.proxy.* in
administration/transport-security.md.

The reserved config key list in development/golang-output-plugins.md is
left alone. It reserves a name rather than documenting availability.

Refs #2727

  tls.crl_file is not present in v5.1.2 or any earlier tag. It landed on
  fluent-bit master after that release and ships in v5.1.3, so the tables
  that document it currently offer a setting no released build accepts.

  Append "Supported in v5.1.3 or later." to the tls.crl_file description
  in each table, matching the convention already used for tls.proxy.* in
  administration/transport-security.md.

  The reserved config key list in development/golang-output-plugins.md is
  left alone. It reserves a name rather than documenting availability.

  Refs fluent#2727

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
eschabell requested review from a team and patrick-stephens as code owners September 26, 2026 10:55
@coderabbitai

coderabbitai Bot commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 9a036096-487e-44e0-87a6-0c1d57e32081

📥 Commits

Reviewing files that changed from the base of the PR and between ca2da90 and 8531769.

📒 Files selected for processing (7)
  • administration/transport-security.md
  • pipeline/inputs/opentelemetry.md
  • pipeline/outputs/azure_kusto.md
  • pipeline/outputs/forward.md
  • pipeline/outputs/opentelemetry.md
  • pipeline/outputs/s3.md
  • pipeline/outputs/tcp-and-tls.md

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.


📝 Walkthrough

Walkthrough

The tls.crl_file documentation now states that the option is supported in Fluent Bit v5.1.3 or later. Existing defaults and descriptions of CRL behavior remain unchanged.

Changes

CRL support version documentation

Layer / File(s) Summary
Document the supported version
administration/transport-security.md, pipeline/inputs/opentelemetry.md, pipeline/outputs/azure_kusto.md, pipeline/outputs/forward.md, pipeline/outputs/opentelemetry.md, pipeline/outputs/s3.md, pipeline/outputs/tcp-and-tls.md
The tls.crl_file descriptions add the v5.1.3-or-later support note. Existing CRL behavior and defaults remain unchanged.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 85317

The version note aligns with shared TLS support targeted for v5.1.3 and tells users when CRL revocation checks are available. No concrete regression is established, so the documentation change is ready for normal checks.

Architecture Summary

Architecture risk: 🔵 Low · up to 85317

The change affects 2 systems.

Changed systems: pipeline, administration

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — pipeline (service) was modified; 6 changed files map to changed impact.
  • observed — administration (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in administration/transport-security.md: Added the v5.1.3-or-later availability note to the tls.crl_file property description; its path, revocation-check behavior, and default remain unchanged.
  • observed — Modified behavior in pipeline/inputs/opentelemetry.md: Added the version requirement that tls.crl_file is supported in v5.1.3 or later; the CRL format, rejection behavior, and default remain unchanged.
  • observed — Modified behavior in pipeline/outputs/azure_kusto.md: The tls.crl_file description adds a minimum-version note: supported in v5.1.3 or later.
  • observed — Modified behavior in pipeline/outputs/forward.md: The tls.crl_file description adds the v5.1.3-or-later support qualification; its CRL format, revocation behavior, and default are unchanged.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation change: synchronizing the tls.crl_file version annotation across TLS tables.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

@eschabell eschabell self-assigned this Sep 26, 2026
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.1.2 labels Sep 26, 2026
@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Sep 26, 2026
@eschabell
eschabell merged commit 8fc3c09 into fluent:master Sep 26, 2026
8 checks passed
@eschabell
eschabell deleted the erics_docs_tls_crl_file_updates branch September 26, 2026 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants