=======
Backups
=======

Eyrie supports automated and manual backups for deployments. Backups are stored
in S3-compatible object storage provisioned through a cloud provider.

Backup Schedules
================

Each deployment can have one or more **backup schedules**:

- **daily_triggered** — a backup triggered once per day by the Eyrie cron.
- **cron_full** — a full backup on a custom cron expression.

Create a schedule from the deployment detail page under the **Backups** tab.

.. image:: /static/img/backup_list.png
   :alt: TODO — screenshot of the backup list

Manual Backup
=============

Click **Backup Now** on a deployment to trigger a one-time backup. The backup
job appears in the job list with ``backup_type = manual``.

Backup Job Lifecycle
====================

A backup runs as a Deployment Job (see :doc:`/principals/jobs`):

1. Job is **scheduled**.
2. The backup Deployment Book (``deployment_backup_book_id``) executes.
3. The database dump and filestore are compressed and uploaded to the
   destination S3 bucket (configured on the scope's
   ``backup_dest_datasource_id``).
4. Job reaches **done** state.

Downloading Backups
===================

From the backup job list, click **Download** to generate a pre-signed S3 URL.
The download link is valid for a limited time.

Restoring a Backup
==================

1. Navigate to the target deployment.
2. Click **Restore**.
3. Select the backup job to restore from.
4. Eyrie runs the restore Deployment Book (``deployment_restore_book_id``) which
   downloads the backup, loads the database, and restores the filestore.

.. image:: /static/img/backup_restore_dialog.png
   :alt: TODO — screenshot of the restore dialog