Backup and Restore

Backups

Backups are triggered directly via the management console or via the CLI. The backup creates a complete snapshot of the environment. It includes all persistent data from all running services (MySQL, SOLR,...) and any files stored on the mounted volumes.

You need to have the "admin" role in order to create a backup of an environment.

Backups on Platform.sh Professional are retained for at least 7 days. They will be purged between 7 days and 6 months, at Platform.sh's discretion. Please see the data retention page for more information.

note

We advise you to make backups of your live environment before merging an environment to the live environment, or each time you increase the storage space of your services.

Using the CLI:

$ platform backup:create

Please be aware that triggering a backup will cause a momentary pause in site availability so that all requests can complete, allowing the backup to be taken against a known consistent state. The total interruption is usually only 15 to 30 seconds and any requests during that time are held temporarily, not dropped.

Restore

You will see the backup in the activity feed of your environment in the Platform.sh management console. You can trigger the restore by clicking on the restore link. You can also restore the backup to a different environment using the CLI.

You can list existing backups with the CLI as follows:

$ platform backups

Finding backups for the environment master
+---------------------+------------+----------------------+
| Created             | % Complete | Backup name          |
+---------------------+------------+----------------------+
| 2015-06-19 17:11:42 | 100        | 2ca4d90639f706283fee |
| 2015-05-28 15:05:42 | 100        | 1a1fbcb9943849706ee6 |
| 2015-05-21 14:38:40 | 100        | 7dbdcdb16f41f9e1c061 |
| 2015-05-20 15:29:58 | 100        | 4997900d2804d5b2fc39 |
| 2015-05-20 13:31:57 | 100        | c1f2c976263bec03a10e |
| 2015-05-19 14:51:18 | 100        | 71051a8fe6ef78bca0eb |

You can then restore a specific backup with the CLI as follows:

$ platform backup:restore 2ca4d90639f706283fee

Or even restore the backup to a different branch with the CLI as follows:

$ platform backup:restore --target=RESTORE_BRANCH 2ca4d90639f706283fee

For this to work, it's important to act on the active branch on which the backup was taken. Restoring a backup from develop when working on the staging branch is impossible. Switch to the acting branch and set your --target as above snippet mentions.

If no branch already exists, you can specify the parent of the branch that will be created to restore your backup to as follows:

$ platform backup:restore --branch-from=PARENT_BRANCH 2ca4d90639f706283fee

note You need "admin" role to restore your environment from a backup.

Be aware that the older US and EU regions do not support restoring backups to different environments. If your project is on one of the older regions you may file a support ticket to ask that a backup be restored to a different environment for you, or migrate your project to one of the new regions that supports this feature.

Backups and downtime

A backup does cause a momentary pause in service. We recommend running during non-peak hours for your site.

Automated backups

Backups are not triggered automatically on Platform.sh Professional.

Backups may be triggered by calling the CLI from an automated system such as Jenkins or another CI service, or by installing the CLI tool into your application container and triggering the backup via cron.

Automated backups using Cron

note

Automated backups using cron requires you to get an API token and install the CLI in your application container.

We ask that you not schedule a backup task more than once a day to minimize data usage.

Once the CLI is installed in your application container and an API token configured you can add a cron task to run once a day and trigger a backup. The CLI will read the existing environment variables in the container and default to the project and environment it is running on. In most cases such backups are only useful on the master production environment.

A common cron specification for a daily backup on the master environment looks like this:

crons:
    backup:
        spec: '0 5 * * *'
        cmd: |
            if [ "$PLATFORM_BRANCH" = master ]; then
                platform backup:create --yes --no-wait
            fi

The above cron task will run once a day at 5 am (UTC), and, if the current environment is the master branch, it will run platform backup:create on the current project and environment. The --yes flag will skip any user-interaction. The --no-wait flag will cause the command to complete immediately rather than waiting for the backup to complete.

note

It is very important to include the --no-wait flag. If you do not, the cron process will block and you will be unable to deploy new versions of the site until the backup creation process is complete.

Retention

Please see our Data Retention Page.