Skip to content

Flag a missing gateway StorageClass before Helm waits #5773

Open

Description

@shiju-nv

User Story

As a Kubernetes operator, I want Helm to tell me when I need to set the gateway StorageClass, so I can fix it before waiting for the gateway to start.

Problem Statement

OpenShell omits storageClassName from the gateway StatefulSet claim when server.dataStorageClass is empty. If the cluster has no default class, Helm gives operators no warning about the missing setting.

Impact / Why This Matters

The gateway data PVC can stay Pending until helm install --wait times out. Operators then have to inspect the claim to find the cause. The gateway claim template is immutable after install.

Proposed Design

Offer a preflight via storageClass.preflight.enabled=true for fresh gateway StatefulSet installs. If the gateway relies on the default StorageClass and the cluster has none, fail Helm rendering and name server.dataStorageClass. Document the permission needed to list StorageClasses.

Include server.workspaceStorageClass in the install checklist for clusters without a default. Sandbox workspace claims first appear when a sandbox starts.

Acceptance Criteria

  • A fresh StatefulSet install with the check enabled and no explicit or default class stops during rendering and names server.dataStorageClass.
  • An explicit gateway class or a cluster default lets Helm render.
  • The check skips existing-release upgrades, gateway Deployments, and offline renders.

Alternatives Considered

A cluster-wide default affects other workloads. Picking a class automatically could give OpenShell storage with the wrong lifecycle or access mode. The existing overrides let operators choose the class that fits their cluster.

Checklist

  • I've reviewed existing issues and the published docs
  • This is a design proposal, not a "please build this" request

Activity

  1. changed the title [-]Flag missing StorageClass settings before PVCs get stuck[/-] [+]Flag a missing gateway StorageClass before Helm waits[/+] on Nov 19, 2026
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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions