Skip to content

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

Merged
TaylorMutch merged 6 commits into
mainfrom
feat/5671-helm-service-routing-opt-in/TaylorMutch
Nov 19, 2026
Merged

TaylorMutch merged 6 commits into
mainfrom
feat/5671-helm-service-routing-opt-in/TaylorMutch

Conversation

@TaylorMutch

@TaylorMutch TaylorMutch commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

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 main at 90e34ad10. This changes Helm behavior independently of gateway application authentication.

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 onto main 90e34ad10 after feat(services): publish authoritative application origins #4956 merged. Each PR's patch is unchanged; stack ancestry and absence of Go/frozen Python SDK changes verified.
  • Helm follow-up: 499 gateway-chart tests and seven workspace-chart tests passed, including rendered TOML/runtime validation, chart consistency, ownership, and supervisor scaling checks.
  • Generated Helm documentation and Markdown/MDX lint passed.

No live-cluster E2E was rerun for this rebase. 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 2 times, most recently 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
@TaylorMutch
TaylorMutch force-pushed the feat/5671-helm-service-routing-opt-in/TaylorMutch branch from 89d6566 to 8be9e6c Compare November 19, 2026 18:01
@TaylorMutch
TaylorMutch force-pushed the feat/4953-authoritative-app-urls/TaylorMutch branch from f8d1af1 to 70d7bdc Compare November 19, 2026 18:01
Base automatically changed from feat/4953-authoritative-app-urls/TaylorMutch to main November 19, 2026 18:41
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 8be9e6c to 443fc7d Compare November 19, 2026 18:51
@TaylorMutch
TaylorMutch marked this pull request as ready for review November 19, 2026 18:52
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
@github-actions

Copy link
Copy Markdown

Compatibility review (advisory)

New or updated breaking changes; see the full report for all findings.

1. helm — No explicit risk acceptance found

The Experimental Helm chart changes gatewayConfig."openshell.gateway".enable_gateway_service_routing from an implicit true default to false, including saved values that omit the setting.

  • Impact: Existing Helm deployments relying on the default lose gateway service URL publication and receive HTTP 404 for gateway-mediated sandbox HTTP requests and WebSocket upgrades.
  • Action: Before upgrading a Helm installation that relies on gateway service URLs, explicitly set gatewayConfig."openshell.gateway".enable_gateway_service_routing: true.
  • PR: feat(helm)!: require opt-in for gateway service routing #5672
Review details
  • Execution: complete
  • Candidate: PR #5672 (b7d1ffb7814170b67c08f18dc4a4a0d66062eec3)
  • Baseline: 90e34ad10e42c8ef76e33f913ec485dc9196f5a7 (90e34ad10e42c8ef76e33f913ec485dc9196f5a7)
  • Reviewed: rust-sdk, python-sdk, typescript-sdk, api-behavior, cli, configuration, policy, helm, state

Advisory review; publication gates are unchanged.

Branch check run

pimlock
pimlock previously approved these changes Nov 19, 2026
Comment thread deploy/helm/openshell/values.yaml Resolved
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
@TaylorMutch
TaylorMutch added this pull request to the merge queue Nov 19, 2026
Merged via the queue into main with commit 7c8e018 Nov 19, 2026
93 checks passed
@TaylorMutch
TaylorMutch deleted the feat/5671-helm-service-routing-opt-in/TaylorMutch branch November 19, 2026 22:10
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.

feat(helm): disable gateway service routing by default on Kubernetes

2 participants