Project Configurator for Jira Server and DC

Use Case 1 - Carrying Configuration Changes from Development to Production

Suppose you have a development instance (let’s call it DEV) where some changes have been made to the configuration of some projects. End users have seen and approved these changes, and you now want to transport these changes to your production instance (which we’ll call PROD).

Setup and Best Practice

Ensure Project Configurator is installed on both your development (source) and production (target) instances. You can install Project Configurator either through the UPM or by downloading the app from the Atlassian Marketplace. Apply your license to the target instance only—​Project Configurator will allow you to export without having a license for the source instance. If you need information on setting up a staging server for Jira, see Atlassian’s Establishing Staging Server Environments for Jira Applications.

While we?ve tried to make Project Configurator as easy to use as possible, there are a few things you should do to ensure a successful import:

  • Make full backups of your source and target databases including attachments.

  • Disable Outgoing Mail to not spam users.

  • Run the Object Dependencies Report before exporting to give you visibility of where objects are used or referenced by other objects in your configuration.

  • Run the Import Conflict Detection report before importing.

  • Run a simulated import, and verify the import will make the changes you expect.

  • Perform the import on a test instance before moving your changes to a live environment.

  • Perform the configuration promotion out of office hours (it might take some time).

Exporting

  1. Open your DEV Jira instance.

  2. Select Add-ons from the Jira Administration menu, then select Export Projects under Project Configurator in the left sidebar.

  3. Make your selection(s) on the Export Projects page. Choose Configuration Only below the project list, then click Export Options.

  4. Fine tune some export options on the next page. It is worth noting that the default settings will work well for 90% of exports.

  5. Click Export Configuration Only on the resulting page. The app downloads an XML file for the selected projects.

  6. Save the file in an easy-to-remember, easy-to-find location.

Importing

  1. Open a Jira session in the PROD instance.

  2. Select Add-ons from the Jira Administration menu, then select Import Projects under Project Configurator in the left sidebar.

  3. Click Browse, and locate the XML file you exported from DEV on the Imports Projects page.

  4. Click Import Options to refine what to import. See Import Options for details on each option.

  5. Select the First Run a Simulated Configuration Import option. This is highly recommended to allow you to test the import prior to committing the changes to your production instance.

  6. Click Import Project Configuration. This launches a simulated configuration load. The results page shows a simulation of the operations that would be performed on the PROD instance when that configuration file is imported. As it is a simulation, none of those changes have actually been applied.

  7. Take some time to review this information, and check if those changes are aligned with what you expect. If everything is fine, and you do not find any unexpected change, you can launch the actual import.

  8. Click Apply Configuration. Once the import has run, you will see a the final import report. This has the same format as the simulated report, making it easy for you to understand what changes were implemented.

Congratulations

If you followed along, you have just successfully transferred your first configuration changes from development to production! If you would like to see this process in action, watch the video below.