Skip to content

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

Open

Description

@TaylorMutch

User Story

I deploy OpenShell on Kubernetes with application traffic routed directly to supervisor app listeners through external ingress. I need the Helm chart to avoid enabling a second service access path through the OpenShell gateway unless I explicitly choose it, while Docker, Podman, and VM deployments retain their current gateway-based service exposure.

Problem Statement

The runtime defaults gateway-based service routing to enabled. Kubernetes Helm deployments inherit that default unless operators disable it. An installation using a dedicated application ingress can therefore retain an unintended alternate gateway path to sandbox services. Gateway-mediated service authentication is separately opt-in, so the alternate path can also lack the authentication applied by application ingress.

Impact / Why This Matters

Kubernetes owners should choose which component exposes sandbox applications. Leaving gateway forwarding enabled unnecessarily broadens exposure and can bypass access controls configured at the chosen ingress. Changing the core default would instead break existing non-Kubernetes distributions that rely on gateway forwarding.

Proposed Design

Default gateway-mediated sandbox service routing to disabled in the Kubernetes Helm chart. Keep the core runtime default enabled and preserve non-Kubernetes behavior. Let Kubernetes owners explicitly opt into gateway forwarding. Keep application-listener enablement and service authentication independent and opt-in.

Document the upgrade impact: installations relying on gateway service URLs must explicitly enable routing before upgrading. With both routing modes disabled, startup logs explain why services have no OpenShell access path. Control-plane API access remains available.

Suggested UX

Explicitly retain gateway-mediated service exposure in Kubernetes:

gatewayConfig:
  openshell.gateway:
    service_routing_enabled: true

Application ingress users keep the chart default of false and separately configure the application listener and their ingress integration. Service authentication is not automatically enabled or disabled by this change.

Acceptance Criteria

  • Default Helm rendering sets [openshell.gateway].service_routing_enabled = false.
  • An explicit canonical true value restores gateway service URLs and forwarding.
  • Saved Helm values that omit the new setting also receive the chart default; explicit existing choices remain respected.
  • The core default remains true; Docker, Podman, and VM defaults and deployment configuration are unchanged.
  • The app listener and gateway service authentication remain independently configured.
  • Chart/runtime documentation explains ingress setup, explicit opt-in, and upgrade behavior.
  • Chart tests and rendered-TOML validation cover the default, explicit overrides, and omitted saved values.

Alternatives Considered

  • Change the core default: rejected for this work because existing non-Kubernetes distributions rely on gateway forwarding.
  • Enable gateway service authentication by default: changes existing authentication behavior and retains an unnecessary alternate data path.
  • Documentation alone: leaves default Kubernetes installations exposing a path owners may not intend to use.
  • Ingress controllers or gateway interceptors: they can implement ingress behavior or request policy, but do not make an independently enabled gateway forwarding path disappear.

Depends on #4956 for the routing flag. Keep this Helm behavior change separate from the RFC 0017 URL and authentication implementation PRs.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    state:acceptedA maintainer decided OpenShell should pursue this issue

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions