Expand description
Shared sub-objects reused across multiple CRDs.
Per ADR-0003 §2.2 (principle 10) and §4.11, every credential, policy, and
identity surface is modeled as a sub-object so future fields slot in without
API breakage. Leaf Kubernetes types (LabelSelector, ResourceRequirements,
PodSecurityContext) are reused from k8s-openapi rather than re-invented.
Structs§
- Cache
Defaults - Cache defaults inherited by
Backup/Restoremovers unless overridden. ADR §3.1. - Catalog
Bounds - Bounds on materialization of
origin: discoveredBackupCRs. ADR §3.1catalog. - Catalog
Retain - Bounds on the number of discovered
BackupCRs kept materialized. ADR §3.1catalog.retain. - Config
MapKey Ref - Reference to a key within a
ConfigMap(e.g. a CA bundle). ADR §3.1tls.caBundleRef. - Config
Ref - Reference to a
BackupConfigCR (used byBackup.spec.configRefandBackupSchedule.spec.configRef). May cross namespaces, subject to RBAC. ADR §3.4/§3.5. - Create
Behavior - Behavior when the repository does not yet exist. ADR §3.1
create. - Cron
Spec - A single cron entry with optional deterministic jitter. Shared by
Maintenance’s quick/full schedules. ADR §3.7.jitteris a Go-style duration string (e.g.30m). - Encryption
- Repository encryption settings. A sub-object so future rotation fields
(
rotation,previousPasswords) slot in without breakage (ADR §4.11). - Failure
Policy - Per-run failure controls passed through to the mover
Job. ADR §3.4/§4.10 (G6). - Identity
- Identity overrides — what kopia records as
username@hostname:path. ADR §3.3/§4.2. - Mover
Spec - Per-recipe mover overrides (resources, cache, security context). ADR §3.3.
- Object
Ref - Generic name/namespace reference to another namespaced object — e.g. a
BackupCR (Restore.spec.source.backupRef) or a PVC (Restore.spec.target.pvcRef). ADR §3.6. - PodSelector
- Selects workload pods by label. Reuses k8s-openapi
LabelSelector. ADR §3.3 hooks. - Repository
Ref - Discriminated reference from a consumer CR (
BackupConfig,Backup,Restore,Maintenance) to aRepositoryorClusterRepository. ADR §3.2. - Resolved
Identity - Fully-resolved identity pinned into status; never re-rendered after admission. ADR §4.2.
- Retention
- GFS retention policy. The single successful-retention driver (ADR §4.4).
- Secret
KeyRef - Reference to a key within a
Secretin the same namespace as the referrer, unlessnamespaceis given (required for cluster-scoped CRs — ADR §3.2). - Secret
Ref - Reference to an entire
Secret(the operator reads well-known keys from it, e.g.AWS_ACCESS_KEY_ID). See ADR §3.1 backendauth.secretRef. - TlsConfig
- TLS settings for object-store backends. ADR §3.1.
Enums§
- Deletion
Policy - Lifecycle of the underlying kopia snapshot when its
BackupCR is deleted. Shared byBackupConfig.spec.defaultDeletionPolicyandBackup.spec.deletionPolicy. ADR-0003 §4.5 / ADR-0001 §4.5. - Repository
Kind - Which kind of repository a consumer CR references. ADR §3.2/§3.3.
Traits§
- Phase
Label - A lifecycle-phase enum that can be rendered as a metric label.