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:
    service_routing_enabled: true

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

Related Issue

Closes #5671.

Changes

  • Render service_routing_enabled = 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

  • Full mise run helm:test: chart unit suites, rendered TOML loader validation, object ownership, resource coherence, supervisor scaling, and autoscaling checks.
  • mise run helm:docs:check and mise run markdown:lint. The exact documented app-listener Helm example renders and passes gateway config preflight.
  • Diff inspection confirms no Rust runtime, CLI deployment, or compute-driver changes.
  • Live k3d install and listener-disable/gateway-opt-in upgrade passed in dedicated and shared topologies using the base_url example and matching local images. The shared case also passed graceful owner takeover; the dedicated case passed gateway-outage expiry.
  • Live upgrade from an older released chart with saved legacy values; omitted/null value handling is covered by chart tests.

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".service_routing_enabled: 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

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 <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
@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 from b7042a9 to 1e069a1 Compare November 18, 2026 05:51

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