Skip to content

klustrefs/charts

Repository files navigation

KlustreFS Helm Charts

Artifact Hub CI GitHub release (latest SemVer) OCI Registry Docs

Helm charts for the KlustreFS platform. All artifacts are published as OCI packages under oci://ghcr.io/klustrefs/charts and surfaced on the static landing page at klustrefs.io/charts (source in public/).

Charts

Chart Path Chart Version App Version OCI Reference
klustre-csi-plugin klustre-csi-plugin 0.1.1 0.1.1 oci://ghcr.io/klustrefs/charts/klustre-csi-plugin

Each chart directory contains its own README and default values. Run helm show all oci://ghcr.io/klustrefs/charts/<chart> for published metadata.

Quickstart

Prerequisites: Helm 3.8+ (for OCI support) and a GitHub token with the read:packages scope.

  1. Log in to GHCR

    helm registry login ghcr.io -u <github-username>
  2. Discover charts & versions

    • Browse https://klustrefs.io/charts/ for the current catalog.

    • Or pull metadata for a specific chart:

      REGISTRY=oci://ghcr.io/klustrefs/charts
      helm show chart "$REGISTRY/<chart-name>" --version <version>
      helm show values "$REGISTRY/<chart-name>" --version <version>
  3. Install any chart

    helm upgrade --install <release-name> \
      oci://ghcr.io/klustrefs/charts/<chart-name> \
      --version <version> \
      --namespace <namespace> \
      --create-namespace

    Example (Klustre CSI plugin):

    helm upgrade --install klustre-csi \
      oci://ghcr.io/klustrefs/charts/klustre-csi-plugin \
      --version 0.1.0 \
      --namespace klustre-system \
      --create-namespace
  4. Inspect packaged artifacts (optional)

    helm pull "$REGISTRY/<chart-name>" --version <version>
    tar -tf <chart-name>-<version>.tgz

Contributing

See CONTRIBUTING.md for build/lint instructions, helm-unittest guidance, schema validation notes (via helm-schema), golden render generation, container image workflows, command-line argument reference, and contribution guidelines. Run make verify (docs + lint + tests + validate + schema + golden) locally before opening a PR.

License

  • Charts and supporting infrastructure: Apache-2.0.
  • Static site assets under public/: CC-BY-4.0.