You can access all the screens of the add-on from the “Environments” top menu:
N.B. In order to do certain setups of Environment Manager, you must log as a Jira Administrator (your account must be a member of “jira-administrators” group).
- Step 1: Setup your applications
- Step 2: Setup your environment categories
- Step 3: Setup your environments
- Step4: Configure your JIRA projects
Step 1: Setup your applications
You must define every application you want to manage in Environment Manager.
- Click on “Manage Applications” menu item
- Edit or create an application choosing the right application scheme
- (Optional) Set the “Mapped Versions” options : they allow you to define which versions are mapped to you application. If you have any doubt : do not set any mapping options, you will be able to refine the version mapping later.
More About “Mapped Versions” options :
Imagine that you create an application called “eCommerce”. You can decide that only version names starting with “ECOM” Version Prefix (ex : ECOM 1.2.3, ECOM v5.6beta,…) are valid to be used as deployed versions for “eCommerce” environments (like in the example shown above). You can also define that all versions from a specific JIRA project are valid versions for “eCommerce” environments. Note that both version prefix and projects can be combined.
Step 2: Setup your environment categories
- Click on “Manage Categories” menu item
- Edit or create a category (ex : “Staging”, “Pre-production”, “Test”, “Integration 1”, “Integration 2”, “Dev 1”, “Dev 2”,..).
- Change the default display order of the environment categories using the “up”/“down” button in the list
Note that you have to setup all possible environment categories even if they are not available for every applications.
Step 3: Setup your environments
Important notice: 2 example environments are automatically created when your install the app for the first time. If you cannot see these 2 environments, this means that you are not allowed to view them. By default, all permissions are granted to standard JIRA groups (jira-administrators, jira-users, jira-software-users, jira-core-users and jira-servicedesk-users). If you do not use these defaults groups in your JIRA instance you have to add manually the permissions following these instructions.
- Click on “All Environments” menu item to get the list of all existing environments
- Create or edit an existing environment
- Choose the application and the category of the environment (ex : “eCommerce – Staging”)
- If applicable, you can also set the URL to access the environment
- Set other custom properties (by default : “description” and “details”) : content can be multiline. URL and e-mail addresses will be automatically detected, shorten for display and converted into html links. It is specially useful if you want to add convenient shortcuts to admin console, alternate links, e-mail address of administrators,… to make these environment information easily available for JIRA users.
Step 4: Configure your JIRA projects
Since version 4.4, all JIRA projects are associated by default to the single Application Scheme that is created during first installation.
Read Project Configuration documentation for more advanced settings.
N.B. For versions prior to 4.4, no Application Scheme is associated by default to JIRA projects. You have to manually associate each of your JIRA Projects to an Application Scheme using Project Administration pages as described here.