Backup Longhorn System
Longhorn system backup creates a resource bundle and uploads it to the remote backup target.
It includes below resources associating with the Longhorn system:
Warning: Longhorn does not backup
BackingImages. We will improve this part in the future. See Restore Longhorn System - Prerequisite for restoring volumes created with the backing image.
Note: Longhorn does not backup
Nodes. The Longhorn manager on the target cluster is responsible for creating its own Longhorn
Note: Longhorn system backup bundle only includes resources operated by Longhorn.
Here is an example of a cluster workload with a bare
Podworkload. The system backup will collect the
Volume. The system backup will exclude the
Podduring system backup resource collection.
You can create a Longhorn system backup using the Longhorn UI. Or with the
Set the backup target. Longhorn saves the system backups to the remote backup store. You will see an error during creation when the backup target is unset.
Note: Unsetting the backup target clears the existing
SystemBackupcustom resource. Longhorn syncs to the remote backup store after setting the backup target. Another cluster can also sync to the same list of system backups when the backup target is the same.
Create a backup for all volumes (optional).
Note: Longhorn system restores volume with the latest backup. The system backup does not trigger volume backup. We suggest updating all volumes’ last backup. Taking volume backups ensures the data is up-to-date with the system backup.
System Backuppage in the
Namefor the system backup.
kubectl createto create a Longhorn
apiVersion: longhorn.io/v1beta2 kind: SystemBackup metadata: name: demo namespace: longhorn-system
> kubectl -n longhorn-system get systembackup NAME VERSION STATE CREATED demo v1.4.0 Ready 2022-11-24T04:23:24Z
You can delete the Longhorn system backup in the remote backup target using the Longhorn UI. Or with the
Go to the
System Backup page in the
Setting drop-down list.
Delete a single system backup in the
Operation drop-down menu next to the system backup. Or delete in batch with the
Note: Deleting the system backup will also make a deletion in the backup store.
kubectl deleteto delete a Longhorn
> kubectl -n longhorn-system get systembackup NAME VERSION STATE CREATED demo v1.4.0 Ready 2022-11-24T04:23:24Z > kubectl -n longhorn-system delete systembackup/demo systembackup.longhorn.io "demo" deleted
Available since v1.4.0
© 2019-2023 Longhorn Authors | Documentation Distributed under CC-BY-4.0
© 2023 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.