SnapshotReplication

kopiur.home-operations.com / v1alpha1

apiVersion: kopiur.home-operations.com/v1alpha1 kind: SnapshotReplication metadata: name: example

spec object required

Copy selected snapshots from a source repository into a destination repository on a schedule (`kopia snapshot migrate`). Not `Eq`: `mover` transitively embeds k8s-openapi types.

credentialProjection object

Opt-in projection of BOTH repositories' credential Secrets into the mover Job's namespace (required when the destination is a `ClusterRepository` whose Secrets live elsewhere).

enabled boolean

Copy the repository's credential Secret(s) into the namespace of each mover Job; off by default.

destinationRef object required

The `Repository` or `ClusterRepository` snapshots are copied INTO. A real repository CR with its own password and format (unlike a `RepositoryReplication` destination, which is a bare backend reusing the source's password). Must not resolve to the same repository as `sourceRef` (webhook-enforced structurally; the shared validator catches the literal same-ref case at admission).

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`.

migrate object

Tuning for the underlying `kopia snapshot migrate` invocation. Absent: sequential copy, and NO policy copying (see [`PolicyCopyMode`]).

parallel integer

`--parallel`: number of snapshots migrated concurrently (kopia default `1` — sequential). Must be >= 1 when set.

format: uint32

minimum: 0

policies string

Whether kopia **policies** attached to the copied sources are also copied to the destination. Defaults to [`PolicyCopyMode::None`].

enum: none, copy, copyOverwrite

mover object

Mover (Job pod) overrides for the replication run.

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.

enum: Ephemeral, Persistent

storageClassName string

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

inheritSecurityContextFrom object

Copy the UID/GID security context from a live workload rather than hard-coding it. Requires the workload to pin `runAsUser` (container or pod level): a UID that comes from the container image's `USER` line is invisible in the pod spec and cannot be inherited — the mover would silently run as its own image's UID instead. May be combined with `securityContext`/`podSecurityContext`, which override it field-wise and act as the fallback when no workload pod can be resolved.

pvcConsumer object

Backup sources only: auto-derive the workload from the PVC this snapshot backs up.

container string

Which container within the matched consumer pod to inherit from; absent uses the first/only.

snapshot object

Restores only: inherit the identity RECORDED on the backup itself (`Snapshot.status.recorded`, decoded from the `kopiur-meta` kopia tag) — uid/gid/fsGroup the backup mover actually ran as. Needs no live workload pod, so it works on a rebuilt cluster and with `target.populator`. Rejected at admission on SnapshotPolicy/Maintenance (backups read the live workload; maintenance has no snapshot). Write it as `snapshot: {}` (an empty sub-object) — a bare `snapshot:` is null and rejected.

workloadSelector object

Inherit from workload pod(s) matched by an explicit label selector (backup or restore).

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

Pod security context for the mover (notably `fsGroup` for group-writable restore volumes). Same layering as `securityContext`: highest layer, merged field-wise, and combinable with `inheritSecurityContextFrom`.

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 privileged mode; preserves UID/GID on restore.

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

Container security context for the mover; merged field-wise over the hardened base, `moverDefaults`, and any inherited context — this is the highest layer, so every field set here wins. Combines with `inheritSecurityContextFrom`: fields you set override the workload's, fields you omit are inherited, and this context stands in alone when inheritance cannot resolve a pod.

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 `Job.spec.ttlSecondsAfterFinished` so finished Jobs self-GC.

format: int64

pruning object

What happens to already-replicated copies at the destination on later runs. Absent = `none`: copies accumulate forever and — like every mode here — **survive deletion of this CR** (copy `Snapshot` CRs carry no ownerReference to it). Pruning only ever considers snapshots this CR replicated (labeled at birth); it never touches the destination's own directly-written snapshots.

mirrorSource object

Mirror the source: delete a copy when its `(identity, startTime)` has vanished from the source repository.

none object

Never prune: copies accumulate until deleted by hand (the default when `spec.pruning` is absent).

retention object

Keep copies under an independent GFS retention at the destination, regardless of what the source still holds.

keepAnnual integer

Keep one snapshot per year for the most-recent N years.

format: uint32

minimum: 0

keepDaily integer

Keep one snapshot per day for the most-recent N days.

format: uint32

minimum: 0

keepHourly integer

Keep one snapshot per hour for the most-recent N hours.

format: uint32

minimum: 0

keepLatest integer

Keep the N most-recent snapshots regardless of age.

format: uint32

minimum: 0

keepMonthly integer

Keep one snapshot per month for the most-recent N months.

format: uint32

minimum: 0

keepWeekly integer

Keep one snapshot per week for the most-recent N weeks.

format: uint32

minimum: 0

schedule object required

Cron and deterministic jitter for the replication runs.

cron string required

The cron expression, parsed by `croner`; may contain an `H` placeholder for deterministic jitter.

jitter string

Optional deterministic jitter window as a Go-style duration string (e.g. `30m`).

timezone string

IANA timezone the cron is evaluated in (e.g. `America/Chicago`); absent uses the enclosing schedule's timezone, else the controller default (UTC).

selection object

Which snapshots to copy. Absent: every identity in the source repository, full history (`kopia snapshot migrate --all`).

identities object

Select source identities (`username@hostname:path`) to copy. Absent: all identities in the source repository.

exclude []object

Identities to skip, applied after `include`. Exclude wins on overlap.

hostname string

Glob for the `hostname` component; absent matches any hostname.

sourcePath string

Glob for the `sourcePath` component; absent matches any path.

username string

Glob for the `username` component; absent matches any username.

include []object

Identities to copy. Empty/absent: every identity in the source.

hostname string

Glob for the `hostname` component; absent matches any hostname.

sourcePath string

Glob for the `sourcePath` component; absent matches any path.

username string

Glob for the `username` component; absent matches any username.

latestOnly boolean

Copy only each selected identity's most recent snapshot instead of its full history (`kopia snapshot migrate --latest`). Default `false`.

sourceRef object required

The `Repository` or `ClusterRepository` snapshots are copied FROM. Opened read-only by the replication mover — a replication never writes to its 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`.

suspend boolean

Pause this replication; a suspended replication runs no copies (default `false`).

status object

Observed state of a `SnapshotReplication`.

conditions []object

Standard Kubernetes conditions (`Ready`, `Reconciling`, `Stalled`).

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.

lastReplicated string

RFC3339 timestamp of the most recent successful replication run (also the scheduling anchor for the next slot).

lastRun object

Counters from the most recent run.

alreadyPresent integer

Selected snapshots that were already present at the destination (skipped).

format: uint32

minimum: 0

failed integer

Selected snapshots that failed to copy (kopia migrate exits 0 on per-source failures; the mover's post-verify counts them here).

format: uint32

minimum: 0

identitiesSelected integer

Source identities the selector matched this run.

format: uint32

minimum: 0

pruned integer

Copies pruned this run per `spec.pruning`.

format: uint32

minimum: 0

snapshotsCopied integer

Snapshots newly copied to the destination this run.

format: uint32

minimum: 0

observedGeneration integer

`metadata.generation` last reconciled, for staleness detection / kstatus.

format: int64

phase string

Lifecycle phase of a snapshot replication.

enum: Pending, Replicating, Succeeded, Failed, Suspended

No matches. Try .spec.credentialProjection for an exact path