On Premise

This documentation describes how to perform the backup and restoration operations of a TraefikEE cluster for an on premise installation. For a general introduction of the backup and restore mechanism, we suggest reading the introduction first.

Creating a Backup

With traefikeectl

Configure traefikeectl

In order to perform this operation, you will need to use traefikeectl. To set it up, please refer to the manual installation guide.

Command

traefikeectl backup

Expected output

Successfully generated backup archive at: 2019-03-13T174230_traefikee-backup.tar

Note

If you need to, TraefikEE also supports creating zip archives for backup, with the --archivetype=zip option.

Note

If, somehow, the backup system fails to generate a valid backup, you can force the generation of a new one with the --force flag.

With traefikee

With a control-node running on the host you want to make a backup on, you can run from an user with access to the Traefikee Control API socket.

Command

traefikee backup --controlAPISocket="/path/to/socket.sock"

Then you can move the generated archive to a secure storage.

Note

The traefikee backup command has the same feature set than traefikeectl. For more informations, please refer to the traefikee CLI reference.

Restoring a Cluster

Restoring a cluster almost the exact same procedure as performing an on premise installation, the only difference takes place at the initialization step.

Instead of specifying the --licensekey option, enable the backup restoration by using the --archivepath option which tells traefikee to restore the cluster state from a given backup archive.

Sensitive data

Remember that the backup archive carries sensitive information. Make sure to use secure tools, like scp to move your backup from your storage to the bootstrap node machine.

Command

traefikee bootstrap \
    --hostname=bootstrap \
    --advertise=10.10.0.1:4242 \
    --listen=10.10.0.1:4242 \
    --timeout=300 \
    --controlNodes=3 \
    --api \
    --archivepath=./your-backup.tar

You can then resume the installation procedure at the get tokens step.