Skip to content

docs: Warn operators to bound grpc-max-response-pool-size - #8880

Merged
yinggeh merged 1 commit into
mainfrom
yinggeh/docs-grpc-max-response-pool-size-deployment-guidance
Jul 13, 2026
Merged

docs: Warn operators to bound grpc-max-response-pool-size#8880
yinggeh merged 1 commit into
mainfrom
yinggeh/docs-grpc-max-response-pool-size-deployment-guidance

Conversation

@yinggeh

@yinggeh yinggeh commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

What does the PR do?

Adds a deployment warning under --grpc-max-response-pool-size in the secure deployment guide. Operators exposing decoupled gRPC streaming to untrusted clients should set an explicit bounded value for this option instead of relying on the default INT_MAX.

Checklist

  • PR title reflects the change and is of format <commit_type>: <Title>
  • Changes are described in the pull request.
  • Related issues are referenced.
  • Populated github labels field
  • Added test plan and verified test passes.
  • Verified that the PR passes existing CI.
  • Verified copyright is correct on all changed files.
  • Added succinct git squash message before merging ref.
  • All template sections are filled out.
  • Optional: Additional screenshots for behavior/output changes with before/after.

Commit Type:

Check the conventional commit type
box here and add the label to the github PR.

  • build
  • ci
  • docs
  • feat
  • fix
  • perf
  • refactor
  • revert
  • style
  • test

Related PRs:

N/A

Where should the reviewer start?

docs/customization_guide/deploy.md — the new warning under --grpc-max-response-pool-size.

Test plan:

  • Documentation-only change; no runtime tests required.

  • Verified the added warning text matches the agreed deployment guidance.

  • CI Pipeline ID:
    N/A

Caveats:

None.

Background

External security researchers asked which deployment guideline documents the intended mitigation for unbounded decoupled gRPC response queue growth. This documents the recommended operator action for that scenario.

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

N/A

Add deployment guidance for decoupled gRPC streaming exposed to
untrusted clients so operators set an explicit limit instead of
relying on the default INT_MAX.
@yinggeh yinggeh self-assigned this Jul 13, 2026
@yinggeh
yinggeh merged commit a0ac15e into main Jul 13, 2026
3 checks passed
@yinggeh
yinggeh deleted the yinggeh/docs-grpc-max-response-pool-size-deployment-guidance branch July 13, 2026 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants