Document PrivateLink endpoint - #8199
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. |
✅ 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. |
11ee125 to
d24d407
Compare
d24d407 to
064966b
Compare
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: no new issues beyond the pre-fetched Vale findings (Latinism, British spelling, mapped_pages warnings) already surfaced on unrelated pre-existing lines; new prose reads clearly and matches surrounding structure.
- Jargon: none found in the added content; terms like Fleet Server, PrivateLink, and agent policy are already established on these pages.
- Frontmatter and applies_to: two consistency gaps found — the shared snippet's new
{{ech}}-only wording isn't scoped for the Azure page (which also covers serverless), and the new PrivateLink mentions infleet-agent-serverless-restrictions.mdlack the{applies_to}`serverless: ga`tag used elsewhere in this PR — see inline comments. - Content type fit: the new "AWS PrivateLink and Fleet" section in
private-connectivity-aws.mdmixes reference-style description with a short how-to (numbered steps for selecting private hosts/outputs), which fits the page's existing overview/reference pattern used for other Fleet-related sections; no structural objection. - Contradictions: No contradictions found against existing published docs or other local files.
- Parent issue satisfaction: Satisfied — the PR documents the new serverless PrivateLink Fleet Server host and Elasticsearch output, their UI labels, limitations, and fallback behavior, addressing #7167.
Notes
- The shared snippet (
_snippets/private-connection-fleet.md) is reused by three pages (AWS, Azure, GCP). The rewording narrows its scope to{{ech}}deployments, but only the AWS page's include was updated to wrap it in anech-scopedapplies-itemblock; the Azure page (which also supports serverless) still includes it unconditionally.
Generated by Docs review agent for #8199 · copilot · sonnet50 · 102.4 AIC · ⌖ 15.7 AIC · ⊞ 18.1K
Co-authored-by: Cursor <cursoragent@cursor.com>
shainaraskas
left a comment
There was a problem hiding this comment.
one to take or leave, one to fix - want to make sure we don't leave serverless customers using other cloud service providers stranded. 🏁 otherwise
| On {{ecloud}}, this field is populated automatically. If you are using Azure Private Link, GCP Private Service Connect, or AWS PrivateLink and enrolling the {{agent}} with a private link URL, ensure that this setting is configured. Otherwise, {{agent}} will reset to use a default address instead of the private link URL. | ||
| On {{ecloud}}, this field is populated automatically. On {{ech}} deployments, if you are using Azure Private Link, GCP Private Service Connect, or AWS PrivateLink and enrolling the {{agent}} with a private link URL, ensure that this setting is configured. Otherwise, {{agent}} will reset to use a default address instead of the private link URL. | ||
|
|
||
| {applies_to}`serverless: ga` If an AWS PrivateLink connection is set up for your project, {{fleet}} adds a **Private Fleet Server** host that points to your private endpoint. Select it to send agent traffic over the private connection. Refer to [AWS PrivateLink and {{fleet}}](/deploy-manage/security/private-connectivity-aws.md#aws-privatelink-and-fleet). |
There was a problem hiding this comment.
we've lost the path for serverless customers who use azure privatelink (and later, when it becomes available in oct, gcp psc). maybe we can add a "for other private connectivity services, blah blah"
|
|
||
| A selection made in an agent policy takes precedence over the defaults on the **Settings** page. | ||
|
|
||
| If the private connection is later removed from your project, {{fleet}} makes the public {{fleet-server}} host and output the default again, and deletes the private entries. Agent policies that used a private entry switch back to the default, so {{agents}} aren't left pointing at an unreachable URL. |
There was a problem hiding this comment.
"aren't left pointing at" is a little colloquial
Summary
This PR documents the AWS PrivateLink Fleet Server host and Elasticsearch output that Fleet provisions automatically in Serverless projects when a project has AWS PrivateLink enabled (ref: elastic/kibana#275601).
Closes #7167
Documented limitations
Verification
All UI labels, entry names, editable fields, and the removal behavior are verified against
elastic/kibanaatmain:server/services/preconfiguration/fleet_server_host.ts,preconfiguration/outputs.tssettings/components/fleet_server_hosts_table/index.tsx,outputs_table/index.tsxPRIVATELINK_ALLOW_EDITinpreconfiguration/outputs.ts,use_fleet_server_host_form.tsxagent_policy/components/agent_policy_advanced_fields/index.tsxcleanPreconfiguredFleetServerHosts,cleanPreconfiguredOutputs,removeFleetServerHostFromAllGenerative AI disclosure