Object Specifications Reference

The K8up operator includes various CRDs which get added to the cluster. Here We’ll explain them in more detail.

Schedule

With the schedule CRD it’s possible to put all other CRDs on a schedule.

apiVersion: backup.appuio.ch/v1alpha1
kind: Schedule
metadata:
  name: schedule-test
spec:
  backend:
    repoPasswordSecretRef:
      name: backup-repo
      key: password
    s3:
      endpoint: http://10.144.1.224:9000
      bucket: k8up
      accessKeyIDSecretRef:
        name: backup-credentials
        key: username
      secretAccessKeySecretRef:
        name: backup-credentials
        key: password
  archive:
    schedule: '0 * * * *'
    restoreMethod:
      s3:
        endpoint: http://10.144.1.224:9000
        bucket: restoremini
        accessKeyIDSecretRef:
          name: backup-credentials
          key: username
        secretAccessKeySecretRef:
          name: backup-credentials
          key: password
  backup:
    schedule: '* * * * *'
    keepJobs: 4
    promURL: http://10.144.1.224:9000
  check:
    schedule: '*/5 * * * *'
    promURL: http://10.144.1.224:9000
  prune:
    schedule: '*/2 * * * *'
    retention:
      keepLast: 5
      keepDaily: 14
yaml

Settings

  • archive: see archive for further explaination

  • backend: see back-end for further explanaition

  • check: see check for further explanaition

  • prune: see prune for further explanaition

Restore

It’s now possible to define various restore jobs. Currently these kinds of restores are supported:

  • To a PVC

  • To S3 as tar.gz

Example for a restore to a PVC:

apiVersion: backup.appuio.ch/v1alpha1
kind: Restore
metadata:
  name: restore-test

spec:
  tags:
    - prod
    - archive
  restoreMethod:
    folder:
      claimName: restore

  backend:
    repoPasswordSecretRef:
      name: backup-repo
      key: password
    s3:
      endpoint: http://10.144.1.224:9000
      bucket: k8up
      accessKeyIDSecretRef:
        name: backup-credentials
        key: username
      secretAccessKeySecretRef:
        name: backup-credentials
        key: password
yaml

This will restore the latest snapshot from 10.144.1.224:9000 to the PVC with the name restore.

Settings

  • backend: see back-end for further explanation

  • restoreMethod: is either s3 or folder. For s3 please see backend for folder you just need to provide a valid claim name as shown in the example above

  • restoreFiler: a filter passed to the underlying Restic, which will be used. Please consult the Restic docs for valid path filters.

  • snapshot: valid snapshot ID that should get restored. If not provided will restore the latest one.

  • keepJobs: amount of jobs that should be left after cleanup, for example how many job/pod objects should be left after they finished. Defaults to 6. Only applicable when used within a schedule.

  • tags: list of tags to be considered for the restore. They’re ignored if a snapshot ID is provided.

Archive

The archive CRD will take the latest snapshots from each namespace/project in the repository. Thus you should only run one schedule per repository for archival as there’s a chance that you’ll archive snapshots more than once.

apiVersion: backup.appuio.ch/v1alpha1
kind: Archive
metadata:
  name: archive-test
spec:
  repoPasswordSecretRef:
    name: backup-repo
    key: password
  restoreMethod:
    s3:
      endpoint: http://10.144.1.224:9000
      bucket: restoremini
      accessKeyIDSecretRef:
        name: backup-credentials
        key: username
      secretAccessKeySecretRef:
        name: backup-credentials
        key: password
  backend:
    s3:
      endpoint: http://10.144.1.224:9000
      bucket: k8up
      accessKeyIDSecretRef:
        name: backup-credentials
        key: username
      secretAccessKeySecretRef:
        name: backup-credentials
        key: password
yaml

Archive is just a wrapper for restore, intended for use with the schedule. Will restore all namespaces on a given back-end to a given s3 location.

Backup

This will trigger a single backup.

apiVersion: backup.appuio.ch/v1alpha1
kind: Backup
metadata:
  name: k8up-test
spec:
  tags:
    - prod
    - archive
    - important
  keepJobs: 4
  backend:
    repoPasswordSecretRef:
      name: backup-repo
      key: password
    s3:
      endpoint: http://10.144.1.224:9000
      bucket: k8up
      accessKeyIDSecretRef:
        name: backup-credentials
        key: username
      secretAccessKeySecretRef:
        name: backup-credentials
        key: password
  promURL: http://10.144.1.224:9000
yaml

Settings

  • backend: see back-end

  • keepJobs: amount of jobs that should be left after cleanup, for example how many job/pod objects should be left after they finished. Defaults to 6. Only applicable when used within a schedule.

  • promURL: sends backup statistics to this Prometheus pushgateway while the backups are running.

  • statsURL: will send a JSON webhook containing backup information information to this endpoint. Can be used to gather a list with available backups.

  • tags: list of tags to be added to the backup. Can be used in restores and archives again.

Check

This will trigger a single check run on the repository.

apiVersion: backup.appuio.ch/v1alpha1
kind: Check
metadata:
  name: check-test
spec:
  backend:
    repoPasswordSecretRef:
      name: backup-repo
      key: password
    s3:
      endpoint: http://10.144.1.224:9000
      bucket: k8up
      accessKeyIDSecretRef:
        name: backup-credentials
        key: username
      secretAccessKeySecretRef:
        name: backup-credentials
        key: password
  promURL: http://10.144.1.224:9000
yaml

Settings

  • statsURL: will send a JSON webhook containing check information information to this endpoint.

  • backend: see back-end

  • keepJobs: amount of jobs that should be left after cleanup, for example how many job/pod objects should be left after they finished. Defaults to 6. Only applicable when used within a schedule.

Prune

This will trigger a single prune run, and delete the snapshots according to the defined retention rules. This one needs to run exclusively on the repository. No other jobs must run on the same repository while this one is still running. The operator ensures that the prune will run exclusively on the repository when run on a schedule. If manually triggering a prune the wrestic locking will kick in and prevent it from damaging the repository. It will also fail the whole pod in that case.

apiVersion: backup.appuio.ch/v1alpha1
kind: Prune
metadata:
  name: prune-test
spec:
  retention:
    keepLast: 5
    keepDaily: 14
  backend:
    repoPasswordSecretRef:
      name: backup-repo
      key: password
    s3:
      endpoint: http://10.144.1.224:9000
      bucket: k8up
      accessKeyIDSecretRef:
        name: backup-credentials
        key: username
      secretAccessKeySecretRef:
        name: backup-credentials
        key: password
yaml

Settings

  • retention: see retention

  • backend: see back-end

  • keepJobs: amount of jobs that should be left after cleanup, for example how many job/pod objects should be left after they finished. Defaults to 6. Only applicable when used within a schedule.

Retention

Retention is part of the prune object. It defines how the retention of a given back-end should look like. Most upstream Restic rules are support except for the once working with labels. Please see the upstream Restic docs for more info.

retention:
  keepLast: 5
  keepDaily: 14
yaml

List of available settings:

  • keepLast

  • keepHourly

  • keepDaily

  • keepWeekly

  • keepMonthly

  • keepYearly

  • keepTags

Please don’t confuse tags and keepTags here. If you specify keepTags it will remove all snapshots that don’t have the tag! If you use the tags array it will apply the retention only to snapshots with that specific tag. That way there can be multiple backup sets on a repository, for example prod and dev.

Back-end

Currently only S3 is supported as a back-end.

backend:
  repoPasswordSecretRef:
    name: backup-repo
    key: password
  s3:
    endpoint: http://10.144.1.224:9000
    bucket: k8up
    accessKeyIDSecretRef:
      name: backup-credentials
      key: username
    secretAccessKeySecretRef:
      name: backup-credentials
      key: password
yaml

Settings

  • repoPasswordSecretRef: kubernetes secret reference containing the Restic encryption key. Attention: don’t lose this key or you won’t be able to access your backup data again! So keep a copy of that somewhere off the actual cluster.

  • s3: see s3

S3

This object is part of back-end.

Settings: * endpoint: http(s) endpoint of the S3 instance * bucket: name of the bucket that should be used * accessKeyIDSecretRef: Kubernetes secret reference containing the the Access Key ID * secretAccessKeySecretRef: Kubernetes secret reference containing the Secret Access Key

PreBackup

PreBackup are objects that live in the namespace that should be backed up. They’re completely optional though. Their main goal is to provide some sort of pre backup scripts. They can be used for various use cases though, see PreBackup pods.

apiVersion: backup.appuio.ch/v1alpha1
kind: PreBackupPod
metadata:
  name: mysqldump
spec:
  backupCommand: mysqldump -u$USER -p$PW -h $DB_HOST --all-databases
  pod:
    spec:
      containers:
        - env:
            - name: USER
              value: dumper
            - name: PW
              value: topsecret
            - name: DB_HOST
              value: mariadb.example.com
          image: mariadb
          command:
            - 'sleep'
            - '9999999'
          imagePullPolicy: Always
          name: mysqldump
yaml

Settings

  • backupCommand: command that should get executed within the pod. Attention the command should output its data to stdout so that wrestic can pick it up correctly

  • fileExtension: as this leverages the stdin backup capabilities of Restic it will generate a virtual file. That file name is by default just the name of the PreBackup pod. But to make restores easier you can define a file extension, that gets appended to the filename. For example: ".sql" for a mysql dump

  • pod: pod is default podTemplateSpec of Kubernetes: Kubernetes docs