Skip to main content

Module snapshot

Module snapshot 

Source
Expand description

The Snapshot CRD — a single kopia snapshot as a Kubernetes object. ADR-0001 §3.4, ADR-0003 §4.5.

Origins (canonical value lives in status.origin):

  • scheduled — created by a SnapshotSchedule; spec carries policyRef.
  • manual — created by kubectl create / external automation; spec carries policyRef.
  • discovered— materialized by the catalog scan; spec is empty/absent.
  • adopted — a discovered row re-attached to a live SnapshotPolicy.
  • replicated— a dest-side copy CR minted by a SnapshotReplication run; spec carries repository (the destination pin) and no policyRef.

Structs§

CleanupStatus
One-shot markers for the cleanups a terminal Snapshot performs, mirroring HookExecutionStatus: the stamp IS the idempotence, so a stamped Snapshot’s steady-state reconcile is a no-op forever.
CopiedFrom
Lineage of an origin: replicated row: where the copy came from.
HookExecutionStatus
When each hook list completed.
JobStatus
The mover Job backing a scheduled/manual Snapshot; absent for discovered.
PvcTargetRef
A fully-qualified PersistentVolumeClaim reference.
ResolvedSnapshot
Frozen recipe values pinned at run time.
ResolvedSource
One resolved source backed up by a run — a concrete PVC and its kopia path.
Snapshot
Auto-generated derived type for SnapshotSpec via CustomResource
SnapshotInfo
Identifies the kopia snapshot a Snapshot CR owns.
SnapshotSourceGroup
The shared CSI VolumeGroupSnapshot every member of one expansion stages from.
SnapshotSourceRef
Which source of the referenced SnapshotPolicy this Snapshot covers, and what that source resolved to at expansion time.
SnapshotSpec
A single kopia snapshot represented as a Kubernetes object.
SnapshotStats
Stats populated from kopia’s JSON output.
SnapshotStatus
Observed state of a Snapshot.
SnapshotTiming
Timing of a snapshot run.
StagedSources
The CSI staging objects a backup created so kopia reads a point-in-time copy of the source PVC.

Enums§

Origin
How a Snapshot came to exist. Canonical value mirrored from the kopiur.home-operations.com/origin label. Origin drives the deletion-policy default: discovered backups are forced to Retain because the operator did not create those snapshots.
PrunedBy
Which operator lifecycle removed a Snapshot (the pruned-by annotation).
SnapshotPhase
Lifecycle phase of a Snapshot.
SnapshotSourceTarget
The resolved target of one expanded source.

Functions§

effective_repository_ref
THE repository a policy-child Snapshot runs against, resolved from the mint-time pin + the referenced policy’s repository set. Pure. This is the single decision every launch/deletion/pin/preflight path shares, so multi-repo pin semantics cannot fork between consumers.
repository_ref_for
Derive the repository a Snapshot belongs to, in fixed precedence order: