Backup & Restore
SecureLink provides tools to back up and restore system configuration, ensuring you can recover from failures or migrate between environments.
Backup
What's Included
A SecureLink backup contains the full system configuration:
- Tenant definitions and settings
- User accounts and role assignments
- Device registrations and edge configurations
- WireGuard tunnel configurations and peer lists
- ACL rules, NAT rules, and static routes
- System settings and preferences
- Feature flag states
- Edge peering configurations
What's NOT Included
The following data is not part of the backup:
- Metrics data (VictoriaMetrics time-series data)
- Log data (Loki log entries)
- Keycloak user credentials (passwords are managed by Keycloak separately)
- MQTT message history
- Edge runtime state (VPP interface counters, active sessions)
Scheduled Backups
Configure automatic backups on a recurring schedule:
| Schedule | Description |
|---|---|
| Daily | Runs once per day at the configured time |
| Weekly | Runs once per week on the configured day and time |
Scheduled backups are stored in the configured backup location with timestamped filenames. Configure retention policies to automatically clean up old backups.
Manual Backup
To create an immediate backup:
- Navigate to Settings > System > Backup & Restore
- Click Export Configuration
- The backup file is generated and downloaded to your browser
The exported file contains a complete snapshot of the current system configuration.
Restore
To restore from a backup:
- Navigate to Settings > System > Backup & Restore
- Click Restore Configuration
- Upload the backup file
- Review the summary of what will be restored
- Confirm the restore operation
Restoring a backup will overwrite the current configuration. Always create a fresh backup of the current state before performing a restore, so you can roll back if needed.
Restore operations should be performed during a maintenance window. Active edge connections may be disrupted during the restore process as configurations are reloaded. Coordinate with tenant administrators before proceeding.
Best Practices
- Schedule regular backups — daily backups are recommended for production environments
- Test restores periodically — verify that your backups are valid by restoring to a staging environment
- Back up before major changes — always create a manual backup before upgrading the platform, modifying system settings, or performing bulk tenant operations
- Store backups off-site — keep copies of backups in a separate location from the orchestrator