Skip to content

docs(operator-guide): record client features we don't enable - #665

Merged
MaxRink merged 1 commit into
mainfrom
docs/client-features-not-enabled
Nov 17, 2026
Merged

MaxRink merged 1 commit into
mainfrom
docs/client-features-not-enabled

Conversation

@MaxRink

@MaxRink MaxRink commented Nov 17, 2026

Copy link
Copy Markdown
Collaborator

Closes #510

Description

Adds "Client Features We Don't Enable" under Security Considerations in docs/operator-guide.md, so the reasoning from #510 is found where operators look:

  • CBOR (ClientsPreferCBOR, ClientsAllowCBOR): never enable. Before 1.35, an apiserver with ClientsPreferCBOR sent an inappropriate Content-Type to authorization and token-authentication webhooks (kubernetes#132960). A malformed request to /authorize turns into an access-control decision.
  • WatchList (WatchListClient): do not force or rely on it. The gate changed state in almost every release from 1.30 to 1.35, 1.34 removed streaming from List(), and 1.34 informers ignored Transformer funcs.
  • Do not set the matching KUBE_FEATURE_* overrides in the operator's environment.

One correction to the issue's framing: client-go 0.35+ (we use 0.37.2) turns WatchListClient on by default for informers, and they fall back to a plain LIST when the server doesn't support streaming. The operator doesn't override that default, so the doc says "don't force or rely on it" for WatchList instead of claiming it is disabled. CBOR gates are alpha and off by default. A grep of the repo finds no use of ClientsPreferCBOR, ClientsAllowCBOR, WatchListClient or KUBE_FEATURE_.

I skipped a static test that greps for these gates. AGENTS.md rule 8 asks for no tests that only inspect source or config text.

Type of Change

  • 📚 Documentation update

API Changes

  • No API changes

🤖 Generated with Claude Code

Move the guidance from #510 into the operator guide: never enable the
CBOR client gates in a component that talks to an authorization or
token-authentication webhook, and do not force or rely on WatchList API
streaming. Also warn against the matching KUBE_FEATURE_* overrides.

Closes #510

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: MaxRink <maximilian.rink@telekom.de>
@MaxRink
MaxRink requested a review from a team as a code owner November 17, 2026 21:41
Copilot AI balanced review requested due to automatic review settings November 17, 2026 21:41

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@github-actions

Copy link
Copy Markdown
Contributor

Output Delta

No output differences were detected for this PR.
No output-delta input files changed.
There is no diff to inspect for this run.

  • Trusted baseline job: skipped
  • Candidate PR job: skipped
  • Differences detected: false
  • RBAC differences detected: false
  • CRD status differences detected: false
  • Candidate log errors detected: false
  • Latest tag diff generated: false
  • Workflow conclusion: skipped
  • Workflow run: not_applicable

The compare job downloads artifacts only; it does not checkout or execute pull-request code.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 17, 2026
@github-actions

Copy link
Copy Markdown
Contributor

📊 Output Delta Report

No output differences were detected for this PR.
No output-delta input files changed, so the Output Delta comparison workflow was not run.

No full diff content was generated for this run.

@github-actions

github-actions Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Security scan report

Commit: 2fc18f589d033c50a0643ef4e721799eb515bc79

Security findings are advisory, not merge blockers. Build, test and licensing checks remain blocking.

A successful job is not proof of a clean scan; findings and scanner errors are called out below.

Check Result Details
Go Security Checker success Logs
Trivy Filesystem Scan success Logs
Helm Chart Security Scan success Logs
Go Vulnerability Check success Logs
Trivy Image Scan success Logs
Dependency Review success Logs
Lint success Logs
Helm Lint success Logs
Dependency License Audit success Logs
Verify Release Image Signature skipped Logs
Build success Logs
Test success Logs
Verify Generated Files success Logs
Security Scan success Logs

See the linked logs for complete findings and any scanner setup failures.

@MaxRink
MaxRink merged commit 2ee8308 into main Nov 17, 2026
50 checks passed
@MaxRink
MaxRink deleted the docs/client-features-not-enabled branch November 17, 2026 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Do not enable CBOR (ClientsPreferCBOR) in components talking to authz/authn webhooks; do not depend on WatchList

2 participants