Skip to content

docs: pipeline: outputs: forward: note shared_key requirement for credentials#2617

Merged
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_out_forward_updates
Jul 10, 2026
Merged

docs: pipeline: outputs: forward: note shared_key requirement for credentials#2617
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_out_forward_updates

Conversation

@eschabell

@eschabell eschabell commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

Document that username and password require shared_key or empty_shared_key to be configured. Credentials are exchanged only during the secure forward handshake, and Fluent Bit now fails to start if they are set without a shared key.

Note this update due to code change without matching docs PR.

Summary by CodeRabbit

  • Documentation
    • Clarified the Secure Forward configuration reference for username and password.
    • Added guidance that these values require shared_key or empty_shared_key to be set for the secure forward handshake.

…dentials

Document that username and password require shared_key or
empty_shared_key to be configured. Credentials are exchanged only
during the secure forward handshake, and Fluent Bit now fails to start
if they are set without a shared key.

Note this update due to code change without matching docs PR.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Jul 7, 2026
@eschabell eschabell requested a review from a team as a code owner July 7, 2026 21:32
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0.9 labels Jul 7, 2026
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 97cea373-c839-4be4-b259-16e654a16923

📥 Commits

Reviewing files that changed from the base of the PR and between 8892466 and c9e6ad8.

📒 Files selected for processing (1)
  • pipeline/outputs/forward.md

📝 Walkthrough

Walkthrough

Documentation update to the Secure Forward configuration parameter table in pipeline/outputs/forward.md, revising the username and password entries to note that they require shared_key or empty_shared_key to be set, since credentials are exchanged only during the secure forward handshake.

Changes

Forward Output Documentation

Layer / File(s) Summary
Username/password requirement clarification
pipeline/outputs/forward.md
Updated table rows for username and password to state the requirement of shared_key or empty_shared_key for handshake-based credential exchange.

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

Possibly related PRs

  • fluent/fluent-bit-docs#2230: Both PRs update Forward secure-forward authentication documentation to clarify how user credentials relate to shared_key/empty_shared_key.

Suggested reviewers: alexakreizinger

🚥 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 summarizes the docs change about requiring shared_key for forward credentials.
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.

@eschabell eschabell changed the title docs: pipeline: outputs: forward: note shared_key requirement for cre… docs: pipeline: outputs: forward: note shared_key requirement for credentials Jul 7, 2026
@eschabell

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@eschabell

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@eschabell eschabell merged commit a391227 into fluent:master Jul 10, 2026
8 checks passed
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Jul 10, 2026
@eschabell eschabell deleted the erics_out_forward_updates branch July 10, 2026 10:44
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