Configuration Export / Import

FlexDeploy Configuration Export/Import allows Projects and Workflows to be seamlessly migrated between 2 separate FlexDeploy servers. This is available to FlexDeploy Administrators only and is accessible from Admin Operations page. Projects and / or workflows can be exported from the source FlexDeploy server as a zip file. This zip file can then be imported in the target FlexDeploy server to migrate these projects and workflows over.

This feature allows projects and workflows to be migrated repeatedly. The import process will create or update objects as needed.

Export

On the Admin Operations screen, click on the Export/Import Configurations tab.

image-20241017-165550.png

Next click Export

image-20241017-165810.png

Now you can select any projects or workflows you’d like to export. When a project is selected, the workflows it is using will also be selected. You can remove any of these you do not want. Keep in mind the workflow must exist in the target instance for the import to work correctly.

Now click export, and a zip file will begin downloading.

Import

The source and target must be running the same version of FlexDeploy.

Choose import

Select the zip file, and click import.

You will see a success message once the import is completed.

What is exported

Workflow

Workflow Info

  • Name

  • Type

  • Description

Workflow Definition

  • Active Version

Properties

  • custom properties

  • associate existing properties

Tags (When selected)

  • Tags

Project

Configuration

General

  • Name

  • Folder

  • Active

  • Webhooks Enabled

  • Description

  • Build Workflow

  • Build Target Group

    • This includes any environments associated with this target.

    • Does not include any endpoints or properties associated with the target group.

  • Pre Deploy Workflow

  • Deploy Workflow

  • Deploy Target Group

    • This includes any environments associated with this target.

    • Does not include any endpoints or properties associated with the target group.

Properties

All project property values. No target property values are exported. No credentials are transferred.

Source Control

  • Source Control Integration

    • Source Control Integration property values. No credentials are transferred.

  • Branch Name Script

  • Sparse Checkout Folders Script

  • Tag Name Script

  • Checkout Folder Script

Branches (When Selected)

  • Branch Name

  • Version Name Syntax

  • Description

  • Attributes

Triggers (Also when Branches selected)
  • Type

  • Environment

  • Branch

  • Interval

Issue Tracking (When Selected)

These values will be exported from the project and from any folders which are in the hierarchy of where the project is.

  • Issue Tracking Integration

    • Issue Tracking Integration property values. No credentials are transferred.

  • Work Item Pattern

  • Environments

    • Post Build Comments

    • Post Build Status

    • Post Deploy Comments

    • Post Deploy Status

Test Automation (When Selected)

  • Test Automation YAML

Replacements (When Selected)

  • Replacements YAML

Tags (When Selected)

  • Tags

Folders

  • Folders

  • Issue Tracking Information (See project section for which information)

Common Issues

Target Group with same name <Name> already exists.

This issue occurs when a target group of the project is imported. If this target group has a code that does not exist, but has a name that already exists in the target instance you will see this error. The reason this happens is the import process uses the code to determine if the target group exists already, not the name.

This can happen for Environment Name also - Environment with same name already exists.

To resolve this issue please rename the target group with the same name. Then if these are the same target group, you will need to switch the target on any projects using it.

Backups

Whenever an import occurs in the target, a backup is taken. This backup can be found in <FlexDeploy application directory>/configurationbackups/<token> on the server.

This backup will consist of a set of files which are labeled as follows <Sequence of operation starting with 0>.<Table of the row>.<Type of operation (insert/update/delete)>.json.gz.

The contents of the file is a JSON representation of the row before it was modified.

These backups are taken as a reference point. There is currently no way to rollback these changes.

The following macros are not currently supported in the footer:
  • style