Expand description
The BackupConfig CRD — the recipe. Idempotent; runs nothing on its own.
ADR-0001 §3.3, ADR-0003 §4.8.
Structs§
- Backup
Config - Auto-generated derived type for BackupConfigSpec via
CustomResource - Backup
Config Spec - What to back up: sources, identity, retention, policy, hooks. ADR §3.3.
- Backup
Config Status - 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.
- Http
Request Hook - A hook that issues an HTTP request for cross-system orchestration. ADR §4.8.
- Ignore
Policy - Path-ignore policy for a
Policy. ADR §3.3. - Namespace
Selector - Restricts a
PvcSelectorto an explicit set of namespaces. ADR §3.3/§5.4. - Policy
- Typed kopia policy fields plus an
extraArgsescape 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.
- Resolved
Config - The recipe as kopia would see it, pinned at admission and never re-rendered (ADR §4.2). ADR §3.3 status.
- Resolved
Config Source - One resolved source — a concrete PVC and the path kopia records for it. ADR §3.3 status.
- Retention
Summary - Summary of the most recent GFS retention prune for a
BackupConfig. ADR §3.3 status/§4.4. - RunJob
Hook - A hook that materializes a full one-shot Job (k8up
PreBackupPodanalog). ADR §4.8. - Source
- A single backup source.
pvcandpvcSelectorare mutually exclusive (webhook-enforced — NOT an enum, because both forms share the siblingsourcePath*keys and YAML lists them as optional siblings). ADR §3.3. - Workload
Exec Hook - Hook failures abort the backup by default;
continueOnFailure: trueis opt-in. ADR §4.8.
Enums§
- Copy
Method - 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.
- Source
Path Strategy - How a selector-matched PVC’s source path is derived. Closed enum. ADR §3.3/§4.2.