Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This parameter should be added to the setenvoverride.sh or setenvoverride.bat file depending if you are using linux Linux or Windows.

Create the folder that you specify and ensure that the FlexDeploy user has full control of it.

...

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.

...

The backups are retained for the same period as the purgeartifacts in purge settings.

Info

Exactly 1 backup is retained for each ProjectID/ProjectVersionID/EnvironmentID. If you deploy again, the version which was replaced become the back-out version.

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

...

Consideration to Rollback (restore the backed-up files):

As of now, there is no simple way to click and rollback the change to the backup. But it can be achieved in the following ways with simple customization.

Choose either option 1 or 2, don’t use both.

  1. Customize deploy workflow to deploy from the backup. Simply copy the backup artifact to the artifacts folder before deploying.

    1. Backups are available to the endpoint during a follow-up deployment. They are delivered in the $FD_WORKING_DIR/backups folder.

    2. Add an input to your deploy workflow like Rollback as a boolean

    3. Add an if condition before the deployment step. If Rollback is true, then copy the backup artifact ($FD_WORKING_DIR/backups) to the artifacts folder ($FD_ARTIFACTS_DIR) (use shell or file step for this)

  2. Download the files from the Backups section of artifacts, and commit them to the SCM repository. Build and deploy as normal.

Other options for Rollback:

  1. If FlexDeploy has an older version, you could also just redeploy that older version.

  2. If your SCM repository has a previous revision you would like to deploy, you can select the older revision to build on the Build submission form’s File Revisions tab and then deploy.