{ "description": "Auto-generated derived type for SnapshotPolicySpec via `CustomResource`", "properties": { "spec": { "additionalProperties": false, "description": "What to back up: sources, identity, retention, policy, hooks.", "properties": { "compression": { "additionalProperties": false, "description": "Compression algorithm + per-extension opt-outs.", "nullable": true, "properties": { "compressor": { "description": "kopia compressor name (e.g. `zstd`); absent leaves kopia's default.", "nullable": true, "type": [ "string", "null" ] }, "neverCompress": { "description": "Filename globs to leave uncompressed (e.g. already-compressed media).", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "copyMethod": { "default": "Snapshot", "description": "How the source volume is captured before kopia reads it: `Snapshot` (default), `Direct`, or `Clone`.", "enum": [ "Snapshot", "Clone", "Direct" ], "type": [ "string", "null" ] }, "credentialProjection": { "additionalProperties": false, "description": "Opt-in credential-Secret projection into each backup mover's namespace (default off).", "nullable": true, "properties": { "enabled": { "default": false, "description": "Copy the repository's credential Secret(s) into the namespace of each mover Job; off by default.", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "defaultDeletionPolicy": { "default": "Delete", "description": "Lifecycle of the underlying kopia snapshot when its `Snapshot` CR is deleted.\nProduced backups default to `Delete`; discovered snapshots are forced to `Retain`.", "enum": [ "Delete", "Retain", "Orphan" ], "nullable": true, "type": [ "string", "null" ] }, "errorHandling": { "additionalProperties": false, "description": "Backup-side error handling: let a snapshot complete-with-errors instead of failing outright.", "nullable": true, "properties": { "failFast": { "description": "Abort the snapshot at the first error instead of collecting and\ncontinuing (`snapshot create --fail-fast`; kopia default: false). This\nis a `snapshot create` argv flag, not a `policy set` knob, but lives\nbeside its semantic opposites (`ignore*Errors`) for discoverability.", "type": [ "boolean", "null" ] }, "ignoreDirErrors": { "description": "Continue the snapshot when a directory cannot be read (`--ignore-dir-errors`).", "type": [ "boolean", "null" ] }, "ignoreFileErrors": { "description": "Continue the snapshot when a file cannot be read (`--ignore-file-errors`).", "type": [ "boolean", "null" ] }, "ignoreUnknownTypes": { "description": "Continue past entries of unknown type (`--ignore-unknown-types`).", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "extraArgs": { "description": "Escape hatch for kopia flags not yet modeled.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "files": { "additionalProperties": false, "description": "Paths/patterns kopia should skip while snapshotting.", "nullable": true, "properties": { "ignoreCacheDirs": { "description": "Honor `CACHEDIR.TAG`.", "type": [ "boolean", "null" ] }, "ignoreIdenticalSnapshots": { "description": "Skip taking a new snapshot when the source is identical to the previous one.", "type": [ "boolean", "null" ] }, "ignoreRules": { "default": [ "/lost+found", "System Volume Information", "$RECYCLE.BIN", "@eaDir", ".snapshot" ], "description": "Filename/path globs to exclude from the snapshot (e.g. `*.tmp`, `*/cache/*`).\nAbsent ⇒ [`default_ignore_rules`] (OS-artifact junk: `/lost+found`,\n`System Volume Information`, `$RECYCLE.BIN`, `@eaDir`, `.snapshot`). An\nexplicit list REPLACES the default wholesale (re-add any entries you\nstill want); explicit `ignoreRules: []` opts fully out. NOT\n`skip_serializing_if` — an explicit empty list must round-trip as `[]`,\nnot vanish back to \"absent\" (which would silently resurrect the\ndefault on the next parse).", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "groupBy": { "default": "VolumeGroupSnapshot", "description": "Multi-PVC grouping strategy. Defaults to a consistent group snapshot across\nall PVCs; set `None` *explicitly* to accept independent per-PVC snapshots,\nbecause a silent per-PVC fallback would produce inconsistent backups.", "enum": [ "VolumeGroupSnapshot", "None" ], "nullable": true, "type": [ "string", "null" ] }, "hooks": { "additionalProperties": false, "description": "Pre/post snapshot hooks that run in the workload, not the mover.", "nullable": true, "properties": { "afterSnapshot": { "description": "Hooks run (in order) after the snapshot completes — e.g. resuming the workload.", "items": { "additionalProperties": false, "description": "One of three hook forms. Externally-tagged: the wire shape is\n`{ workloadExec: {...} }`, `{ runJob: {...} }`, or `{ httpRequest: {...} }`,\nand exactly one form is present.", "oneOf": [ { "required": [ "workloadExec" ] }, { "required": [ "runJob" ] }, { "required": [ "httpRequest" ] } ], "properties": { "httpRequest": { "additionalProperties": false, "description": "Typed POST to a URL for cross-system orchestration.", "properties": { "body": { "description": "Optional request body.", "nullable": true, "type": [ "string", "null" ] }, "continueOnFailure": { "description": "If `true`, a failed request does not abort the backup (default: abort).", "type": [ "boolean", "null" ] }, "method": { "description": "HTTP method (default `POST`).", "nullable": true, "type": [ "string", "null" ] }, "timeout": { "description": "Max time to wait for the response (Go duration string).", "nullable": true, "type": [ "string", "null" ] }, "url": { "description": "Target URL to call.", "type": "string" } }, "required": [ "url" ], "type": [ "object", "null" ] }, "runJob": { "additionalProperties": false, "description": "Full `JobSpec` run as a one-shot Job (k8up `PreBackupPod` analog).", "properties": { "continueOnFailure": { "description": "If `true`, a failed Job does not abort the backup (default: abort).", "type": [ "boolean", "null" ] }, "jobSpec": { "description": "The full Kubernetes `JobSpec` to run.", "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "timeout": { "description": "Max time to wait for the Job to complete (Go duration string).", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "jobSpec" ], "type": [ "object", "null" ] }, "workloadExec": { "additionalProperties": false, "description": "`kubectl exec`-style into a matched workload pod/container (the default form).", "properties": { "command": { "description": "Command + args to run inside the selected container.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "container": { "description": "Which container within the matched pod; absent uses the first/only container.", "nullable": true, "type": [ "string", "null" ] }, "continueOnFailure": { "description": "If `true`, a failed hook does not abort the backup (default: abort).", "type": [ "boolean", "null" ] }, "podSelector": { "additionalProperties": false, "description": "Label selector matching the workload pod(s) to read context/hooks from.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "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.", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ] }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "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.", "type": [ "object", "null" ] } }, "type": "object" }, "timeout": { "description": "Max time to wait for the command (Go duration string, e.g. `2m`).", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "podSelector" ], "type": [ "object", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "beforeSnapshot": { "description": "Hooks run (in order) before the snapshot is taken — e.g. quiescing a database.", "items": { "additionalProperties": false, "description": "One of three hook forms. Externally-tagged: the wire shape is\n`{ workloadExec: {...} }`, `{ runJob: {...} }`, or `{ httpRequest: {...} }`,\nand exactly one form is present.", "oneOf": [ { "required": [ "workloadExec" ] }, { "required": [ "runJob" ] }, { "required": [ "httpRequest" ] } ], "properties": { "httpRequest": { "additionalProperties": false, "description": "Typed POST to a URL for cross-system orchestration.", "properties": { "body": { "description": "Optional request body.", "nullable": true, "type": [ "string", "null" ] }, "continueOnFailure": { "description": "If `true`, a failed request does not abort the backup (default: abort).", "type": [ "boolean", "null" ] }, "method": { "description": "HTTP method (default `POST`).", "nullable": true, "type": [ "string", "null" ] }, "timeout": { "description": "Max time to wait for the response (Go duration string).", "nullable": true, "type": [ "string", "null" ] }, "url": { "description": "Target URL to call.", "type": "string" } }, "required": [ "url" ], "type": [ "object", "null" ] }, "runJob": { "additionalProperties": false, "description": "Full `JobSpec` run as a one-shot Job (k8up `PreBackupPod` analog).", "properties": { "continueOnFailure": { "description": "If `true`, a failed Job does not abort the backup (default: abort).", "type": [ "boolean", "null" ] }, "jobSpec": { "description": "The full Kubernetes `JobSpec` to run.", "type": "object", "x-kubernetes-preserve-unknown-fields": true }, "timeout": { "description": "Max time to wait for the Job to complete (Go duration string).", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "jobSpec" ], "type": [ "object", "null" ] }, "workloadExec": { "additionalProperties": false, "description": "`kubectl exec`-style into a matched workload pod/container (the default form).", "properties": { "command": { "description": "Command + args to run inside the selected container.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "container": { "description": "Which container within the matched pod; absent uses the first/only container.", "nullable": true, "type": [ "string", "null" ] }, "continueOnFailure": { "description": "If `true`, a failed hook does not abort the backup (default: abort).", "type": [ "boolean", "null" ] }, "podSelector": { "additionalProperties": false, "description": "Label selector matching the workload pod(s) to read context/hooks from.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "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.", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ] }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "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.", "type": [ "object", "null" ] } }, "type": "object" }, "timeout": { "description": "Max time to wait for the command (Go duration string, e.g. `2m`).", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "podSelector" ], "type": [ "object", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "identity": { "additionalProperties": false, "description": "Identity overrides — what kopia records as `username@hostname:path`.", "nullable": true, "properties": { "hostname": { "description": "Override the `hostname` portion of `username@hostname:path`; absent uses the resolved default.", "nullable": true, "type": [ "string", "null" ] }, "username": { "description": "Override the `username` portion of `username@hostname:path`; absent uses the resolved default.", "nullable": true, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "mover": { "additionalProperties": false, "description": "Per-recipe mover overrides (resources, cache, security context).", "nullable": true, "properties": { "cache": { "additionalProperties": false, "description": "Override the repository's [`CacheDefaults`] for this recipe's movers.", "nullable": true, "properties": { "capacity": { "description": "Size of the PVC backing the mover's kopia cache (e.g. `10Gi`).", "nullable": true, "type": [ "string", "null" ] }, "contentCacheSizeMb": { "description": "kopia content cache budget in MiB (`--content-cache-size-mb`).", "format": "int64", "nullable": true, "type": [ "integer", "null" ] }, "metadataCacheSizeMb": { "description": "kopia metadata cache budget in MiB (`--metadata-cache-size-mb`).", "format": "int64", "nullable": true, "type": [ "integer", "null" ] }, "mode": { "description": "How a mover's kopia cache volume is provisioned.", "enum": [ "Ephemeral", "Persistent" ], "nullable": true, "type": [ "string", "null" ] }, "storageClassName": { "description": "StorageClass for the cache PVC; absent uses the cluster default.", "nullable": true, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "inheritSecurityContextFrom": { "additionalProperties": false, "description": "Copy the UID/GID security context from a live workload instead of setting it explicitly.", "nullable": true, "oneOf": [ { "required": [ "workloadSelector" ] }, { "required": [ "pvcConsumer" ] } ], "properties": { "pvcConsumer": { "additionalProperties": false, "description": "Backup sources only: auto-derive the workload from the PVC this snapshot backs up.", "properties": { "container": { "description": "Which container within the matched consumer pod to inherit from; absent uses the first/only.", "nullable": true, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "workloadSelector": { "additionalProperties": false, "description": "Inherit from workload pod(s) matched by an explicit label selector (backup or restore).", "properties": { "container": { "description": "Which container within the matched pod; absent uses the first/only container.", "nullable": true, "type": [ "string", "null" ] }, "podSelector": { "additionalProperties": false, "description": "Label selector matching the workload pod(s) to read context/hooks from.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "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.", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ] }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "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.", "type": [ "object", "null" ] } }, "type": "object" } }, "required": [ "podSelector" ], "type": [ "object", "null" ] } }, "type": "object" }, "podSecurityContext": { "additionalProperties": false, "description": "Pod security context for the mover (notably `fsGroup` for group-writable restore volumes).", "nullable": true, "properties": { "appArmorProfile": { "additionalProperties": false, "description": "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.", "properties": { "localhostProfile": { "description": "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", "null" ] }, "type": { "description": "type indicates which kind of AppArmor profile will be applied. Valid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.", "type": "string" } }, "required": [ "type" ], "type": [ "object", "null" ] }, "fsGroup": { "description": "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:\n\n1. 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----\n\nIf 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", "type": [ "integer", "null" ] }, "fsGroupChangePolicy": { "description": "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.", "type": [ "string", "null" ] }, "runAsGroup": { "description": "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", "type": [ "integer", "null" ] }, "runAsNonRoot": { "description": "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.", "type": [ "boolean", "null" ] }, "runAsUser": { "description": "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", "type": [ "integer", "null" ] }, "seLinuxChangePolicy": { "description": "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\".\n\n\"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.\n\n\"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.\n\nIf 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.\n\nThis field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.\n\nAll 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.", "type": [ "string", "null" ] }, "seLinuxOptions": { "additionalProperties": false, "description": "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.", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.", "type": [ "string", "null" ] }, "role": { "description": "Role is a SELinux role label that applies to the container.", "type": [ "string", "null" ] }, "type": { "description": "Type is a SELinux type label that applies to the container.", "type": [ "string", "null" ] }, "user": { "description": "User is a SELinux user label that applies to the container.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "seccompProfile": { "additionalProperties": false, "description": "The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "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", "null" ] }, "type": { "description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - 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.", "type": "string" } }, "required": [ "type" ], "type": [ "object", "null" ] }, "supplementalGroups": { "description": "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.", "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ] }, "supplementalGroupsPolicy": { "description": "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.", "type": [ "string", "null" ] }, "sysctls": { "description": "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.", "items": { "additionalProperties": false, "description": "Sysctl defines a kernel parameter to be set", "properties": { "name": { "description": "Name of a property to set", "type": "string" }, "value": { "description": "Value of a property to set", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ] }, "windowsOptions": { "additionalProperties": false, "description": "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.", "properties": { "gmsaCredentialSpec": { "description": "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.", "type": [ "string", "null" ] }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.", "type": [ "string", "null" ] }, "hostProcess": { "description": "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.", "type": [ "boolean", "null" ] }, "runAsUserName": { "description": "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.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "privilegedMode": { "description": "Opt-in, namespace-gated privileged mode; preserves UID/GID on restore.", "nullable": true, "type": [ "boolean", "null" ] }, "resources": { "additionalProperties": false, "description": "Resource requests/limits for the mover container.", "nullable": true, "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", "items": { "additionalProperties": false, "description": "ResourceClaim references one entry in PodSpec.ResourceClaims.", "properties": { "name": { "description": "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.", "type": "string" }, "request": { "description": "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.", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ] }, "limits": { "additionalProperties": { "description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n``` \u003cquantity\u003e ::= \u003csignedNumber\u003e\u003csuffix\u003e\n\n\t(Note that \u003csuffix\u003e may be empty, from the \"\" case in \u003cdecimalSI\u003e.)\n\n\u003cdigit\u003e ::= 0 | 1 | ... | 9 \u003cdigits\u003e ::= \u003cdigit\u003e | \u003cdigit\u003e\u003cdigits\u003e \u003cnumber\u003e ::= \u003cdigits\u003e | \u003cdigits\u003e.\u003cdigits\u003e | \u003cdigits\u003e. | .\u003cdigits\u003e \u003csign\u003e ::= \"+\" | \"-\" \u003csignedNumber\u003e ::= \u003cnumber\u003e | \u003csign\u003e\u003cnumber\u003e \u003csuffix\u003e ::= \u003cbinarySI\u003e | \u003cdecimalExponent\u003e | \u003cdecimalSI\u003e \u003cbinarySI\u003e ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n\u003cdecimalSI\u003e ::= m | \"\" | k | M | G | T | P | E\n\n\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n\u003cdecimalExponent\u003e ::= \"e\" \u003csignedNumber\u003e | \"E\" \u003csignedNumber\u003e ```\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n\n- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n- 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] }, "requests": { "additionalProperties": { "description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n``` \u003cquantity\u003e ::= \u003csignedNumber\u003e\u003csuffix\u003e\n\n\t(Note that \u003csuffix\u003e may be empty, from the \"\" case in \u003cdecimalSI\u003e.)\n\n\u003cdigit\u003e ::= 0 | 1 | ... | 9 \u003cdigits\u003e ::= \u003cdigit\u003e | \u003cdigit\u003e\u003cdigits\u003e \u003cnumber\u003e ::= \u003cdigits\u003e | \u003cdigits\u003e.\u003cdigits\u003e | \u003cdigits\u003e. | .\u003cdigits\u003e \u003csign\u003e ::= \"+\" | \"-\" \u003csignedNumber\u003e ::= \u003cnumber\u003e | \u003csign\u003e\u003cnumber\u003e \u003csuffix\u003e ::= \u003cbinarySI\u003e | \u003cdecimalExponent\u003e | \u003cdecimalSI\u003e \u003cbinarySI\u003e ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n\u003cdecimalSI\u003e ::= m | \"\" | k | M | G | T | P | E\n\n\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n\u003cdecimalExponent\u003e ::= \"e\" \u003csignedNumber\u003e | \"E\" \u003csignedNumber\u003e ```\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n\n- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n- 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "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/", "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "securityContext": { "additionalProperties": false, "description": "Container security context for the mover; merged field-wise over the defaults and hardened base.", "nullable": true, "properties": { "allowPrivilegeEscalation": { "description": "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.", "type": [ "boolean", "null" ] }, "appArmorProfile": { "additionalProperties": false, "description": "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.", "properties": { "localhostProfile": { "description": "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", "null" ] }, "type": { "description": "type indicates which kind of AppArmor profile will be applied. Valid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.", "type": "string" } }, "required": [ "type" ], "type": [ "object", "null" ] }, "capabilities": { "additionalProperties": false, "description": "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.", "properties": { "add": { "description": "Added capabilities", "items": { "type": "string" }, "type": [ "array", "null" ] }, "drop": { "description": "Removed capabilities", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "privileged": { "description": "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.", "type": [ "boolean", "null" ] }, "procMount": { "description": "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.", "type": [ "string", "null" ] }, "readOnlyRootFilesystem": { "description": "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.", "type": [ "boolean", "null" ] }, "runAsGroup": { "description": "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", "type": [ "integer", "null" ] }, "runAsNonRoot": { "description": "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.", "type": [ "boolean", "null" ] }, "runAsUser": { "description": "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", "type": [ "integer", "null" ] }, "seLinuxOptions": { "additionalProperties": false, "description": "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.", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.", "type": [ "string", "null" ] }, "role": { "description": "Role is a SELinux role label that applies to the container.", "type": [ "string", "null" ] }, "type": { "description": "Type is a SELinux type label that applies to the container.", "type": [ "string", "null" ] }, "user": { "description": "User is a SELinux user label that applies to the container.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "seccompProfile": { "additionalProperties": false, "description": "The seccomp options to use by this container. If seccomp options are provided at both the pod \u0026 container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "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", "null" ] }, "type": { "description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - 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.", "type": "string" } }, "required": [ "type" ], "type": [ "object", "null" ] }, "windowsOptions": { "additionalProperties": false, "description": "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.", "properties": { "gmsaCredentialSpec": { "description": "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.", "type": [ "string", "null" ] }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.", "type": [ "string", "null" ] }, "hostProcess": { "description": "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.", "type": [ "boolean", "null" ] }, "runAsUserName": { "description": "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.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "ttlSecondsAfterFinished": { "description": "Per-recipe override of `Job.spec.ttlSecondsAfterFinished` so finished Jobs self-GC.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "preflight": { "additionalProperties": false, "description": "Named CEL preconditions evaluated before each backup run; opt-in (absent ⇒\nno preflight). A failing check holds the `Snapshot` in `Pending`\n(`PreflightFailed`) and, after `timeout`, fails it.", "nullable": true, "properties": { "checks": { "description": "Checks that must **all** pass (AND) before the backup launches. An empty\nlist is an inert no-op (symmetric with `verification` absent).", "items": { "additionalProperties": false, "description": "One named precondition: a CEL bool predicate over the preflight environment.", "properties": { "expr": { "description": "CEL bool predicate; the backup proceeds only when this evaluates `true`.", "type": "string" }, "message": { "description": "Optional human message surfaced alongside the check name when it blocks.", "nullable": true, "type": [ "string", "null" ] }, "name": { "description": "Stable identifier surfaced in the `Snapshot`'s status when this check blocks\n(e.g. `maintenance-fresh`). Unique within the policy.", "maxLength": 63, "minLength": 1, "type": "string" } }, "required": [ "expr", "name" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "timeout": { "description": "How long to hold a `Snapshot` in `Pending` while a check is unsatisfied\nbefore failing it (Go-style duration like `10m` or `1h`; default `10m`). A\nzero duration (`0`/`0s`) holds indefinitely (never fail on preflight).", "nullable": true, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "repository": { "additionalProperties": false, "description": "Discriminated reference to a `Repository` or `ClusterRepository`.", "properties": { "kind": { "default": "Repository", "description": "Which repository CRD this points at; defaults to [`RepositoryKind::Repository`].", "enum": [ "Repository", "ClusterRepository" ], "type": [ "string", "null" ] }, "name": { "description": "Name of the referenced `Repository`/`ClusterRepository`.", "type": "string" }, "namespace": { "description": "Cross-namespace `Repository` reference; ignored/forbidden for `ClusterRepository`.", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "retention": { "additionalProperties": false, "description": "GFS retention, enforced by the operator pruning `Snapshot` CRs.", "nullable": true, "properties": { "keepAnnual": { "description": "Keep one snapshot per year for the most-recent N years.", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] }, "keepDaily": { "description": "Keep one snapshot per day for the most-recent N days.", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] }, "keepHourly": { "description": "Keep one snapshot per hour for the most-recent N hours.", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] }, "keepLatest": { "description": "Keep the N most-recent snapshots regardless of age.", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] }, "keepMonthly": { "description": "Keep one snapshot per month for the most-recent N months.", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] }, "keepWeekly": { "description": "Keep one snapshot per week for the most-recent N weeks.", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "sources": { "description": "What to back up (at least one source; webhook-enforced).", "items": { "additionalProperties": false, "description": "A single backup source; exactly one of `pvc`, `pvcSelector`, `nfs` (webhook-enforced).", "properties": { "nfs": { "additionalProperties": false, "description": "An inline NFS export to back up directly, mounted read-only. Mutually exclusive with `pvc`/`pvcSelector`.", "nullable": true, "properties": { "path": { "description": "Exported path on the NFS server (e.g. `/export/kopia` or `/mnt/eros/Media`).", "type": "string" }, "server": { "description": "NFS server hostname or IP (e.g. `nas.lan` or `expanse.internal`).", "type": "string" } }, "required": [ "path", "server" ], "type": [ "object", "null" ] }, "pvc": { "additionalProperties": false, "description": "Single PVC by name. Mutually exclusive with `pvcSelector`/`nfs`.", "nullable": true, "properties": { "name": { "description": "Name of the `PersistentVolumeClaim` to back up (in the `SnapshotPolicy`'s namespace).", "type": "string" } }, "required": [ "name" ], "type": [ "object", "null" ] }, "pvcSelector": { "additionalProperties": false, "description": "Label/namespace selector matching many PVCs. Mutually exclusive with `pvc`/`nfs`.", "nullable": true, "properties": { "labelSelector": { "additionalProperties": false, "description": "Standard Kubernetes label selector matching the PVCs to include.", "nullable": true, "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "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.", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ] }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "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.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "namespaceSelector": { "additionalProperties": false, "description": "Restricts the search to specific namespaces; absent means the policy's own namespace.", "nullable": true, "properties": { "matchNames": { "description": "Exact namespace names to search; empty means the policy's own namespace.", "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "sourcePathOverride": { "description": "What kopia records as the source path (default `/pvc/\u003cname\u003e`, or the NFS export `path`).", "maxLength": 4096, "nullable": true, "type": [ "string", "null" ] }, "sourcePathStrategy": { "default": "PvcName", "description": "How a selector-matched PVC's source path is derived. Only relevant for\n`pvcSelector` sources, where one recipe expands to many PVCs and each needs a\ndistinct kopia source path. Defaults to `PvcName`.", "enum": [ "PvcName", "PvcNamespacedName" ], "nullable": true, "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of pvc, pvcSelector, nfs", "rule": "(has(self.pvc) ? 1 : 0) + (has(self.pvcSelector) ? 1 : 0) + (has(self.nfs) ? 1 : 0) == 1" } ] }, "maxItems": 100, "type": [ "array", "null" ] }, "staging": { "additionalProperties": false, "description": "Staging knobs for `copyMethod: Snapshot`/`Clone` (e.g. how long to wait for\nthe CSI capture to become ready before failing the backup).", "nullable": true, "properties": { "accessModes": { "description": "Access modes for the staged PVC. Empty ⇒ copy the source PVC's modes.\n`[ReadOnlyMany]` pairs with snapshot-backed read-only classes (e.g. CephFS\n`backingSnapshot`); the mover always mounts the staged PVC read-only\nregardless of the mode.", "items": { "description": "A Kubernetes PersistentVolumeClaim access mode.", "enum": [ "ReadWriteOnce", "ReadOnlyMany", "ReadWriteMany", "ReadWriteOncePod" ], "type": "string" }, "type": [ "array", "null" ] }, "storageClassName": { "description": "StorageClass for the **staged PVC** — the temporary PVC restored from the\nCSI `VolumeSnapshot` (`copyMethod: Snapshot`) or cloned from the source\n(`copyMethod: Clone`). Absent ⇒ the staged PVC copies the source PVC's\nclass. Must belong to the **same CSI driver** as the source (staging fails\nfast on a mismatch). Flagship use: a rook-ceph CephFS class with\n`backingSnapshot: \"true\"`, which mounts the snapshot shallowly\n(metadata-only, near-instant, read-only) instead of running a full\nsubvolume clone that can take many minutes on small-file-heavy volumes.", "nullable": true, "type": [ "string", "null" ] }, "timeout": { "description": "How long each staging phase may take before the backup is failed (Go-style\nduration like `10m` or `1h`; default `10m`): first the staged\n`VolumeSnapshot` becoming `readyToUse` (measured from its creation), then —\non an `Immediate`-binding StorageClass — the staged PVC binding (a fresh\nbudget measured from the PVC's creation, covering the CSI restore/clone).\nA transient CSI/snapshot-controller error during either wait is retried,\nnever fatal on its own — only this deadline fails staging. A zero duration\n(`0`/`0s`) waits indefinitely. Raise this for backends whose snapshots or\nclones take long (e.g. cloud snapshots of large volumes, CephFS full clones\nof small-file-heavy volumes).", "nullable": true, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "suspend": { "description": "Pause this recipe declaratively (schedules and reconcile skip a suspended policy).", "type": [ "boolean", "null" ] }, "upload": { "additionalProperties": false, "description": "Upload parallelism (kopia's `--max-parallel-snapshots` / `--max-parallel-file-reads`).", "nullable": true, "properties": { "limitMb": { "description": "`snapshot create --upload-limit-mb`: abort the snapshot once this many\nMB have been uploaded (kopia default: 0 — unlimited). Named `limitMb`\nrather than `uploadLimitMb` to avoid the `upload.uploadLimitMb` stutter;\nlike `failFast`, this is a `snapshot create` argv flag, not a `policy\nset` knob, but lives here beside its parallelism siblings.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] }, "maxParallelFileReads": { "description": "`--max-parallel-file-reads`: file-read concurrency within a snapshot.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] }, "maxParallelSnapshots": { "description": "`--max-parallel-snapshots`: how many sources snapshot concurrently.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "verification": { "additionalProperties": false, "description": "First-class backup verification; opt-in (absent ⇒ no verification runs).", "nullable": true, "properties": { "deep": { "additionalProperties": false, "description": "Schedule + knobs for the rarer scratch-restore test; absent ⇒ no deep verification.", "nullable": true, "properties": { "capacity": { "description": "Size of the ephemeral scratch PVC (e.g. `10Gi`); absent falls back to a node-ephemeral `emptyDir`.", "nullable": true, "type": [ "string", "null" ] }, "parallel": { "description": "`restore --parallel`: restore parallelism for the scratch-restore (deep verify\nIS a restore under the hood); absent leaves kopia's default.", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] }, "schedule": { "additionalProperties": false, "description": "Cron + jitter for the deep restore-test (e.g. weekly).", "properties": { "cron": { "description": "The cron expression, parsed by `croner`; may contain an `H` placeholder for deterministic jitter.", "type": "string" }, "jitter": { "description": "Optional deterministic jitter window as a Go-style duration string (e.g. `30m`).", "nullable": true, "type": [ "string", "null" ] }, "timezone": { "description": "IANA timezone the cron is evaluated in (e.g. `America/Chicago`); absent uses\nthe enclosing schedule's timezone, else the controller default (UTC).", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "cron" ], "type": "object" }, "storageClassName": { "description": "StorageClass for the ephemeral scratch PVC; absent uses the cluster default (only with `capacity`).", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "schedule" ], "type": [ "object", "null" ] }, "quick": { "additionalProperties": false, "description": "Quick (blob-level) verification tier; absent ⇒ no quick verification. Its cron\nlives under `quick.schedule` (matching `deep.schedule`), see [`QuickVerification`].", "nullable": true, "properties": { "fileParallelism": { "description": "`--file-parallelism`: parallelism for file verification (kopia default: unset).", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] }, "fileQueueLength": { "description": "`--file-queue-length`: queue length for file verification (kopia default: 20000).", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] }, "maxErrors": { "description": "`--max-errors`: stop after this many errors (kopia default: 0, meaning stop\nat the first error).", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] }, "parallel": { "description": "`--parallel`: verification parallelism (kopia default: 8).", "format": "uint32", "minimum": 0, "nullable": true, "type": [ "integer", "null" ] }, "schedule": { "additionalProperties": false, "description": "Cron + jitter + timezone for the frequent blob-level verify; absent ⇒ quick tier disabled.", "nullable": true, "properties": { "cron": { "description": "The cron expression, parsed by `croner`; may contain an `H` placeholder for deterministic jitter.", "type": "string" }, "jitter": { "description": "Optional deterministic jitter window as a Go-style duration string (e.g. `30m`).", "nullable": true, "type": [ "string", "null" ] }, "timezone": { "description": "IANA timezone the cron is evaluated in (e.g. `America/Chicago`); absent uses\nthe enclosing schedule's timezone, else the controller default (UTC).", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "cron" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "successExpr": { "description": "CEL pass/fail predicate over the verify result; applies to both tiers.", "nullable": true, "type": [ "string", "null" ] }, "verifyFilesPercent": { "description": "How many files `quick` verifies fully (`--verify-files-percent`); absent leaves kopia's default.", "format": "uint8", "maximum": 255, "minimum": 0, "nullable": true, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "volumeSnapshotClassName": { "description": "`VolumeSnapshotClass` used when `copyMethod` snapshots/clones the source.", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "repository" ], "type": "object" }, "status": { "additionalProperties": false, "description": "Observed state of a `SnapshotPolicy`.", "nullable": true, "properties": { "conditions": { "description": "Standard Kubernetes conditions (e.g. `RepositoryReachable`, `GroupSnapshotSupported`).", "items": { "additionalProperties": false, "description": "Condition contains details for one aspect of the current state of this API Resource.", "properties": { "lastTransitionTime": { "description": "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", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition. This may be an empty string.", "type": "string" }, "observedGeneration": { "description": "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", "type": [ "integer", "null" ] }, "reason": { "description": "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.", "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.", "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.", "type": "string" } }, "required": [ "lastTransitionTime", "message", "reason", "status", "type" ], "type": "object" }, "type": [ "array", "null" ] }, "lastSuccessfulSnapshot": { "description": "RFC3339 timestamp of the most recent successful child `Snapshot` from this recipe.", "nullable": true, "type": [ "string", "null" ] }, "lastVerified": { "description": "RFC3339 timestamp of the most recent successful verification (any tier).", "nullable": true, "type": [ "string", "null" ] }, "observedGeneration": { "description": "`metadata.generation` last reconciled, for staleness detection.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] }, "resolved": { "additionalProperties": false, "description": "What would be passed to kopia — pinned at admission.", "nullable": true, "properties": { "identity": { "additionalProperties": false, "description": "The resolved `username@hostname` identity.", "nullable": true, "properties": { "hostname": { "description": "The final `hostname` kopia records, fixed at admission.", "type": "string" }, "sourcePath": { "description": "The resolved snapshot source path, when applicable (`username@hostname:path`).", "nullable": true, "type": [ "string", "null" ] }, "username": { "description": "The final `username` kopia records, fixed at admission.", "type": "string" } }, "required": [ "hostname", "username" ], "type": [ "object", "null" ] }, "sources": { "description": "The concrete PVCs + source paths after selector expansion.", "items": { "additionalProperties": false, "description": "One resolved source — a concrete PVC and the path kopia records for it.", "properties": { "pvc": { "description": "`namespace/name` of the PVC, as kopia sees it.", "nullable": true, "type": [ "string", "null" ] }, "sourcePath": { "description": "The source path kopia records for this PVC.", "nullable": true, "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "retention": { "additionalProperties": false, "description": "Summary of GFS retention pruning against this config's `Snapshot` CRs.", "nullable": true, "properties": { "activeSnapshotCount": { "description": "CRs currently inside the GFS window.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] }, "lastPruneAt": { "description": "RFC3339 timestamp of the last prune pass.", "nullable": true, "type": [ "string", "null" ] }, "lastPruneDeleted": { "description": "Number of `Snapshot` CRs deleted by the last prune pass.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] } }, "required": [ "spec" ], "title": "SnapshotPolicy", "type": "object" }