API Reference

apiVersion string

k8up.io/v1

kind string

Archive

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ArchiveSpec

apiVersion string

k8up.io/v1

kind string

ArchiveList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Archive array

container string

path string

accountNameSecretRef SecretKeySelector

accountKeySecretRef SecretKeySelector

bucket string

path string

accountIDSecretRef SecretKeySelector

accountKeySecretRef SecretKeySelector

repoPasswordSecretRef SecretKeySelector

RepoPasswordSecretRef references a secret key to look up the restic repository password

envFrom EnvFromSource array

EnvFrom adds all environment variables from a an external source to the Restic job.

local LocalSpec

s3 S3Spec

gcs GCSSpec

azure AzureSpec

swift SwiftSpec

b2 B2Spec

rest RestServerSpec

tlsOptions TLSOptions

volumeMounts VolumeMount

apiVersion string

k8up.io/v1

kind string

Backup

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec BackupSpec

apiVersion string

k8up.io/v1

kind string

BackupList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Backup array

backend Backend

Backend contains the restic repo where the job should backup to.

resources ResourceRequirements

Resources describes the compute resource requirements (cpu, memory, etc.)

podSecurityContext PodSecurityContext

PodSecurityContext describes the security context with which this action shall be executed.

podConfigRef LocalObjectReference

PodConfigRef describes the pod spec with wich this action shall be executed. It takes precedence over the Resources or PodSecurityContext field. It does not allow changing the image or the command of the resulting pod. This is for advanced use-cases only. Please only set this if you know what you’re doing.

volumes RunnableVolumeSpec

Volumes List of volumes that can be mounted by containers belonging to the pod.

activeDeadlineSeconds integer

ActiveDeadlineSeconds specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. Value must be positive integer if given.

keepJobs integer

KeepJobs amount of jobs to keep for later analysis.

Deprecated: Use FailedJobsHistoryLimit and SuccessfulJobsHistoryLimit respectively.

failedJobsHistoryLimit integer

FailedJobsHistoryLimit amount of failed jobs to keep for later analysis. KeepJobs is used property is not specified.

successfulJobsHistoryLimit integer

SuccessfulJobsHistoryLimit amount of successful jobs to keep for later analysis. KeepJobs is used property is not specified.

promURL string

PromURL sets a prometheus push URL where the backup container send metrics to

statsURL string

StatsURL sets an arbitrary URL where the restic container posts metrics and information about the snapshots to. This is in addition to the prometheus pushgateway.

tags string array

Tags is a list of arbitrary tags that get added to the backup via Restic’s tagging system

backend Backend

Backend contains the restic repo where the job should backup to.

resources ResourceRequirements

Resources describes the compute resource requirements (cpu, memory, etc.)

podSecurityContext PodSecurityContext

PodSecurityContext describes the security context with which this action shall be executed.

podConfigRef LocalObjectReference

PodConfigRef describes the pod spec with wich this action shall be executed. It takes precedence over the Resources or PodSecurityContext field. It does not allow changing the image or the command of the resulting pod. This is for advanced use-cases only. Please only set this if you know what you’re doing.

volumes RunnableVolumeSpec

Volumes List of volumes that can be mounted by containers belonging to the pod.

activeDeadlineSeconds integer

ActiveDeadlineSeconds specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. Value must be positive integer if given.

keepJobs integer

KeepJobs amount of jobs to keep for later analysis.

Deprecated: Use FailedJobsHistoryLimit and SuccessfulJobsHistoryLimit respectively.

failedJobsHistoryLimit integer

FailedJobsHistoryLimit amount of failed jobs to keep for later analysis. KeepJobs is used property is not specified.

successfulJobsHistoryLimit integer

SuccessfulJobsHistoryLimit amount of successful jobs to keep for later analysis. KeepJobs is used property is not specified.

promURL string

PromURL sets a prometheus push URL where the backup container send metrics to

statsURL string

StatsURL sets an arbitrary URL where the restic container posts metrics and information about the snapshots to. This is in addition to the prometheus pushgateway.

tags string array

Tags is a list of arbitrary tags that get added to the backup via Restic’s tagging system

apiVersion string

k8up.io/v1

kind string

Check

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec CheckSpec

apiVersion string

k8up.io/v1

kind string

CheckList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Check array

backend Backend

Backend contains the restic repo where the job should backup to.

resources ResourceRequirements

Resources describes the compute resource requirements (cpu, memory, etc.)

podSecurityContext PodSecurityContext

PodSecurityContext describes the security context with which this action shall be executed.

podConfigRef LocalObjectReference

PodConfigRef describes the pod spec with wich this action shall be executed. It takes precedence over the Resources or PodSecurityContext field. It does not allow changing the image or the command of the resulting pod. This is for advanced use-cases only. Please only set this if you know what you’re doing.

volumes RunnableVolumeSpec

Volumes List of volumes that can be mounted by containers belonging to the pod.

activeDeadlineSeconds integer

ActiveDeadlineSeconds specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. Value must be positive integer if given.

promURL string

PromURL sets a prometheus push URL where the backup container send metrics to

keepJobs integer

KeepJobs amount of jobs to keep for later analysis.

Deprecated: Use FailedJobsHistoryLimit and SuccessfulJobsHistoryLimit respectively.

failedJobsHistoryLimit integer

FailedJobsHistoryLimit amount of failed jobs to keep for later analysis. KeepJobs is used property is not specified.

successfulJobsHistoryLimit integer

SuccessfulJobsHistoryLimit amount of successful jobs to keep for later analysis. KeepJobs is used property is not specified.

backend Backend

Backend contains the restic repo where the job should backup to.

resources ResourceRequirements

Resources describes the compute resource requirements (cpu, memory, etc.)

podSecurityContext PodSecurityContext

PodSecurityContext describes the security context with which this action shall be executed.

podConfigRef LocalObjectReference

PodConfigRef describes the pod spec with wich this action shall be executed. It takes precedence over the Resources or PodSecurityContext field. It does not allow changing the image or the command of the resulting pod. This is for advanced use-cases only. Please only set this if you know what you’re doing.

volumes RunnableVolumeSpec

Volumes List of volumes that can be mounted by containers belonging to the pod.

activeDeadlineSeconds integer

ActiveDeadlineSeconds specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. Value must be positive integer if given.

promURL string

PromURL sets a prometheus push URL where the backup container send metrics to

keepJobs integer

KeepJobs amount of jobs to keep for later analysis.

Deprecated: Use FailedJobsHistoryLimit and SuccessfulJobsHistoryLimit respectively.

failedJobsHistoryLimit integer

FailedJobsHistoryLimit amount of failed jobs to keep for later analysis. KeepJobs is used property is not specified.

successfulJobsHistoryLimit integer

SuccessfulJobsHistoryLimit amount of successful jobs to keep for later analysis. KeepJobs is used property is not specified.

jobType JobType

generatedSchedule ScheduleDefinition

key string

value string

bucket string

projectIDSecretRef SecretKeySelector

accessTokenSecretRef SecretKeySelector

mountPath string

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec PodSpec

Specification of the desired behavior of the pod. More info: git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

apiVersion string

k8up.io/v1

kind string

PodConfig

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec PodConfigSpec

apiVersion string

k8up.io/v1

kind string

PodConfigList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items PodConfig array

template PodTemplateSpec

apiVersion string

k8up.io/v1

kind string

PreBackupPod

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec PreBackupPodSpec

apiVersion string

k8up.io/v1

kind string

PreBackupPodList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items PreBackupPod array

backupCommand string

BackupCommand will be added to the backupcommand annotation on the pod.

fileExtension string

pod Pod

apiVersion string

k8up.io/v1

kind string

Prune

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec PruneSpec

apiVersion string

k8up.io/v1

kind string

PruneList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Prune array

backend Backend

Backend contains the restic repo where the job should backup to.

resources ResourceRequirements

Resources describes the compute resource requirements (cpu, memory, etc.)

podSecurityContext PodSecurityContext

PodSecurityContext describes the security context with which this action shall be executed.

podConfigRef LocalObjectReference

PodConfigRef describes the pod spec with wich this action shall be executed. It takes precedence over the Resources or PodSecurityContext field. It does not allow changing the image or the command of the resulting pod. This is for advanced use-cases only. Please only set this if you know what you’re doing.

volumes RunnableVolumeSpec

Volumes List of volumes that can be mounted by containers belonging to the pod.

activeDeadlineSeconds integer

ActiveDeadlineSeconds specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. Value must be positive integer if given.

retention RetentionPolicy

Retention sets how many backups should be kept after a forget and prune

keepJobs integer

KeepJobs amount of jobs to keep for later analysis.

Deprecated: Use FailedJobsHistoryLimit and SuccessfulJobsHistoryLimit respectively.

failedJobsHistoryLimit integer

FailedJobsHistoryLimit amount of failed jobs to keep for later analysis. KeepJobs is used property is not specified.

successfulJobsHistoryLimit integer

SuccessfulJobsHistoryLimit amount of successful jobs to keep for later analysis. KeepJobs is used property is not specified.

backend Backend

Backend contains the restic repo where the job should backup to.

resources ResourceRequirements

Resources describes the compute resource requirements (cpu, memory, etc.)

podSecurityContext PodSecurityContext

PodSecurityContext describes the security context with which this action shall be executed.

podConfigRef LocalObjectReference

PodConfigRef describes the pod spec with wich this action shall be executed. It takes precedence over the Resources or PodSecurityContext field. It does not allow changing the image or the command of the resulting pod. This is for advanced use-cases only. Please only set this if you know what you’re doing.

volumes RunnableVolumeSpec

Volumes List of volumes that can be mounted by containers belonging to the pod.

activeDeadlineSeconds integer

ActiveDeadlineSeconds specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. Value must be positive integer if given.

retention RetentionPolicy

Retention sets how many backups should be kept after a forget and prune

keepJobs integer

KeepJobs amount of jobs to keep for later analysis.

Deprecated: Use FailedJobsHistoryLimit and SuccessfulJobsHistoryLimit respectively.

failedJobsHistoryLimit integer

FailedJobsHistoryLimit amount of failed jobs to keep for later analysis. KeepJobs is used property is not specified.

successfulJobsHistoryLimit integer

SuccessfulJobsHistoryLimit amount of successful jobs to keep for later analysis. KeepJobs is used property is not specified.

url string

userSecretRef SecretKeySelector

passwordSecretReg SecretKeySelector

apiVersion string

k8up.io/v1

kind string

Restore

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec RestoreSpec

apiVersion string

k8up.io/v1

kind string

RestoreList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Restore array

s3 S3Spec

folder FolderRestore

tlsOptions TLSOptions

volumeMounts VolumeMount

backend Backend

Backend contains the restic repo where the job should backup to.

resources ResourceRequirements

Resources describes the compute resource requirements (cpu, memory, etc.)

podSecurityContext PodSecurityContext

PodSecurityContext describes the security context with which this action shall be executed.

podConfigRef LocalObjectReference

PodConfigRef describes the pod spec with wich this action shall be executed. It takes precedence over the Resources or PodSecurityContext field. It does not allow changing the image or the command of the resulting pod. This is for advanced use-cases only. Please only set this if you know what you’re doing.

volumes RunnableVolumeSpec

Volumes List of volumes that can be mounted by containers belonging to the pod.

activeDeadlineSeconds integer

ActiveDeadlineSeconds specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. Value must be positive integer if given.

restoreMethod RestoreMethod

restoreFilter string

snapshot string

keepJobs integer

KeepJobs amount of jobs to keep for later analysis.

Deprecated: Use FailedJobsHistoryLimit and SuccessfulJobsHistoryLimit respectively.

failedJobsHistoryLimit integer

FailedJobsHistoryLimit amount of failed jobs to keep for later analysis. KeepJobs is used property is not specified.

successfulJobsHistoryLimit integer

SuccessfulJobsHistoryLimit amount of successful jobs to keep for later analysis. KeepJobs is used property is not specified.

tags string array

Tags is a list of arbitrary tags that get added to the backup via Restic’s tagging system

backend Backend

Backend contains the restic repo where the job should backup to.

resources ResourceRequirements

Resources describes the compute resource requirements (cpu, memory, etc.)

podSecurityContext PodSecurityContext

PodSecurityContext describes the security context with which this action shall be executed.

podConfigRef LocalObjectReference

PodConfigRef describes the pod spec with wich this action shall be executed. It takes precedence over the Resources or PodSecurityContext field. It does not allow changing the image or the command of the resulting pod. This is for advanced use-cases only. Please only set this if you know what you’re doing.

volumes RunnableVolumeSpec

Volumes List of volumes that can be mounted by containers belonging to the pod.

activeDeadlineSeconds integer

ActiveDeadlineSeconds specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. Value must be positive integer if given.

restoreMethod RestoreMethod

restoreFilter string

snapshot string

keepJobs integer

KeepJobs amount of jobs to keep for later analysis.

Deprecated: Use FailedJobsHistoryLimit and SuccessfulJobsHistoryLimit respectively.

failedJobsHistoryLimit integer

FailedJobsHistoryLimit amount of failed jobs to keep for later analysis. KeepJobs is used property is not specified.

successfulJobsHistoryLimit integer

SuccessfulJobsHistoryLimit amount of successful jobs to keep for later analysis. KeepJobs is used property is not specified.

tags string array

Tags is a list of arbitrary tags that get added to the backup via Restic’s tagging system

keepLast integer

keepHourly integer

keepDaily integer

keepWeekly integer

keepMonthly integer

keepYearly integer

keepTags string array

tags string array

Tags is a filter on what tags the policy should be applied DO NOT CONFUSE THIS WITH KeepTags OR YOU’LL have a bad time

hostnames string array

Hostnames is a filter on what hostnames the policy should be applied

backend Backend

Backend contains the restic repo where the job should backup to.

resources ResourceRequirements

Resources describes the compute resource requirements (cpu, memory, etc.)

podSecurityContext PodSecurityContext

PodSecurityContext describes the security context with which this action shall be executed.

podConfigRef LocalObjectReference

PodConfigRef describes the pod spec with wich this action shall be executed. It takes precedence over the Resources or PodSecurityContext field. It does not allow changing the image or the command of the resulting pod. This is for advanced use-cases only. Please only set this if you know what you’re doing.

volumes RunnableVolumeSpec

Volumes List of volumes that can be mounted by containers belonging to the pod.

activeDeadlineSeconds integer

ActiveDeadlineSeconds specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it. Value must be positive integer if given.

name string

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

persistentVolumeClaim PersistentVolumeClaimVolumeSource

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

secret SecretVolumeSource

secret represents a secret that should populate this volume. More info: kubernetes.io/docs/concepts/storage/volumes#secret

configMap ConfigMapVolumeSource

configMap represents a configMap that should populate this volume

endpoint string

bucket string

accessKeyIDSecretRef SecretKeySelector

secretAccessKeySecretRef SecretKeySelector

apiVersion string

k8up.io/v1

kind string

Schedule

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ScheduleSpec

schedule ScheduleDefinition

concurrentRunsAllowed boolean

apiVersion string

k8up.io/v1

kind string

ScheduleList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Schedule array

restore RestoreSchedule

backup BackupSchedule

archive ArchiveSchedule

check CheckSchedule

prune PruneSchedule

backend Backend

keepJobs integer

KeepJobs amount of jobs to keep for later analysis.

Deprecated: Use FailedJobsHistoryLimit and SuccessfulJobsHistoryLimit respectively.

failedJobsHistoryLimit integer

FailedJobsHistoryLimit amount of failed jobs to keep for later analysis. KeepJobs is used property is not specified.

successfulJobsHistoryLimit integer

SuccessfulJobsHistoryLimit amount of successful jobs to keep for later analysis. KeepJobs is used property is not specified.

resourceRequirementsTemplate ResourceRequirements

ResourceRequirementsTemplate describes the compute resource requirements (cpu, memory, etc.)

podSecurityContext PodSecurityContext

PodSecurityContext describes the security context with which actions (such as backups) shall be executed.

podConfigRef LocalObjectReference

PodConfigRef will apply the given template to all job definitions in this Schedule. It can be overriden for specific jobs if necessary.

apiVersion string

k8up.io/v1

kind string

Snapshot

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec SnapshotSpec

apiVersion string

k8up.io/v1

kind string

SnapshotList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Snapshot array

id string

date Time

paths string

repository string

container string

path string

caCert string

clientCert string

clientKey string