Installation and Upgrade

On this page:

Before you begin

To install Configuration Manager for Jira:

  • You must have the 'Jira System Administrators' global permission before you can carry out the instructions on this page.

  • Please check the Supported Platforms to ensure your version of Jira supports the intended Configuration for Jira version.

Installing Configuration Manager for Jira (CMJ)

You can install Configuration Manager for Jira (CMJ) directly from Jira's Find new apps page in the Administration section. Simply search for Configuration Manager for Jira.

  1. Log in to Jira as a user with the 'Jira System Administrators' global permission.

  2. Click the 'cog' icon on the top bar (or click Administration if using an older version of Jira) and select Manage apps. The Universal Plugin Manager (UPM) page will be displayed.

  3. On the Find new apps page, type Configuration Manager for Jira in the search box.

  4. The app will appear on the list below the search box. Click the Buy now button next to the app.

  5. You will be asked to confirm and the app details will be presented after the installation.

Enter your Configuration Manager License

  1. Log in as a user with the Jira System Administrators global permission.

  2. Click the 'cog' icon on the top bar (or click Administration if using an older version of Jira) and select Manage apps. The Universal Plugin Manager (UPM) page will be displayed.

  3. On the Purchased Apps page, click Check for Purchases then locate Configuration Manager for Jira.

  4. Click the Manage button. The details for the Configuration Manager for Jira will display. Your Support Entitlement Number (SEN) is also shown on this screen. 

  5. Paste your license into the License Key field and click Update.  You can copy the Configuration Manager for Jira license from https://my.atlassian.com, where you can either generate a new Evaluation License Key or retrieve your old License Key if you already have one.

 

Configuration Manager license must match Jira license

Please note, if you are using a commercial (i.e. not an evaluation) license for Configuration Manager for Jira, it must match your Jira license. For example, if you have a Jira Commercial license for 25 Users you must have a Configuration Manager license for 25 Users. Evaluation (trial) licenses for Configuration Manager do not need to match Jira licenses. 

  1. After the installation finishes, the following bundles are installed: 

  • Configuration Manager Core Bundle

  • Configuration Manager for Jira

  • Integrity Check for Jira

  • Power Admin

  • Configuration Manager for Jira SPI Bundle

Follow the links to learn more about Power Admin, Integrity Check, Service Provider Interface and their features.

Verifying the installation

To verify that Configuration Manager for Jira (CMJ) is installed, check that it is present under the Configuration Manager menu in the Jira Administration section.

Upgrading Configuration Manager

Before you begin, please read the latest Release Notes, and ensure that you are running a version of Jira that is compatible with your new version of Configuration Manager for Jira.

  1. Log in to Jira as a user with the 'Jira System Administrators'  global permission.

  2. Click the 'cog' icon on the top bar and select Manage apps. The Universal Plugin Manager (UPM) page will be displayed.

  3. On the Manage Apps page, look in the Apps Requiring Action section and locate Configuration Manager for Jira.

  4. Click the Update button.

To upgrade Configuration Manager for Jira manually (e.g. if your system does not have internet access), please download the Configuration Manager for Jira app, then follow the manual installation instructions at Installing Marketplace apps.

Disabling Configuration Manager

  1. Log in to Jira as a user with the 'Jira System Administrators'  global permission.

  2. Click the 'cog' icon on the top bar and select Manage apps. The Universal Plugin Manager (UPM) page will be displayed.

  3. On the Purchased Apps page, click Check for Purchases then locate Configuration Manager for Jira.

  4. Click the Manage button. The details for the Configuration Manager for Jira app will display.

  5. Click the Disable button.

  6. Repeat steps 3, 4 and 5 for Configuration Manager Core Bundle, Integrity Check for Jira, Power Admin and Service Provider Interface.

Configuration Manager will be disabled after you disable all of the bundles:

  • Configuration Manager Core

  • Configuration Manager for Jira

  • Integrity Check for Jira

  • Power Admin

  • Configuration Manager for Jira SPI Bundle

Uninstalling Configuration Manager

Occasionally, installing a new version of Configuration Manager for Jira may require uninstalling the older one.

Configuration Manager for Jira consists of four separate bundles (apps) which are distributed through the marketplace in a single .obr package. You need to uninstall all four bundles in order to successfully install an older version of the product.

The names of the bundles are:

  • Configuration Manager Core

  • Configuration Manager for Jira

  • Integrity Check for Jira

  • Power Admin

  • Configuration Manager for Jira SPI Bundle.

You need to uninstall all of them to be able to uninstall Configuration Manager for Jira.

After uninstalling all of them you will be able to successfully install a new version of the product from the Atlassian Marketplace.