{"id":50886147,"url":"https://github.com/hops-ops/volume-snapshot-stack","last_synced_at":"2026-06-15T17:03:09.929Z","repository":{"id":360107715,"uuid":"1223181983","full_name":"hops-ops/volume-snapshot-stack","owner":"hops-ops","description":"Crossplane configuration package: installs Kubernetes CSI snapshot-controller (cluster-wide orchestrator for VolumeSnapshot resources). Required prerequisite for any stack composing a VolumeSnapshotClass — EKS Auto Mode ships the CRDs but not the controller.","archived":false,"fork":false,"pushed_at":"2026-05-25T02:12:59.000Z","size":39,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-25T04:12:30.904Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"KCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hops-ops.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-28T04:45:43.000Z","updated_at":"2026-05-25T02:11:04.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/hops-ops/volume-snapshot-stack","commit_stats":null,"previous_names":["hops-ops/volume-snapshot-stack"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/hops-ops/volume-snapshot-stack","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hops-ops%2Fvolume-snapshot-stack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hops-ops%2Fvolume-snapshot-stack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hops-ops%2Fvolume-snapshot-stack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hops-ops%2Fvolume-snapshot-stack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hops-ops","download_url":"https://codeload.github.com/hops-ops/volume-snapshot-stack/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hops-ops%2Fvolume-snapshot-stack/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34372130,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-15T17:03:09.037Z","updated_at":"2026-06-15T17:03:09.903Z","avatar_url":"https://github.com/hops-ops.png","language":"KCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# volume-snapshot-stack\n\nInstalls the upstream Kubernetes CSI [`snapshot-controller`](https://kubernetes-csi.github.io/docs/snapshot-controller.html) — the cluster-wide orchestrator that turns user-facing `VolumeSnapshot` resources into driver-facing `VolumeSnapshotContent` records. Driver-agnostic; works alongside any CSI driver whose controller plugin includes the `csi-snapshotter` sidecar (EKS Auto Mode's managed EBS CSI driver does, as do Longhorn, Mayastor, OpenEBS LocalPV, etc.).\n\nComposes a single Helm release via the [piraeus-charts/snapshot-controller](https://artifacthub.io/packages/helm/piraeus-charts/snapshot-controller) chart, which bundles the `snapshot.storage.k8s.io` CRDs and the controller Deployment.\n\n## Why this stack exists\n\nEKS Auto Mode ships the CSI driver (`ebs.csi.eks.amazonaws.com`) and the snapshot CRDs, but **not the cluster-wide snapshot-controller**. Without it, `VolumeSnapshot` resources are accepted by the API server but never get processed — they sit forever with no `.status.readyToUse`.\n\nThis is a foundational cluster concern (like cert-manager). Any stack that composes a `VolumeSnapshotClass` (psql-stack, future longhorn-stack, etc.) depends on the controller being present.\n\n## Components\n\n| Component | Default | Purpose |\n|---|---|---|\n| **snapshot-controller Deployment** | always-on | Watches `VolumeSnapshot` → creates `VolumeSnapshotContent` → populates `.status` |\n| **Snapshot CRDs** | bundled with the Helm chart | `VolumeSnapshot`, `VolumeSnapshotContent`, `VolumeSnapshotClass` |\n| **Snapshot validation webhook** | optional via chart values | Validates VolumeSnapshot/Content schemas at admission |\n| **HA mode** | off (`spec.ha.enabled: false`) | When enabled: `replicaCount: 2` (active + standby, leader-elected) + `topologySpreadConstraints` by zone |\n\n## Prerequisites\n\n- A target Kubernetes cluster — the controller is driver-agnostic, no CSI-driver-specific config needed.\n- One or more CSI drivers with their `csi-snapshotter` sidecar installed (handled by the driver's own install — EKS Auto Mode includes it for `ebs.csi.eks.amazonaws.com`).\n\nThat's it. No IAM, no PodIdentity, no AWS-specific config.\n\n## Multi-chart CRD ownership\n\nThis stack is the **canonical CRD installer** for the cluster. Other charts that bundle the snapshot CRDs (Mayastor, Longhorn, Ceph-CSI, OpenEBS LVM, etc.) MUST be configured to skip their own CRD shipment to avoid Helm ownership conflicts. Common toggles:\n\n| Chart | Toggle |\n|---|---|\n| Mayastor (`openebs/mayastor`) | `crds.csi.volumeSnapshots.enabled: false` |\n| Longhorn (`longhorn/longhorn`) | bundle is opt-out via `csi.snapshotterCustomResourceDefinitions: false` (chart-version-dependent) |\n| OpenEBS LVM (`openebs/lvm-localpv`) | `csiSnapshots.crds.install: false` |\n| Ceph-CSI (`ceph/ceph-csi-rbd`) | `provisioner.snapshotter.enabled` controls sidecar; CRDs are install-once |\n\nConfirm against the specific chart version before adopting.\n\n## Stages\n\n### Stage 1: Default install\n\n```yaml\napiVersion: hops.ops.com.ai/v1alpha1\nkind: VolumeSnapshotStack\nmetadata:\n  name: snapshot\n  namespace: default\nspec:\n  clusterName: my-cluster\n```\n\nSingle replica, leader election on, kube-system namespace, latest pinned chart version.\n\n### Stage 2: HA\n\n```yaml\napiVersion: hops.ops.com.ai/v1alpha1\nkind: VolumeSnapshotStack\nmetadata:\n  name: snapshot\n  namespace: default\nspec:\n  clusterName: production-cluster\n  labels:\n    team: platform\n  ha:\n    enabled: true\n    replicas: 2\n    topologySpreadByZone: true\n```\n\n### Stage 3: Custom values escape hatch\n\n```yaml\napiVersion: hops.ops.com.ai/v1alpha1\nkind: VolumeSnapshotStack\nmetadata:\n  name: snapshot\n  namespace: default\nspec:\n  clusterName: edge\n  controller:\n    values:\n      controller:\n        featureGates: \"CSIVolumeGroupSnapshot=true\"\n      webhook:\n        enabled: true\n        certManager:\n          enabled: true\n```\n\n`controller.values` deep-merges with the stack's chart defaults; `controller.overrideAllValues` replaces them entirely.\n\n## Spec Reference\n\n| Field | Type | Default | Description |\n|---|---|---|---|\n| `clusterName` | string | _required_ | Target cluster name; default for `helmProviderConfigRef.name` and label values |\n| `namespace` | string | `kube-system` | Where to install snapshot-controller |\n| `labels` | object | — | Custom labels merged with stack defaults |\n| `managementPolicies` | string[] | `[\"*\"]` | Crossplane management policies |\n| `helmProviderConfigRef.name` | string | `clusterName` | Helm ProviderConfig name |\n| `helmProviderConfigRef.kind` | enum | `ProviderConfig` | `ProviderConfig` or `ClusterProviderConfig` |\n| **HA mode** | | | |\n| `ha.enabled` | bool | `false` | Enable replicas + zone-spread |\n| `ha.replicas` | int | `2` | Replica count when HA enabled (matches upstream snapshot-controller default for HA) |\n| `ha.topologySpreadByZone` | bool | `true` | Add `topologySpreadConstraint` by `topology.kubernetes.io/zone` |\n| **Controller** | | | |\n| `controller.name` | string | `snapshot-controller` | Helm release name |\n| `controller.chartVersion` | string | `5.0.3` | piraeus-charts chart version (tracks upstream `v8.5.0`) |\n| `controller.values` | object | — | Helm values merged with stack defaults |\n| `controller.overrideAllValues` | object | — | Helm values that replace all defaults |\n\n## Composed Resources\n\n| Resource | Kind | When |\n|---|---|---|\n| `\u003ccontroller.name\u003e` | `helm.m.crossplane.io/Release` | always |\n\nThat's it. Smallest stack in the repo.\n\n## Dependencies\n\n| Kind | Package | Version |\n|---|---|---|\n| Function | `crossplane-contrib/function-auto-ready` | `\u003e=v0.6.2` |\n| Provider | `crossplane-contrib/provider-helm` | `\u003e=v1` |\n\n## Development\n\n```bash\nmake render             # Render all examples\nmake validate           # Validate against Crossplane schemas\nmake test               # KCL render tests (assert composed resource shapes)\nmake build              # Build the package\nmake render:minimal     # Render a single example\n```\n\n## See also\n\n- [SPEC.md](./SPEC.md) — design rationale, alternatives considered, why piraeus\n- Upstream: [kubernetes-csi/external-snapshotter](https://github.com/kubernetes-csi/external-snapshotter)\n- Chart: [piraeus-charts/snapshot-controller](https://artifacthub.io/packages/helm/piraeus-charts/snapshot-controller)\n\n## License\n\nApache-2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhops-ops%2Fvolume-snapshot-stack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhops-ops%2Fvolume-snapshot-stack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhops-ops%2Fvolume-snapshot-stack/lists"}