Backup and Restore¶
If there is at least one controller with its state remaining in a cluster, it's possible to recover it by following the disaster recovery procedure. Restoring backups can be used when disaster recovery is not an option.
Backing up a TraefikEE Cluster¶
TraefikEE backups are copies of the current state of a cluster, which includes:
- Deployed certificates
- The ACME account being used to get Let's Encrypt certificates if enabled
- The current deployed configuration
- Configured entry-points
- Enabled configuration providers
Those backups are saved as archives, which can be either
Backups can contain sensitive information, so they should be stored securely.
Backup frequently and automatically
We strongly recommend backing up TraefikEE clusters automatically on a daily basis.
Backup storage is important
Make sure to use fault tolerant systems to store TraefikEE backups, and to setup frequent automatic backups.
Creating a Backup¶
To perform a backup, use the
teectl backup command that connects
to the cluster, collects the backup archive securely and writes it on the local filesystem.
Running cluster backup...ok ✔ Successfully generated backup archive traefikee-backup.tar
TraefikEE also supports creating
zip archives for backup, with the
Restoring a Backup¶
teectl restore can restore a backup into a running cluster
teectl restore --backup=./your-backup.tar
To avoid downtime on a unavailable cluster, we recommend the following steps:
- Do not stop a running cluster (if it still has running proxy nodes, it can serve traffic).
- Install a new TraefikEE cluster and restore a backup, side by side with the current.
- Redirect traffic to the new installation when it is ready.
- Tear down the old unavailable cluster.