ECE load balancers: link to KB article for Proxy Protocol v2 configuration - #7817
ECE load balancers: link to KB article for Proxy Protocol v2 configuration#7817kunisen wants to merge 1 commit into
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
kunisen
added
supportability
🔍 Preview links for changed docs |
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Clean, minor two-line diff. The only substantive addition is one sentence linking to a KB article for ECE proxy-side Proxy Protocol v2 configuration; wording is clear and consistent with surrounding style.
- Jargon: None introduced.
X-Forwarded-For,Proxy Protocol v2, andECEare already established on the page. - Frontmatter and applies_to: Unchanged in this PR; no issues in the touched lines. Pre-fetched Vale flagged
mapped_pages(line 2), but that key is untouched by this diff, so it's a pre-existing note, not something introduced here. - Content type fit: No change to page structure or type (how-to/reference style page remains consistent).
- Parent issue satisfaction: Satisfied — the linked support-tech-lead#1888 issue asks for guidance on the ECE proxy side of Proxy Protocol v2 configuration, and the added KB link directly addresses that gap.
Notes
- Left one inline comment: the PR body says the KB article covers a Container Sets API procedure specific to ECE < 4.2, but the added sentence doesn't convey that version scope, which could mislead readers on newer ECE versions. Worth confirming with the author before merge.
- Did not verify the linked KB URL resolves (network access to
ela.stwas unavailable in this environment); recommend the author confirm the link works before merge.
Warning
Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
ela.st
To allow these domains, add them to the
network.allowedlist in your workflow frontmatter:
network:
allowed:
- defaults
- "ela.st"See Network Configuration for more information.
Generated by Docs review agent for #7817 · sonnet50 · 32.6 AIC · ⌖ 6.49 AIC · ⊞ 15.9K
|
|
||
| * **`X-Forwarded-For` header** (HTTP/L7 mode): Configure the load balancer to strip inbound `X-Forwarded-For` headers and replace them with the client source IP. This prevents clients from spoofing their IP addresses. Elastic Cloud Enterprise uses `X-Forwarded-For` for logging client IP addresses and, if you have implemented IP filtering, for traffic management. | ||
| * **Proxy Protocol v2** (TCP/L4 mode): The load balancer prepends client connection metadata that the ECE proxy reads directly. Enable Proxy Protocol v2 on both the load balancer and the ECE proxy configuration. | ||
| * **Proxy Protocol v2** (TCP/L4 mode): The load balancer prepends client connection metadata that the ECE proxy reads directly. Enable Proxy Protocol v2 on both the load balancer and the ECE proxy configuration. For instructions on configuring the ECE proxy side, refer to [our KB article](https://ela.st/ece-configure-ppv2-via-containersets-api). |
There was a problem hiding this comment.
The PR description notes this KB article "covers the Container Sets API procedure for existing ECE installations (ECE < 4.2)," but the added sentence doesn't convey that version scope to readers. Since this repo documents ECE cumulatively across versions, readers on ECE 4.2+ following this link could land on an outdated procedure without knowing it doesn't apply to their version.
Consider clarifying the scope in the sentence itself, for example:
| * **Proxy Protocol v2** (TCP/L4 mode): The load balancer prepends client connection metadata that the ECE proxy reads directly. Enable Proxy Protocol v2 on both the load balancer and the ECE proxy configuration. For instructions on configuring the ECE proxy side, refer to [our KB article](https://ela.st/ece-configure-ppv2-via-containersets-api). | |
| * **Proxy Protocol v2** (TCP/L4 mode): The load balancer prepends client connection metadata that the ECE proxy reads directly. Enable Proxy Protocol v2 on both the load balancer and the ECE proxy configuration. For instructions on configuring the ECE proxy side on installations running ECE 4.1 and earlier, refer to [our KB article](https://ela.st/ece-configure-ppv2-via-containersets-api). |
If the procedure is actually version-agnostic, disregard this — but please double check against the KB article before merging.
There was a problem hiding this comment.
@eedugon
May I have your opinion on this please?
IMHO, we probably want to differentiate the version using version tooltip but not in the text here, so I think I wouldn't accept this suggestion.
But it's after all a doc perspective topic, and I am happy to follow your direction.
Thanks!
There was a problem hiding this comment.
This is fun :-D I don't know how copilot knows that in ECE 4.2 this is going to be supported in a different way.
Anyway the procedure you are sharing is version agnostic today, so I'd keep your PR the way it is. We will update this part of course on the 4.2 docs that I'm preparing.
The key decision here is:
- Does it make sense to publish this today when in about one month (ECE 4.2) we are going to recommend to upgrade to 4.2 and reinstall proxies instead?
Probably it makes sense and it's not a big deal, but that's my only concern.
@gigerdo : let us know if you are ok with this small PR that links to the KB article for current systems (ECE 4.x). Of course we will update the narrative with the upcoming 4.2.
|
|
||
| * **`X-Forwarded-For` header** (HTTP/L7 mode): Configure the load balancer to strip inbound `X-Forwarded-For` headers and replace them with the client source IP. This prevents clients from spoofing their IP addresses. Elastic Cloud Enterprise uses `X-Forwarded-For` for logging client IP addresses and, if you have implemented IP filtering, for traffic management. | ||
| * **Proxy Protocol v2** (TCP/L4 mode): The load balancer prepends client connection metadata that the ECE proxy reads directly. Enable Proxy Protocol v2 on both the load balancer and the ECE proxy configuration. | ||
| * **Proxy Protocol v2** (TCP/L4 mode): The load balancer prepends client connection metadata that the ECE proxy reads directly. Enable Proxy Protocol v2 on both the load balancer and the ECE proxy configuration. For instructions on configuring the ECE proxy side, refer to [our KB article](https://ela.st/ece-configure-ppv2-via-containersets-api). |
There was a problem hiding this comment.
This is fun :-D I don't know how copilot knows that in ECE 4.2 this is going to be supported in a different way.
Anyway the procedure you are sharing is version agnostic today, so I'd keep your PR the way it is. We will update this part of course on the 4.2 docs that I'm preparing.
The key decision here is:
- Does it make sense to publish this today when in about one month (ECE 4.2) we are going to recommend to upgrade to 4.2 and reinstall proxies instead?
Probably it makes sense and it's not a big deal, but that's my only concern.
@gigerdo : let us know if you are ok with this small PR that links to the KB article for current systems (ECE 4.x). Of course we will update the narrative with the upcoming 4.2.
|
Thanks @eedugon I added Dominik as reviewer too :) |
|
Hi @gigerdo sorry to trouble you again, when you have time, may I ask your help to review please? Thanks! |
2 participants
Summary
Adds a link to the Proxy Protocol v2 bullet in the Client IP preservation section so readers know how to configure the ECE proxy side.
The existing text said "Enable Proxy Protocol v2 on both the load balancer and the ECE proxy configuration" but gave no guidance on the ECE side. This adds a reference to the KB article that covers the Container Sets API procedure for existing ECE installations (ECE < 4.2).
Related: elastic/support-tech-lead#1888
Generative AI disclosure
Tool(s) and model(s) used: Claude (Anthropic) via Cowork