Skip to content

Support OAP's separated receiver and query ports - #207

Merged
wu-sheng merged 1 commit into
masterfrom
feat/oap-split-ports
Nov 16, 2026
Merged

wu-sheng merged 1 commit into
masterfrom
feat/oap-split-ports

Conversation

@wu-sheng

Copy link
Copy Markdown
Member

OAP can move agent traffic and query traffic off the core ports: receiver-sharing-server moves the gRPC and HTTP receivers (SW_RECEIVER_GRPC_PORT, SW_RECEIVER_SHARING_REST_PORT), and the new query-server module in apache/skywalking#14238 moves GraphQL, the AI agent conversation API and /status/config/ttl (SW_QUERY_SERVER_REST_PORT, OAP 11.2.0+). This lets the chart use them.

  • values.yaml: three commented-out keys under oap.ports, receiver-grpc: 11811, receiver-rest: 12811 and query: 12810. Like every key there, a key that is set becomes a container port and a port on the one OAP Service.
  • oap-deployment.yaml: each key that is set also sets its OAP variable.
  • Horizon: HORIZON_OAP_QUERY_URL and the ConfigMap's queryUrl use oap.ports.query when set, else oap.ports.rest.
  • Satellite: SATELLITE_GRPC_CLIENT_KUBERNETES_EXTRA_PORT uses receiver-grpc when set, else grpc.
  • NOTES.txt names the query port when the UI is disabled.
  • The probes keep checking 12800: the core REST server keeps listening there.
  • Docs: a "Separate the receiver and query ports" section in docs/expose/oap-endpoints.md, rows in the values reference and the Horizon pages, and a 5.1.0 changelog entry.

With none of the keys set, helm template renders the same manifests as master, byte for byte; only NOTES.txt with the UI disabled now prints the GraphQL port it computes (12800) instead of "default 12800". With all three set, the render adds the three container ports, the three Service ports and the three variables, and changes only the Satellite port, HORIZON_OAP_QUERY_URL, and the init Job's name, because these values are part of its name hash. With ui.config set, the ConfigMap's queryUrl also renders 12810. helm lint passes. The chart's e2e still pins OAP 11.0.0, which has no query-server, so it does not exercise query yet; OAP's own e2e (simple/query-port) covers the split ports.

🤖 Generated with Claude Code

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Copilot review overview

4 open issues
What changed in this PR

Adds Helm chart support and documentation for separating SkyWalking OAP receiver and query traffic onto dedicated ports so they can be exposed/TLS’d independently.

Changes:

  • Introduces optional oap.ports.receiver-grpc, oap.ports.receiver-rest, and oap.ports.query values plus corresponding OAP env vars.
  • Updates Horizon and Satellite chart wiring to use the separated ports when configured.
  • Expands docs (endpoints, values reference, UI docs) and changelog to describe the new behavior.
File Description
docs/​ui/​horizon-ui.md Documents Horizon’s OAP URLs/ports, updated for optional query port.
docs/​ui/​configure.md Updates HORIZON_OAP_QUERY_URL docs to reflect query/rest selection.
docs/​reference/​skywalking-chart-values.md Adds new values rows and updates oap.ports.rest semantics.
docs/​expose/​oap-endpoints.md Documents the separated receiver/query ports and their implications.
docs/​changes/​changes.md Adds a 5.1.0 changelog entry for the new ports feature.
chart/​skywalking/​values.yaml Adds commented-out example values for the separated ports.
chart/​skywalking/​templates/​ui-deployment.yaml Makes Horizon query URL prefer oap.ports.query when set.
chart/​skywalking/​templates/​ui-configmap.yaml Makes UI config defaults prefer oap.ports.query when set.
chart/​skywalking/​templates/​satellite-deployment.yaml Makes Satellite prefer receiver-grpc when set.
chart/​skywalking/​templates/​oap-deployment.yaml Sets OAP env vars for the new ports when configured.
chart/​skywalking/​templates/​NOTES.txt Notes the computed GraphQL port when UI is disabled.

Review effort: Lite

Comment thread docs/expose/oap-endpoints.md Resolved
Comment thread docs/expose/oap-endpoints.md Resolved
Comment thread docs/ui/horizon-ui.md Resolved
@wu-sheng wu-sheng added this to the 5.1.0 milestone Nov 16, 2026
@wu-sheng wu-sheng added the enhancement New feature or request label Nov 16, 2026
Three opt-in keys under oap.ports, receiver-grpc, receiver-rest and query,
publish OAP's separated ports and set SW_RECEIVER_GRPC_PORT,
SW_RECEIVER_SHARING_REST_PORT and SW_QUERY_SERVER_REST_PORT. Horizon's
queryUrl follows query and Satellite forwards to receiver-grpc. With none of
them set, the rendered chart is unchanged.
@wu-sheng
wu-sheng force-pushed the feat/oap-split-ports branch from 14e52d8 to 96b7ac9 Compare November 16, 2026 06:53
@wu-sheng
wu-sheng merged commit 024767f into master Nov 16, 2026
6 checks passed
@wu-sheng
wu-sheng deleted the feat/oap-split-ports branch November 16, 2026 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants