feat: add Helm chart for installing the operator#17
Open
monolith-james wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the project's first Helm chart, at
deploy/charts/marimo-operator/, alongside the existingdeploy/install.yamland kustomize install paths. It installs the operator (CRD + controller + RBAC) as a configurable, versionable package; it complements the existing methods rather than replacing them.Chart
MarimoNotebookCRD, controllerDeployment, ServiceAccount, manager/leader-election/metrics RBAC, and the metricsService.DEFAULT_INIT_IMAGE/GIT_IMAGE/ALPINE_IMAGE/S3FS_IMAGE), scheduling, security contexts, andextraArgs/extraEnv.ServiceMonitorand metricsNetworkPolicyare optional and off by default (mirrors the commented-out kustomize components). No webhooks today → no cert-manager dependency.CRD handling
crds/directory.make manifestsnow also copies the generated CRD into the chart, and a CI job fails on drift — so the Go API types stay the single source of truth.CI
.github/workflows/helm.yml:helm lint,helm template, and the CRD-drift guard..pre-commit-config.yaml: scopedcheck-yamlto excludedeploy/charts/**/templates/(Helm templates aren't valid standalone YAML); all other files still checked.Verification
helm lintpasses;helm templatematcheskustomize build config/defaultresource-for-resource (only intentional diffs: noNamespaceobject — release namespace is used — and the image defaults to thev0.3.0release tag rather than:main). Toggles verified; full render passeskubectl apply --dry-run.make lintandmake testpass locally.A few open questions
maintainersandiconare placeholders; let me know what you want there.Checklist
helm lint/template+ CRD-drift CI (.github/workflows/helm.yml).make lintandmake testpass locally (operator).uv run pytest/ty check kubectl_marimo(plugin) — N/A, no plugin changes.make manifestsrun and generated files committed — CRD fields unchanged; chart copies the existing generated CRD.README.md(Helm install),CONTRIBUTING.md(CRD sync), chartREADME.md.