Backup and restore
What the database backup and the full backup contain, how to schedule and restore them, and what you have to keep separately.
What is backed up
EasyUC has two kinds of backup. The database backup covers the MariaDB database with all configuration and business data stored in it, as a compressed physical backup. The application keeps running while it is created.
The full backup is an encrypted archive (.eucbak). It contains the database, the application's files such as music on hold, announcements, reports and CDR files, the call history from Elasticsearch and the configuration of the installation. The application is suspended during capture.
What neither backup contains is listed under Not included in the backup.
Creating a backup manually
You start a full backup on the Manager's backup page with Vollsicherung erstellen. At least one backup key must be stored. During capture the interfaces and CURRI are unavailable and active Teams calls are disconnected. Create full backups in a maintenance window for that reason. If the full backup is not enabled in your installation, the backup page says so.
A database backup is created as follows. The system must be in Ready state.
-
Choose Create backup in the Manager.
-
Wait until the backup appears in the list.
-
Download it if needed.
Scheduled backups
You set up automatic backups in the Manager with a schedule. You choose the kind, database backup or full backup, and the rhythm:
- hourly, daily, weekly or monthly
- a cron expression with time zone
- for full backups also a maintenance window. The Manager skips runs that would start outside the window.
Note
The default is daily at 02:30 in the Europe/Berlin time zone. Scheduled backups also require Ready state. The Manager shows the run history.
Storage locations and retention
The database backup is stored locally on a backup volume in the cluster. It has room for one current backup. Full backups are stored on a volume of their own; by default the newest one is kept there. Optionally EasyUC also transfers backups to a server:
| Protocol | Authentication |
|---|---|
| SFTP | Password or key. For full backups the server's host key must be confirmed. |
| FTPS | FTP with TLS |
| FTP | unencrypted |
Tip
On the remote target, retention applies separately per kind: by default the last 7 database backups and the last 2 full backups, with the value 0 all of them. There is no retention by age. If you want to keep older states, you need a remote target.
Encryption
Warning
The database backup is not encrypted. Transfer it via SFTP or FTPS and protect the target server. The full backup is encrypted with AES-256-GCM. Only someone who holds the private key for one of the stored backup keys can decrypt it. Keep the private key separate from the appliance and store a second key if possible. If all private keys are lost, the archive can no longer be read, not by us either.
Restoring
-
Select the database backup in the Manager.
-
Choose Wiederherstellen and confirm.
-
The restore runs in the background and the Manager shows the individual steps. It rebuilds the database from the backup and initialises the application.
-
The licence of your installation is kept. It is not taken from the backup.
Important
The database is recreated from the backup. Changes made after the backup was taken are no longer present afterwards.
External backup file: upload a file in .xb or .xb.bz2 format in the Manager before restoring. This requires that a local backup has been created on the system at least once.
Full backup on the same installation: the restore wizard in the Manager guides you through archive, private key and options. Before the start it checks the archive without changing anything. You restore everything or only the database. If you choose a current full backup as rollback archive, a failed run can be rolled back.
New appliance (disaster recovery): on a freshly installed appliance without an EasyUC instance, the disaster recovery wizard rebuilds the installation from a full backup. Take the old installation out of service first or disconnect it from CUCM and Teams.
Licence: the licence is never taken from a backup. On the same installation the existing licence stays in place. A new appliance needs a licence of its own. If it has none, it runs once for 7 days with a restore licence after the restore.
Not included in the backup
The database backup contains only the database. Files such as music on hold, announcements, reports and CDR files and the call history from Elasticsearch are only covered by the full backup. Neither backup contains:
- the licence
- the identity keys of the appliance. After a restore on a new appliance all users log in again.
- the backup keys. After a disaster recovery you store them again.
- the Manager's two-factor setup
- the K3s cluster identity and operating system files
Important
Keep the licence file, the private backup keys and your installation data separate from the system.
Related safety mechanisms
- Before every EasyUC update the Manager backs up the database itself. This backup is used for the reset to the previous version, see Updates.
- Before a factory reset the Manager takes a database backup and, if a backup key is stored, by default a full backup. You choose whether everything is reset or the user accounts are kept.
- Before the IP address or hostname is changed, an etcd snapshot is taken automatically.
- Before every update we also recommend your own full backup and a VM snapshot, see Updates.