Manage Sites

Each link to a Jenkins or Hudson application is known as a Site on the Jenkins Configuration page. 

Add Site

To add a new Jenkins or Hudson CI Site, simply click the Add Site button on top right to show the Add Site dialog, and:

Private Site

Private Jenkins sites will need to have Jira Integration for Jenkins - 3.6.0 or newer installed for the integration to work.

  • Selected the Type of the site.
  • Provide a Name.
  • Optionally, check the Auto enable new Jobs checkbox if you want to enable all Jobs on the site by default, including future new jobs.
    (info) It is advised that you enable this, since jobs will only become available in Jira after Jenkins notifies Jira of it, and this can time some time depending the build workload on Jenkins.
  • Select Private accessibility option if your Jenkins site is behind a firewall or otherwise not accessible for job and build synchronization.
  • Provide the Display URL for UI features.
  • Save the configuration and open the Configuration options of the Jenkins site by clicking on the Configuration action of the site.
  • Follow the instructions in the dialog box to complete the registration of the site.

Jenkins will now notify Jira whenever there is a change that needs to be processed by Jira, so it may take some time for all the jobs to become available in Jira.

Public Site

  • Selected the Type of the site.
  • Provide a Name.
  • Optionally, check the Auto enable new Jobs checkbox if you want to enable all Jobs on the site by default, including future new jobs.
  • Select Public accessibility.
  • Provide the Sync URL that should be used for synchronization and other background actions.

    (warning) For security purposes, only ports 80 443, 8080 and 8443, http and https respectively, are supported on Jira Cloud.
    (warning) The Jenkins counterpart add-on is required to be installed before the site can be added on Jira Cloud.
    (warning) You should whitelist the IP address 34.242.243.113 to make sure your integration work as intended.

  • Optionally, provide a Display URL incase the Sync URL is not accessible by users and a different URL should be used in the UI features.
  • Optionally, provide basic authentication details in the form of an Username and Token.
    (warning) If you use and external source (like LDAP, AD or Crowd) for authentication, Then it could be that you need to provide the API Token as password for the user.
     Where to find the API Token...

    The API Token is a password replacing token that users can use to authenticate with against Jenkins. This is mostly useful for users that have there accounts managed outside Jenkins.

    To get a token for an account, follow these steps:

    1.  Login on Jenkins using the username and password of the synchronization account
    2. Click on the Account Name in the top-right corner of the page after login
    3. Then click on the Configure link in the left menu
    4. The API Token can now be displayed by clicking on the Show API Token... button

Site Actions

Actions and configuration changes can be make per site using the Actions button next to the Site title, or in the page header when viewing a single site.

Edit Site

To edit the details of a site, like name, authentication details, etc, simply click on the Edit button in the actions column. This will show the Site edit dialog and form allowing you to update the details of the Site.

(warning) In order to change the authentication token, you will need to check the Change Token box to show the Token field.

(warning) If you use and external source (like LDAP, AD or Crowd) for authentication, Then it could be that you need to provide the API Token as password for the user.

 Where to find the API Token...

The API Token is a password replacing token that users can use to authenticate with against Jenkins. This is mostly useful for users that have there accounts managed outside Jenkins.

To get a token for an account, follow these steps:

  1.  Login on Jenkins using the username and password of the synchronization account
  2. Click on the Account Name in the top-right corner of the page after login
  3. Then click on the Configure link in the left menu
  4. The API Token can now be displayed by clicking on the Show API Token... button

Delete Site

To delete a Site, simply click the Delete button in the actions column and click the Delete button to delete the site.

This action is not reversible, and only the jobs and builds that are still available on the Site itself can be restored when the site is added at a later state.

Synchronize

To synchronize a Site and all enabled jobs on it, simply click on the Synchronize button in the actions column. This action is not available for Sites behind a firewall.

Cleanup Jobs

To cleanup job and build data of a site, simply click on the Cleanup Jobs action in the actions dropdown. This will not delete data on Jenkins, but will only delete jobs and builds that are marked as deleted in Jira.

This action is not reversible, and only the jobs and builds that are still available on the Site itself can be restored when the site is added at a later state.

Auto Enable new Jobs

To quickly enable or disable the Auto Enable new Jobs setting for a Site, simply click on the Auto Enable new Jobs action in the actions dropdown. Alternatively this can also be done using the Site Edit action.

Manage Jobs

The Manage Jobs site action allows you too quickly perform multiple operations, see Manage Jobs, on multiple jobs, simply click on the Manage Jobs action in the actions dropdown.

Configuration

To show the site integration configuration of a site, simple click on the Configuration action in the actions dropdown (If your site is behind a firewall then this button is placed top-level action). This information can be used to (re)register the Jira site with Jenkins.