Skip to content

feat(helm)!: require opt-in for gateway service routing - #5672

Draft
TaylorMutch wants to merge 3 commits into
feat/4953-authoritative-app-urls/TaylorMutchfrom
feat/5671-helm-service-routing-opt-in/TaylorMutch
Draft

TaylorMutch wants to merge 3 commits into
feat/4953-authoritative-app-urls/TaylorMutchfrom
feat/5671-helm-service-routing-opt-in/TaylorMutch

Conversation

@TaylorMutch

@TaylorMutch TaylorMutch commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Default Kubernetes Helm deployments to disabling gateway-mediated sandbox service routing, avoiding an unintended alternate application access path when operators use dedicated application ingress. The core runtime keeps its enabled default, preserving Docker, Podman, and VM behavior outside this chart.

Upgrade action: Helm installations relying on gateway service URLs must explicitly retain forwarding:

gatewayConfig:
  openshell.gateway:
    enable_gateway_service_routing: true

Based on #4956. This draft changes Helm behavior separately from the URL and gateway application-auth PRs.

Related Issue

Closes #5671.

Changes

  • Render enable_gateway_service_routing = false by default, including saved values that omit the setting or set it to null; preserve explicit boolean choices.
  • Keep control-plane API access unchanged. Application-listener ingress and gateway application authentication remain independently configured.
  • Document that direct service ingress requires [openshell.supervisor.app_listener].enabled = true plus an ingress solution that routes discovered hostnames to the owning supervisor app-listener endpoint. Use base_url as the only application origin, with its domain derived automatically. Include the Helm/TLS configuration example, explicit gateway opt-in, and upgrade setting.
  • Cover the chart default, explicit opt-in, and omitted saved-value cases in chart tests.

Testing

  • Rebased all five branches onto main df6a799eb, preserving the SPIFFE provider-token limiter and application-auth peer metadata. Branch ancestry, patch scope, and frozen Python/Go SDK checks passed.
  • Standalone URL PR: 2,801 server tests (50 PostgreSQL-dependent tests skipped), 650 core tests, 336 Kubernetes-driver tests, 300 supervisor tests, and 409 CLI library tests passed.
  • Combined auth/discovery-reader/proxy stack: 2,831 server tests (51 PostgreSQL-dependent tests skipped) and all nine proxy tests passed. Strict all-target Clippy passed for server, core, Kubernetes driver, supervisor, CLI, and proxy.
  • Full Helm suites passed for the URL/Helm follow-up, including rendered TOML, resource coherence, ownership, and scaling. The combined stack passed all 500 gateway-chart unit tests. Generated Helm docs, Markdown/MDX lint, Rust formatting, and whitespace checks passed.
  • Fresh live k3d shared/push/graceful E2E passed on the rebased URL/Helm stage with matching locally built images: Pod-IP ingress without app Services, HTTP/WebSockets, Host/SNI, NetworkPolicy, withdrawal/re-exposure, takeover preserving workload identity/process/memory, and listener-disabled gateway fallback using enable_gateway_service_routing: true. The isolated release and namespace were removed.

Dedicated, poll, abrupt-loss, and external-ingress scenarios were not rerun for these review fixes. Current-head GitHub CI is pending.

Release Notes

Kubernetes Helm deployments now require an explicit opt-in for gateway-mediated sandbox service URLs and HTTP/WebSocket forwarding. Set gatewayConfig."openshell.gateway".enable_gateway_service_routing: true before upgrading if you rely on that path. The core and non-Kubernetes defaults are unchanged.

@copy-pr-bot

copy-pr-bot Bot commented Nov 17, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@github-actions github-actions Bot added the state:accepted A maintainer decided OpenShell should pursue this issue label Nov 17, 2026
@github-actions

Copy link
Copy Markdown

@TaylorMutch
TaylorMutch force-pushed the feat/5671-helm-service-routing-opt-in/TaylorMutch branch from c6e1b4f to f947299 Compare November 18, 2026 05:50
@TaylorMutch
TaylorMutch force-pushed the feat/4953-authoritative-app-urls/TaylorMutch branch 2 times, most recently from 1e069a1 to 5500740 Compare November 18, 2026 20:14
@TaylorMutch
TaylorMutch force-pushed the feat/5671-helm-service-routing-opt-in/TaylorMutch branch from f947299 to 218251a Compare November 18, 2026 20:14
BREAKING CHANGE: Helm installations relying on gateway service URLs must explicitly set gatewayConfig."openshell.gateway".service_routing_enabled to true before upgrading. Core and non-Kubernetes defaults remain unchanged.

Signed-off-by: Taylor Mutch <[email protected]>
@TaylorMutch
TaylorMutch force-pushed the feat/5671-helm-service-routing-opt-in/TaylorMutch branch from 218251a to 89d6566 Compare November 19, 2026 00:08
@TaylorMutch
TaylorMutch force-pushed the feat/4953-authoritative-app-urls/TaylorMutch branch from 5500740 to f8d1af1 Compare November 19, 2026 00:08

This branch has not been deployed

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

Labels

state:accepted A maintainer decided OpenShell should pursue this issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant