7.1. Requirements for backup and restore

This documentation uses the third-party open source application Velero for backup and restore. It provides tools for backing up and restoring Kubernetes cluster resources and persistent volumes. The server component of Velero runs in your Kubernetes cluster in a dedicated namespace. The command-line client controls the server component and runs locally.

Before you can create a backup and a restore, you must ensure to meet the following requirements:

• Requirements for the backup tool:

  1. You select the backup tool version and plugins that are compatible with the version of your Kubernetes cluster.

  2. You have an S3-compatible object storage, and the storage provider is compatible with the selected backup.

  3. You have credentials to write to the object storage and it has an appropriate bucket.

  4. Your cluster and your controlling client must be able to reach the object storage through proper networking and DNS resolution.

  5. For Velero: You have installed the command-line client on a local machine, and the binary is in your path.

  Note

  You may use a backup tool of your choice that’s capable of the similar functionality as described with Velero in this documentation.

• Requirements for the storage target: The target locates outside the Kubernetes cluster where you deployed Nubus, to allow for recovery in case the entire cluster fails.

• Requirements for the Kubernetes cluster:

  1. Your cluster has Container Storage Support (CSI) enabled to allow CSI-backed snapshots.

  2. Your cluster supports volume snapshots and you have configured VolumeSnapshotClasses.

Important

You need to run the backups for external services, such as the database, at the same time as the backup for Nubus.

See also

For more information about Velero, see the following resources:

• Velero Website

• Velero documentation

• Velero compatibility matrix

• Velero supported storage providers

• Container Storage Interface Snapshot Support in Velero