Skip to content

Document PrivateLink endpoint - #8199

Open
vishaangelova wants to merge 2 commits into
mainfrom
7167-privatelink
Open

Document PrivateLink endpoint#8199
vishaangelova wants to merge 2 commits into
mainfrom
7167-privatelink

Conversation

@vishaangelova

Copy link
Copy Markdown
Member

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

  • The performance tuning preset can't be changed on the private output; it uses Balanced. Tracked in elastic/kibana#287322. There's no workaround.
  • You can't create a second Elasticsearch output at the private URL. This was possible through the API by accident and is now blocked by elastic/kibana#287316; per @criamico it should not be presented as a workaround.
  • Elastic Managed integrations don't use the private endpoints.

Verification

All UI labels, entry names, editable fields, and the removal behavior are verified against elastic/kibana at main:

  • Names and provisioning: server/services/preconfiguration/fleet_server_host.ts, preconfiguration/outputs.ts
  • Badge label, derived from the URL: settings/components/fleet_server_hosts_table/index.tsx, outputs_table/index.tsx
  • Editable fields: PRIVATELINK_ALLOW_EDIT in preconfiguration/outputs.ts, use_fleet_server_host_form.tsx
  • Per-policy field labels: agent_policy/components/agent_policy_advanced_fields/index.tsx
  • Fallback on removal, including agent policies reverting to the default: cleanPreconfiguredFleetServerHosts, cleanPreconfiguredOutputs, removeFleetServerHostFromAll

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. Tool(s) and model(s) used: Cursor with Claude Opus 5.

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check 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.

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

✅ 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 github-actions Bot 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.

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 in fleet-agent-serverless-restrictions.md lack 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.md mixes 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 an ech-scoped applies-item block; 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

Comment thread deploy-manage/security/_snippets/private-connection-fleet.md Outdated
Comment thread reference/fleet/fleet-agent-serverless-restrictions.md
Co-authored-by: Cursor <cursoragent@cursor.com>

@criamico criamico left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shainaraskas shainaraskas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"aren't left pointing at" is a little colloquial

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Internal]: Document PrivateLink endpoint support for Fleet Server and ES output in serverless

3 participants