Restore v1alpha1 — kopiur.home-operations.com

spec object required

A restore operation. `target` is **required** (ADR-0005 §9): explicit `pvc`/`pvcRef`, or `populator: {}` for passive populator mode (consumed by a PVC's `spec.dataSourceRef`). The empty-`target` form is removed. ADR §3.6/§4.7. Desired state of a [`Restore`]: where to read from, where to write to, and how to behave when the snapshot is missing. ADR §3.6/§4.6.

credentialProjection object

Opt-in credential-Secret projection for this restore's mover (default off). When `enabled: true`, the operator copies the referenced repository's credential Secret(s) into the restore mover's namespace (a no-op when they already live there) — so restoring from a shared `ClusterRepository` into a fresh namespace need not pre-create the Secret there. ADR §4.11.

enabled boolean

When true, the operator copies the repository's credential Secret(s) into the namespace of each mover Job that uses this repository. Off by default.

failurePolicy object

Mover `Job` retry/deadline limits (`backoffLimit`, `activeDeadlineSeconds`), mirroring `Snapshot.spec.failurePolicy`. Absent uses the ADR defaults.

activeDeadlineSeconds integer

Passed through to the mover `Job.spec.activeDeadlineSeconds` — wall-clock cap after which a still-running run is killed.

format: int64

backoffLimit integer

Passed through to the mover `Job.spec.backoffLimit` — how many times a failed run is retried before the Job is marked failed.

format: int32

mover object

Per-run mover overrides for this restore's Job — resource requests/limits, kopia cache sizing, container `securityContext` (UID/GID match), `privilegedMode`, and `inheritSecurityContextFrom`. The same surface `SnapshotPolicy.spec.mover` gives a backup. An elevated context is namespace-gated exactly like a backup's (ADR §4.11/§G16); `securityContext` and `inheritSecurityContextFrom` are mutually exclusive.

cache object

Override the repository's [`CacheDefaults`] for this recipe's movers.

capacity string

Size of the PVC backing the mover's kopia cache (e.g. `10Gi`).

contentCacheSizeMb integer

kopia content cache budget in MiB (`--content-cache-size-mb`).

format: int64

metadataCacheSizeMb integer

kopia metadata cache budget in MiB (`--metadata-cache-size-mb`).

format: int64

mode string

How a mover's kopia cache volume is provisioned. ADR §3.1.

enum: Ephemeral, Persistent

storageClassName string

StorageClass for the cache PVC; absent uses the cluster default.

inheritSecurityContextFrom object

Opt-in: copy security context from a live workload pod. ADR §4.11.

container string

Which container within the matched pod; absent uses the first/only container.

podSelector object required

Label selector matching the workload pod(s) to read context/hooks from.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

matchLabels object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

podSecurityContext object

Security context applied to the mover **pod** — notably `fsGroup`, which makes a freshly-provisioned volume group-writable so an unprivileged (`runAsUser != 0`) mover can populate it on **restore** without root. Distinct from the container-level [`MoverSpec::security_context`]; a pod-level `runAsUser: 0` / `runAsNonRoot: false` here is still gated as privileged.

appArmorProfile object

appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

localhostProfile string

localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".

type string required

type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.

fsGroup integer

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.

format: int64

fsGroupChangePolicy string

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.

runAsGroup integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

format: int64

runAsNonRoot boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

runAsUser integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

format: int64

seLinuxChangePolicy string

seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux. Valid values are "MountOption" and "Recursive". "Recursive" means relabeling of all files on all Pod volumes by the container runtime. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node. "MountOption" mounts all eligible Pod volumes with `-o context` mount option. This requires all Pods that share the same volume to use the same SELinux label. It is not possible to share the same volume among privileged and unprivileged Pods. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their CSIDriver instance. Other volumes are always re-labelled recursively. "MountOption" value is allowed only when SELinuxMount feature gate is enabled. If not specified and SELinuxMount feature gate is enabled, "MountOption" is used. If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes and "Recursive" for all other volumes. This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers. All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state. Note that this field cannot be set when spec.os.name is windows.

seLinuxOptions object

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

level string

Level is SELinux level label that applies to the container.

role string

Role is a SELinux role label that applies to the container.

type string

Type is a SELinux type label that applies to the container.

user string

User is a SELinux user label that applies to the container.

seccompProfile object

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

localhostProfile string

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.

type string required

type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

supplementalGroups []integer

A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows.

supplementalGroupsPolicy string

Defines how supplemental groups of the first container processes are calculated. Valid values are "Merge" and "Strict". If not specified, "Merge" is used. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature. Note that this field cannot be set when spec.os.name is windows.

sysctls []object

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.

name string required

Name of a property to set

value string required

Value of a property to set

windowsOptions object

The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

gmsaCredentialSpec string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcess boolean

HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

runAsUserName string

The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

privilegedMode boolean

Opt-in, namespace-gated; preserves UID/GID on restore. ADR §4.11/§G16.

resources object

Resource requests/limits for the mover container.

claims []object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.

name string required

Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

request string

Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

limits object

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests object

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

securityContext object

Security context applied to the mover **container** (`runAsUser`/`runAsGroup`, capabilities, seccomp, …). Merged field-wise over `moverDefaults.securityContext` and the hardened base (ADR-0004 §2) — set only the fields you want to change.

allowPrivilegeEscalation boolean

AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.

appArmorProfile object

appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

localhostProfile string

type string required

capabilities object

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

add []string

Added capabilities

drop []string

Removed capabilities

privileged boolean

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.

procMount string

procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

readOnlyRootFilesystem boolean

Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.

runAsGroup integer

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

format: int64

runAsNonRoot boolean

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

runAsUser integer

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

format: int64

seLinuxOptions object

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

level string

Level is SELinux level label that applies to the container.

role string

Role is a SELinux role label that applies to the container.

type string

Type is a SELinux type label that applies to the container.

user string

User is a SELinux user label that applies to the container.

seccompProfile object

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

localhostProfile string

type string required

windowsOptions object

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

gmsaCredentialSpec string

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

gmsaCredentialSpecName string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

hostProcess boolean

runAsUserName string

ttlSecondsAfterFinished integer

Per-recipe override of `moverDefaults.ttlSecondsAfterFinished` — the `Job.spec.ttlSecondsAfterFinished` for this recipe's mover Jobs so finished backup/restore Jobs self-GC. Recipe wins over the repo default; when neither is set a built-in default applies ([`DEFAULT_JOB_TTL_SECONDS`]). ADR-0005 §12.

format: int64

options object

kopia restore behavior (file deletion, permission/atomicity handling). ADR §4.6.

enableFileDeletion boolean

Delete files in the target that are not present in the snapshot (make the target an exact mirror). Off by default — additive restore is the safe default.

ignorePermissionErrors boolean

Default true; surfaces a condition if any errors occurred. ADR §4.6.

writeFilesAtomically boolean

Default true. ADR §4.6.

policy object

Missing-snapshot handling and wait timeout. ADR §4.6 (G7).

onMissingSnapshot string

What to do when the resolved source matches no snapshot. Closed enum. ADR §4.6 (G7). ``` use kopiur_api::restore::OnMissingSnapshot; // Fail-closed is the default so an explicit restore can't silently no-op. assert_eq!(OnMissingSnapshot::default(), OnMissingSnapshot::Fail); assert_eq!(serde_json::to_value(OnMissingSnapshot::Continue).unwrap(), "Continue"); ```

enum: Fail, Continue

waitTimeout string

How long to wait for the source snapshot to appear before giving up (Go-style duration string, e.g. `5m`).

repository object

Derived from `source` when omitted; REQUIRED only with `source.identity`. ADR §3.6/§4.6.

kind string

Which repository CRD this points at; defaults to [`RepositoryKind::Repository`].

enum: Repository, ClusterRepository

name string required

Name of the referenced `Repository`/`ClusterRepository`.

namespace string

Cross-namespace `Repository` reference; ignored/forbidden for `ClusterRepository`.

source object required

Exactly one source mode; webhook-enforced. ADR §3.6.

fromPolicy object

A `SnapshotPolicy` CR — resolves via identity even with no `Snapshot` CR present (deploy-or-restore). Default `onMissingSnapshot: Continue`. ADR §4.6.

asOf string

Restore the newest snapshot at or before this RFC3339 timestamp (point-in-time).

name string required

Name of the `SnapshotPolicy` whose identity selects the snapshot.

namespace string

Namespace of the `SnapshotPolicy`; absent = the `Restore`'s own namespace.

offset integer

0 = latest, 1 = previous, ... ADR §3.6. Carries a real OpenAPI `default: 0` (ADR-0005 §1): unconditional, so it materializes into the stored object / `kubectl explain` and GitOps stops diff-thrashing. A bare `i64` (not `Option`) so the default is never dropped.

format: int64

identity object

A raw kopia identity (foreign writers / aged-out catalog). Requires `spec.repository`.

asOf string

Restore the newest snapshot at or before this RFC3339 timestamp (point-in-time).

hostname string required

The kopia `hostname` to match.

offset integer

0 = latest, 1 = previous, ... mutually exclusive with `snapshotID`/`asOf` in practice.

format: int64

snapshotID string

Pin an exact kopia snapshot by ID. Renamed to match the ADR wire shape exactly (`snapshotID`, capital `ID`).

sourcePath string

The kopia source path to match; absent matches any path for the identity.

username string required

The kopia `username` to match.

snapshotRef object

A `Snapshot` CR (scheduled, manual, or discovered — all the same kind). Default mode.

name string required

Name of the referenced object.

namespace string

Namespace of the referenced object; absent = same namespace as the referrer.

target object required

Where to restore to — **required** (ADR-0005 §9): `pvc` (operator creates), `pvcRef` (existing PVC), or `populator: {}` (passive populator mode, claimed via a PVC's `spec.dataSourceRef`). The former empty-`target` form is removed; a `Restore` with no `target` is now invalid (deserialization fails).

populator object

Passive populator mode: no workload target at provision time — the restore is claimed by a PVC's `spec.dataSourceRef` (ADR-0005 §9). An (empty) sub-object so future populator knobs slot in without API breakage.

pvc object

Operator creates the PVC.

accessModes []string

Access modes for the new PVC (e.g. `["ReadWriteOnce"]`).

capacity string

Requested size of the new PVC (e.g. `100Gi`).

name string required

Name of the PVC to create.

storageClassName string

StorageClass for the new PVC; absent uses the cluster default.

pvcRef object

Write into an existing PVC.

name string required

Name of the referenced object.

namespace string

Namespace of the referenced object; absent = same namespace as the referrer.

status object

Observed state of a [`Restore`], written by the controller/mover. ADR §3.6 status.

conditions []object

Standard Kubernetes conditions carrying the human-readable status/reason.

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

format: date-time

message string required

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

format: int64

reason string required

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status string required

status of the condition, one of True, False, Unknown.

type string required

type of condition in CamelCase or in foo.example.com/CamelCase.

failure object

Structured terminal-failure detail (kopia error class, stderr tail, retry hint), written by the mover before it exits non-zero. ADR §4.10.

exitCode integer

The process exit code, if one was reported.

format: int32

kopiaErrorClass string required

kopia error class (e.g. `RepositoryUnavailable`, `AuthFailure`).

message string required

A short human-readable message: what failed, why, and how to fix it.

retryRecommended boolean required

Whether retrying the same operation unchanged could succeed.

stderrTail string

The last lines of kopia's stderr, if any were captured (bounded by [`MAX_LOG_TAIL_BYTES`]).

logTail string

The last lines of the run's output, written by the mover at the terminal transition (success: the `Restore completed: snapshot <id>` line; failure: the actionable error + kopia stderr tail). Capped at [`crate::common::MAX_LOG_TAIL_BYTES`]; full logs live in the Job pod.

observedGeneration integer

`metadata.generation` last reconciled, so stale status is detectable.

format: int64

phase string

Lifecycle phase of a restore. Closed enum. ADR §3.6 status.

enum: Pending, Resolving, Restoring, Completed, Failed

progress object

Bytes/files restored so far, patched periodically by the mover.

bytesRestored integer

Total bytes restored so far.

format: int64

filesRestored integer

Total files restored so far.

format: int64

resolved object

Pinned at admission; never re-resolved. ADR §3.6/§4.6.

identity object

The resolved kopia identity (`username@hostname:path`) of the snapshot.

hostname string required

The final `hostname` kopia records, fixed at admission.

sourcePath string

The resolved snapshot source path, when applicable (`username@hostname:path`).

username string required

The final `username` kopia records, fixed at admission.

kopiaSnapshotID string

The exact kopia snapshot manifest id the source resolved to. Pinned once; subsequent reconciles restore THIS id even if newer snapshots appear, so a restore never silently retargets (ADR §4.6). Matches `Snapshot.status.snapshot.kopiaSnapshotID`.

pinnedAt string

Timestamp at which the source was pinned (RFC3339).

repository object

The repository the snapshot lives in, resolved from the source.

kind string

Which repository CRD this points at; defaults to [`RepositoryKind::Repository`].

enum: Repository, ClusterRepository

name string required

Name of the referenced `Repository`/`ClusterRepository`.

namespace string

Cross-namespace `Repository` reference; ignored/forbidden for `ClusterRepository`.

snapshotRef object

The concrete `Snapshot` CR the source resolved to, when applicable.

name string required

Name of the referenced object.

namespace string

Namespace of the referenced object; absent = same namespace as the referrer.

sourceKind string

The pinned source kind (`RestoreSource::kind_str` — `SnapshotRef`/`FromPolicy`/ `Identity`), set by the reconciler. Backs the `SOURCE` printer column so `kubectl get restores` shows where a restore reads from. ADR-0005 §3.

target object

Resolved target details (the PVC written to / populator handshake).

pvcPrime string

Populator handshake (passive / pvc-create modes). ADR §3.6.

pvcRef object

The PVC actually written to (created or pre-existing).

name string required

Name of the referenced object.

namespace string

Namespace of the referenced object; absent = same namespace as the referrer.

timing object

Start/end timestamps for the restore run.

endTime string

When the restore reached a terminal phase (RFC3339).

startTime string

When the mover began restoring (RFC3339).