{ "description": "Auto-generated derived type for RestoreSpec via `CustomResource`", "properties": { "spec": { "additionalProperties": false, "description": "A restore operation. `target` is **required** (ADR-0005 §9): explicit\n`pvc`/`pvcRef`, or `populator: {}` for passive populator mode (consumed by a\nPVC's `spec.dataSourceRef`). The empty-`target` form is removed. ADR §3.6/§4.7.\nDesired state of a [`Restore`]: where to read from, where to write to, and how\nto behave when the snapshot is missing. ADR §3.6/§4.6.", "properties": { "credentialProjection": { "additionalProperties": false, "description": "Opt-in credential-Secret projection for this restore's mover (default off).\nWhen `enabled: true`, the operator copies the referenced repository's\ncredential Secret(s) into the restore mover's namespace (a no-op when they\nalready live there) — so restoring from a shared `ClusterRepository` into a\nfresh namespace need not pre-create the Secret there. ADR §4.11.", "nullable": true, "properties": { "enabled": { "default": false, "description": "When true, the operator copies the repository's credential Secret(s) into\nthe namespace of each mover Job that uses this repository. Off by default.", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "failurePolicy": { "additionalProperties": false, "description": "Mover `Job` retry/deadline limits (`backoffLimit`, `activeDeadlineSeconds`),\nmirroring `Snapshot.spec.failurePolicy`. Absent uses the ADR defaults.", "nullable": true, "properties": { "activeDeadlineSeconds": { "description": "Passed through to the mover `Job.spec.activeDeadlineSeconds` — wall-clock cap\nafter which a still-running run is killed.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] }, "backoffLimit": { "description": "Passed through to the mover `Job.spec.backoffLimit` — how many times a failed\nrun is retried before the Job is marked failed.", "format": "int32", "nullable": true, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "mover": { "additionalProperties": false, "description": "Per-run mover overrides for this restore's Job — resource requests/limits,\nkopia cache sizing, container `securityContext` (UID/GID match), `privilegedMode`,\nand `inheritSecurityContextFrom`. The same surface `SnapshotPolicy.spec.mover`\ngives a backup. An elevated context is namespace-gated exactly like a backup's\n(ADR §4.11/§G16); `securityContext` and `inheritSecurityContextFrom` are\nmutually exclusive.", "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. ADR §3.1.", "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": "Opt-in: copy security context from a live workload pod. ADR §4.11.", "nullable": true, "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" ] }, "podSecurityContext": { "additionalProperties": false, "description": "Security context applied to the mover **pod** — notably `fsGroup`, which makes\na freshly-provisioned volume group-writable so an unprivileged\n(`runAsUser != 0`) mover can populate it on **restore** without root. Distinct\nfrom the container-level [`MoverSpec::security_context`]; a pod-level\n`runAsUser: 0` / `runAsNonRoot: false` here is still gated as privileged.", "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; preserves UID/GID on restore. ADR §4.11/§G16.", "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": "Security context applied to the mover **container** (`runAsUser`/`runAsGroup`,\ncapabilities, seccomp, …). Merged field-wise over `moverDefaults.securityContext`\nand the hardened base (ADR-0004 §2) — set only the fields you want to change.", "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 `moverDefaults.ttlSecondsAfterFinished` — the\n`Job.spec.ttlSecondsAfterFinished` for this recipe's mover Jobs so finished\nbackup/restore Jobs self-GC. Recipe wins over the repo default; when neither\nis set a built-in default applies ([`DEFAULT_JOB_TTL_SECONDS`]). ADR-0005 §12.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "options": { "additionalProperties": false, "description": "kopia restore behavior (file deletion, permission/atomicity handling). ADR §4.6.", "nullable": true, "properties": { "enableFileDeletion": { "description": "Delete files in the target that are not present in the snapshot (make the\ntarget an exact mirror). Off by default — additive restore is the safe default.", "type": [ "boolean", "null" ] }, "ignorePermissionErrors": { "description": "Default true; surfaces a condition if any errors occurred. ADR §4.6.", "nullable": true, "type": [ "boolean", "null" ] }, "writeFilesAtomically": { "description": "Default true. ADR §4.6.", "nullable": true, "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "policy": { "additionalProperties": false, "description": "Missing-snapshot handling and wait timeout. ADR §4.6 (G7).", "nullable": true, "properties": { "onMissingSnapshot": { "description": "What to do when the resolved source matches no snapshot. Closed enum. ADR §4.6 (G7).\n\n```\nuse kopiur_api::restore::OnMissingSnapshot;\n\n// Fail-closed is the default so an explicit restore can't silently no-op.\nassert_eq!(OnMissingSnapshot::default(), OnMissingSnapshot::Fail);\nassert_eq!(serde_json::to_value(OnMissingSnapshot::Continue).unwrap(), \"Continue\");\n```", "enum": [ "Fail", "Continue" ], "nullable": true, "type": [ "string", "null" ] }, "waitTimeout": { "description": "How long to wait for the source snapshot to appear before giving up\n(Go-style duration string, e.g. `5m`).", "nullable": true, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "repository": { "additionalProperties": false, "description": "Derived from `source` when omitted; REQUIRED only with `source.identity`. ADR §3.6/§4.6.", "nullable": true, "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", "null" ] }, "source": { "additionalProperties": false, "description": "Exactly one source mode; webhook-enforced. ADR §3.6.", "oneOf": [ { "required": [ "snapshotRef" ] }, { "required": [ "fromPolicy" ] }, { "required": [ "identity" ] } ], "properties": { "fromPolicy": { "additionalProperties": false, "description": "A `SnapshotPolicy` CR — resolves via identity even with no `Snapshot` CR present\n(deploy-or-restore). Default `onMissingSnapshot: Continue`. ADR §4.6.", "properties": { "asOf": { "description": "Restore the newest snapshot at or before this RFC3339 timestamp (point-in-time).", "nullable": true, "type": [ "string", "null" ] }, "name": { "description": "Name of the `SnapshotPolicy` whose identity selects the snapshot.", "type": "string" }, "namespace": { "description": "Namespace of the `SnapshotPolicy`; absent = the `Restore`'s own namespace.", "nullable": true, "type": [ "string", "null" ] }, "offset": { "default": 0, "description": "0 = latest, 1 = previous, ... ADR §3.6.\n\nCarries a real OpenAPI `default: 0` (ADR-0005 §1): unconditional, so it\nmaterializes into the stored object / `kubectl explain` and GitOps stops\ndiff-thrashing. A bare `i64` (not `Option`) so the default is never dropped.", "format": "int64", "type": [ "integer", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "identity": { "additionalProperties": false, "description": "A raw kopia identity (foreign writers / aged-out catalog). Requires `spec.repository`.", "properties": { "asOf": { "description": "Restore the newest snapshot at or before this RFC3339 timestamp (point-in-time).", "nullable": true, "type": [ "string", "null" ] }, "hostname": { "description": "The kopia `hostname` to match.", "type": "string" }, "offset": { "description": "0 = latest, 1 = previous, ... mutually exclusive with `snapshotID`/`asOf` in practice.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] }, "snapshotID": { "description": "Pin an exact kopia snapshot by ID. Renamed to match the ADR wire shape\nexactly (`snapshotID`, capital `ID`).", "nullable": true, "type": [ "string", "null" ] }, "sourcePath": { "description": "The kopia source path to match; absent matches any path for the identity.", "nullable": true, "type": [ "string", "null" ] }, "username": { "description": "The kopia `username` to match.", "type": "string" } }, "required": [ "hostname", "username" ], "type": [ "object", "null" ] }, "snapshotRef": { "additionalProperties": false, "description": "A `Snapshot` CR (scheduled, manual, or discovered — all the same kind). Default mode.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "namespace": { "description": "Namespace of the referenced object; absent = same namespace as the referrer.", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": "object" }, "target": { "additionalProperties": false, "description": "Where to restore to — **required** (ADR-0005 §9): `pvc` (operator creates),\n`pvcRef` (existing PVC), or `populator: {}` (passive populator mode, claimed\nvia a PVC's `spec.dataSourceRef`). The former empty-`target` form is removed;\na `Restore` with no `target` is now invalid (deserialization fails).", "oneOf": [ { "required": [ "pvc" ] }, { "required": [ "pvcRef" ] }, { "required": [ "populator" ] } ], "properties": { "populator": { "description": "Passive populator mode: no workload target at provision time — the restore is\nclaimed by a PVC's `spec.dataSourceRef` (ADR-0005 §9). An (empty) sub-object so\nfuture populator knobs slot in without API breakage.", "type": [ "object", "null" ] }, "pvc": { "additionalProperties": false, "description": "Operator creates the PVC.", "properties": { "accessModes": { "description": "Access modes for the new PVC (e.g. `[\"ReadWriteOnce\"]`).", "items": { "type": "string" }, "type": [ "array", "null" ] }, "capacity": { "description": "Requested size of the new PVC (e.g. `100Gi`).", "nullable": true, "type": [ "string", "null" ] }, "name": { "description": "Name of the PVC to create.", "type": "string" }, "storageClassName": { "description": "StorageClass for the new PVC; absent uses the cluster default.", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] }, "pvcRef": { "additionalProperties": false, "description": "Write into an existing PVC.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "namespace": { "description": "Namespace of the referenced object; absent = same namespace as the referrer.", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": "object" } }, "required": [ "source", "target" ], "type": "object", "x-kubernetes-validations": [ { "message": "exactly one of target.pvc, target.pvcRef, target.populator", "rule": "[has(self.target.pvc), has(self.target.pvcRef), has(self.target.populator)].filter(x, x).size() == 1" } ] }, "status": { "additionalProperties": false, "description": "Observed state of a [`Restore`], written by the controller/mover. ADR §3.6 status.", "nullable": true, "properties": { "conditions": { "description": "Standard Kubernetes conditions carrying the human-readable status/reason.", "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" ] }, "failure": { "additionalProperties": false, "description": "Structured terminal-failure detail (kopia error class, stderr tail, retry\nhint), written by the mover before it exits non-zero. ADR §4.10.", "nullable": true, "properties": { "exitCode": { "description": "The process exit code, if one was reported.", "format": "int32", "nullable": true, "type": [ "integer", "null" ] }, "kopiaErrorClass": { "description": "kopia error class (e.g. `RepositoryUnavailable`, `AuthFailure`).", "type": "string" }, "message": { "description": "A short human-readable message: what failed, why, and how to fix it.", "type": "string" }, "retryRecommended": { "description": "Whether retrying the same operation unchanged could succeed.", "type": "boolean" }, "stderrTail": { "description": "The last lines of kopia's stderr, if any were captured (bounded by\n[`MAX_LOG_TAIL_BYTES`]).", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "kopiaErrorClass", "message", "retryRecommended" ], "type": [ "object", "null" ] }, "logTail": { "description": "The last lines of the run's output, written by the mover at the terminal\ntransition (success: the `Restore completed: snapshot \u003cid\u003e` line; failure:\nthe actionable error + kopia stderr tail). Capped at\n[`crate::common::MAX_LOG_TAIL_BYTES`]; full logs live in the Job pod.", "nullable": true, "type": [ "string", "null" ] }, "observedGeneration": { "description": "`metadata.generation` last reconciled, so stale status is detectable.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] }, "phase": { "description": "Lifecycle phase of a restore. Closed enum. ADR §3.6 status.", "enum": [ "Pending", "Resolving", "Restoring", "Completed", "Failed" ], "nullable": true, "type": [ "string", "null" ] }, "progress": { "additionalProperties": false, "description": "Bytes/files restored so far, patched periodically by the mover.", "nullable": true, "properties": { "bytesRestored": { "description": "Total bytes restored so far.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] }, "filesRestored": { "description": "Total files restored so far.", "format": "int64", "nullable": true, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "resolved": { "additionalProperties": false, "description": "Pinned at admission; never re-resolved. ADR §3.6/§4.6.", "nullable": true, "properties": { "identity": { "additionalProperties": false, "description": "The resolved kopia identity (`username@hostname:path`) of the snapshot.", "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" ] }, "kopiaSnapshotID": { "description": "The exact kopia snapshot manifest id the source resolved to. Pinned once;\nsubsequent reconciles restore THIS id even if newer snapshots appear, so a\nrestore never silently retargets (ADR §4.6). Matches\n`Snapshot.status.snapshot.kopiaSnapshotID`.", "nullable": true, "type": [ "string", "null" ] }, "pinnedAt": { "description": "Timestamp at which the source was pinned (RFC3339).", "nullable": true, "type": [ "string", "null" ] }, "repository": { "additionalProperties": false, "description": "The repository the snapshot lives in, resolved from the source.", "nullable": true, "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", "null" ] }, "snapshotRef": { "additionalProperties": false, "description": "The concrete `Snapshot` CR the source resolved to, when applicable.", "nullable": true, "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "namespace": { "description": "Namespace of the referenced object; absent = same namespace as the referrer.", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "sourceKind": { "description": "The pinned source kind (`RestoreSource::kind_str` — `SnapshotRef`/`FromPolicy`/\n`Identity`), set by the reconciler. Backs the `SOURCE` printer column so\n`kubectl get restores` shows where a restore reads from. ADR-0005 §3.", "nullable": true, "type": [ "string", "null" ] }, "target": { "additionalProperties": false, "description": "Resolved target details (the PVC written to / populator handshake).", "nullable": true, "properties": { "pvcPrime": { "description": "Populator handshake (passive / pvc-create modes). ADR §3.6.", "nullable": true, "type": [ "string", "null" ] }, "pvcRef": { "additionalProperties": false, "description": "The PVC actually written to (created or pre-existing).", "nullable": true, "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "namespace": { "description": "Namespace of the referenced object; absent = same namespace as the referrer.", "nullable": true, "type": [ "string", "null" ] } }, "required": [ "name" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "timing": { "additionalProperties": false, "description": "Start/end timestamps for the restore run.", "nullable": true, "properties": { "endTime": { "description": "When the restore reached a terminal phase (RFC3339).", "nullable": true, "type": [ "string", "null" ] }, "startTime": { "description": "When the mover began restoring (RFC3339).", "nullable": true, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] } }, "required": [ "spec" ], "title": "Restore", "type": "object" }