Skip to main content

Module backup_config

Module backup_config 

Source
Expand description

The BackupConfig CRD — the recipe. Idempotent; runs nothing on its own. ADR-0001 §3.3, ADR-0003 §4.8.

Structs§

BackupConfig
Auto-generated derived type for BackupConfigSpec via CustomResource
BackupConfigSpec
What to back up: sources, identity, retention, policy, hooks. ADR §3.3.
BackupConfigStatus
Observed state of a BackupConfig. ADR §3.3 status.
Compression
Compression policy for a Policy. ADR §3.3.
Hooks
Pre/post snapshot hook lists. ADR §3.3/§4.8.
HttpRequestHook
A hook that issues an HTTP request for cross-system orchestration. ADR §4.8.
IgnorePolicy
Path-ignore policy for a Policy. ADR §3.3.
NamespaceSelector
Restricts a PvcSelector to an explicit set of namespaces. ADR §3.3/§5.4.
Policy
Typed kopia policy fields plus an extraArgs escape hatch. ADR §3.3 (G12).
PvcSelector
Selects PVCs across namespaces by label. ADR §3.3/§5.4.
PvcSource
A single backup source addressed by PVC name. ADR §3.3.
ResolvedConfig
The recipe as kopia would see it, pinned at admission and never re-rendered (ADR §4.2). ADR §3.3 status.
ResolvedConfigSource
One resolved source — a concrete PVC and the path kopia records for it. ADR §3.3 status.
RetentionSummary
Summary of the most recent GFS retention prune for a BackupConfig. ADR §3.3 status/§4.4.
RunJobHook
A hook that materializes a full one-shot Job (k8up PreBackupPod analog). ADR §4.8.
Source
A single backup source. pvc and pvcSelector are mutually exclusive (webhook-enforced — NOT an enum, because both forms share the sibling sourcePath* keys and YAML lists them as optional siblings). ADR §3.3.
WorkloadExecHook
Hook failures abort the backup by default; continueOnFailure: true is opt-in. ADR §4.8.

Enums§

CopyMethod
Volume snapshot copy method. Closed enum. ADR §3.3.
GroupBy
Multi-PVC grouping strategy. Closed enum. ADR §4.9.
Hook
One of three hook forms. ADR §4.8.
SourcePathStrategy
How a selector-matched PVC’s source path is derived. Closed enum. ADR §3.3/§4.2.