Skip to content

[DOCS-13238] Document Kubernetes headless service#34447

Open
maycmlee wants to merge 1 commit intomasterfrom
may.lee/opw-headless-service-docs
Open

[DOCS-13238] Document Kubernetes headless service#34447
maycmlee wants to merge 1 commit intomasterfrom
may.lee/opw-headless-service-docs

Conversation

@maycmlee
Copy link
Contributor

@maycmlee maycmlee commented Feb 6, 2026

What does this PR do? What is the motivation?

Fixes DOCS-13238

This PR adds documentation explaining the two Kubernetes services created by the Helm chart when deploying Observability Pipelines Worker:

  • Headless service: Provides stable DNS names per pod and direct Pod IP resolution without load balancing. For the Worker itself, not for end users.
  • Load balancer service: Provides load balancing for both internal and external cluster communications.

The documentation clarifies that users should use the load balancer service (non-headless) to send logs to the Observability Pipelines Worker.

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

This documentation was added to the following files:

  • Main Kubernetes installation page (both API/Terraform and Pipeline UI sections)
  • Kubernetes shortcodes (generic, Azure AKS, Amazon EKS, Google GKE)

Add documentation explaining the two services created by the Helm chart
when deploying OPW on Kubernetes: headless service and load balancer service.
Clarify that users should use the load balancer service for sending logs.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@maycmlee maycmlee requested a review from a team as a code owner February 6, 2026 19:31
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Feb 6, 2026
@maycmlee maycmlee added the WORK IN PROGRESS No review needed, it's a wip ;) label Feb 6, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

Preview links (active after the build_preview check completes)

Modified Files

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

Labels

Architecture Everything related to the Doc backend WORK IN PROGRESS No review needed, it's a wip ;)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant