FlexDeploy Backups Repository

The FlexDeploy backup repository is a directory available on the FlexDeploy server where all backups are stored. This directory needs to have at least 10GB of space available on the FlexDeploy Server. The backups repository is optional. If configured, the backup artifact returned from the deploy workflow will be stored in the Backups repository. Before the deployment operation, we can export the existing artifact from the target server and store it in the backups folder.

This directory will be specified on the command line as -Dflexagon.fd.backup.repository.root=<location>
This parameter should be added to the setenvoverride.sh or setenvoverride.bat file depending if you are using linux or Windows.
Create the folder that you specify and ensure that the FlexDeploy user has full control of it.
Bounce the FlexDeploy server if it was running for the changes to take effect.

Not all plugins have built in support for backups. If the one you are using doesn’t, simply copy the files you wish to backup to the FD_WORKING_DIR/backups.

When the execution runs, the files in the backups folder will be backed up in the <location> that you specified, inside of folders that keep them organized. Backups are stored in <flexagon.fd.backup.repository.root>/ProjectID/EnvironmentId/ProjectVersionId. The backups are retained for the same period as artifacts in purge settings. Exactly 1 backup is retained for each ProjectID/EnvironmentID/ProjectVersionID. If you deploy again, the version which was replaced will become the back-out version.

To view or download a backup, go to the deployment that had a backup. Click Artifacts. The backups are shown below the artifacts.

To restore the backed-up files, you can create a deploy workflow input that replaces the artifacts with the backups and deploys. You could also source control the backed up files and then build and deploy them manually. If FlexDeploy has deployed another older version of the files, you could also just redeploy that older version.

Backups are supported for use in rollback deployments. To rollback to a previous version from a backup repository, simply select Backup Repository for the Rollback Source Type attribute for the file.