[jarvis9443]

From api7/aisix#1374 the gateway accepts a PROXY protocol v1/v2 header from TCP peers listed in proxy.real_ip.trusted_proxies. The header's source address then becomes the client address, and it is also the address checked when deciding whether to trust X-Forwarded-For. Connections without a header behave as before, and a header from an untrusted peer closes the connection. No new config key is added.

This PR only updates the config.proxy.real_ip.trusted_proxies comment in charts/aisix/values.yaml, worded to match the gateway's own config.example.yaml, and regenerates the README parameters table with helm-docs. There is no chart version bump.

Held until the gateway release that ships api7/aisix#1374, then merged together with that release's chart bump.

Fixes api7/AISIX-Cloud#1915

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Clarified that trusted peers can send PROXY protocol v1/v2 headers, how their source address is used for client-IP trust checks, and that headers from untrusted peers close the connection. Detection is automatic on proxy listeners.

[coderabbitai]

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: Organization UI
• Review profile: CHILL
• Plan: Essentials
• Run ID: 378eb94a-560b-4ff9-8911-17551c4c682f

Commits

Reviewing files that changed from the base of the PR and between 8919622 and 1f64b68.

Files selected for processing: 2

• charts/aisix/README.md
• charts/aisix/values.yaml

Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.

Walkthrough

The AISIX chart README and values.yaml now document PROXY protocol v1/v2 handling for trusted proxies. The comments describe source address use in client-IP trust checks, automatic detection on proxy listeners, and connection closure when an untrusted peer sends a header.

Changes: Trusted proxy documentation

Layer / File(s)	Summary
Trusted proxy parameter documentation charts/aisix/values.yaml, charts/aisix/README.md	The parameter descriptions document PROXY protocol v1/v2 headers, use of the header source address in client-IP trust checks, automatic detection on proxy listeners, and connection closure for untrusted peers.

Priority: Normal

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

Change: Other

Possibly related PRs

• api7/api7-helm-chart#408: This PR releases AISIX 1.7.0 and describes documentation held for the gateway release containing PROXY protocol support.

Suggested reviewers: nic-6443

Merge Risk: Minimal · up to 1f64b

This documentation-only change has no identified merge-blocking risk.

Pre-merge checks: 6

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the documentation change for PROXY protocol support on trusted_proxies.
Linked Issues check		Directly linked issue #1915 is closed and supplies historical context only. It therefore imposes no active coding or automated-test requirement. The reviewed changes document PROXY protocol behavior i…
Out of Scope Changes check		The changes are limited to the config.proxy.real_ip.trusted_proxies documentation and the generated README parameters table. These changes directly document the behavior described in #1915 and do no…
E2e Test Quality Review		PASS — This PR changes only documentation in charts/aisix/values.yaml and the generated charts/aisix/README.md. It adds no executable code, configuration behavior, concurrency path, error handling…
Security Check		PASS — the pull request changes only comments in charts/aisix/values.yaml and the generated parameter text in charts/aisix/README.md. It adds no code, endpoints, persistence, logging, authorizatio…

Full details: Linked Issues check

Explanation

Directly linked issue #1915 is closed and supplies historical context only. It therefore imposes no active coding or automated-test requirement. The reviewed changes document PROXY protocol behavior in charts/aisix/values.yaml and charts/aisix/README.md, which is consistent with the PR intent.

Full details: Out of Scope Changes check

Explanation

The changes are limited to the config.proxy.real_ip.trusted_proxies documentation and the generated README parameters table. These changes directly document the behavior described in #1915 and do not add unrelated code, configuration, or chart changes.

Full details: E2e Test Quality Review

Explanation

PASS — This PR changes only documentation in charts/aisix/values.yaml and the generated charts/aisix/README.md. It adds no executable code, configuration behavior, concurrency path, error handling, or test flow. The README entry matches the values comment and documents the stated PROXY protocol behavior. E2E test criteria are not applicable to this documentation-only change.

Full details: Security Check

Explanation

PASS — the pull request changes only comments in charts/aisix/values.yaml and the generated parameter text in charts/aisix/README.md. It adds no code, endpoints, persistence, logging, authorization logic, TLS settings, or secret resolution. Categories 1–7: no issues found.

Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

_{Comment @coderabbitai help to get the list of available commands.}

[jarvis9443]

Folded into the 1.8.0 release PR #418, which carries this commit.