JIRA Integration in FishEye

Quick Setup via the FishEye Setup Wizard

When you are installing the application, the setup wizard gives you the opportunity to configure the JIRA connection automatically. This is a quick way of setting up your JIRA integration with the most common options. See Configuring JIRA Integration in the Setup Wizard.

If you did not set up the JIRA integration during the FishEye setup, you can configure the integration via the FishEye administration screens as described below.

JIRA Integration via the FishEye Administration Screens

You can further configure the JIRA connections via the FishEye administration screens. There are two parts to the integration process:

• A peer-to-peer link between JIRA and the application for sharing information and facilitating integration features. This link is set up via Application Links.
• A client-server link between the application and JIRA for delegating user and group management to your JIRA server.

1. Configuring the Application Links with JIRA

Below are step by step instructions to creating a two-way trusted applications link between FishEye and JIRA. We assume that your FishEye and JIRA servers are using the same set of users. If not, please refer to Adding an Application Link for information about the various options available.

To add a two-way trusted applications link between FishEye and JIRA:

1. Go to your FishEye administration screen and add the application link:
   1. Click 'Add Application Link'. Step 1 of the link wizard will appear.
   2. Enter the server URL of the application that you want to link to (the 'remote application').
   3. Click the 'Next' button.
   4. Enter the following information:
      • 'Create a link back to this server' – Tick this check box to add a two-way link between the two applications.
      • 'Username' and 'Password' – Enter the credentials for a username that has administrator access to the remote application.
        Note: These credentials are only used to authenticate you to the remote application, so that Application Links can make the changes required for the new link. The credentials are not saved.
      • 'Reciprocal Link URL' – The URL you give here will override the base URL specified in your remote application's administration console, for the purposes of the application links connection. Application Links will use this URL to access the remote application.
   5. Click the 'Next' button.
   6. Enter the information required to configure authentication for your application link:
      • 'The servers have the same set of users' – Tick this check box, because the users are the same in both applications.
      • 'These servers fully trust each other' – Tick this check box, because you trust the code in both applications and are sure both applications will maintain the security of their private keys.
        For more information about configuring authentication, see Configuring Authentication for an Application Link.
   7. Click the 'Create' button to create the application link.
2. If you want to show issues in your FishEye activity streams:
   • Go to the list of application links and click 'JIRA settings' next to the JIRA application link.
   • Tick the 'Include in Activity Streams' check box.
   • Click 'Save'.
3. Connect your projects across the applications:
   • Connect your FishEye repositories with your JIRA projects. See the FishEye guide to adding project links.
   • If you are using Crucible, you may want to connect your Crucible projects with your JIRA projects. See the Crucible guide to adding project links.

2. Connecting to JIRA for User Management

This option is available only with JIRA 4.3 and later.

If you want to manage your FishEye users via JIRA, you need to configure a connection in JIRA and then set up the user directory in FishEye. Both steps are described below.

2.1. To configure a new connection for user management in JIRA:

1. Log in to JIRA as a user with the 'JIRA System Administrators' global permission.
2. Click the 'Administration' link on the JIRA top navigation bar.
   1. Go to the JIRA administration screen for configuring the applications that have been set up to use JIRA for user management:
      • In JIRA 4.3: Click 'Other Applications' in the 'Users, Groups & Roles' section of the JIRA administration screen.
      • In JIRA 4.4: Select 'Administration' > 'Users' > 'JIRA User Server'.
   2. Add an application.
   3. Enter the application name and password that your application will use when accessing JIRA.
   4. Enter the IP address or addresses of your application. Valid values are:
      • A full IP address, e.g. 192.168.10.12.
      • A wildcard IP range, using CIDR notation, e.g. 192.168.10.1/16. For more information, see the introduction to CIDR notation on Wikipedia and RFC 4632.
      • Save the new application.

2.2. To set up the JIRA user directory in FishEye:

1. Go to your FishEye administration screen.
   1. Click Authentication (under 'Security Settings').
   2. Click Setup JIRA/Crowd authentication. Note, if LDAP authentication has already been set up, you will need to remove that before connecting to JIRA for user management.

   3. Make the following settings:
      
      

      Authenticate against	Select a JIRA instance
      Application name and password	Enter the values that you defined for your application in the settings on JIRA.
      JIRA URL	The web address of your JIRA server. Examples: http://www.example.com:8080/jira/ http://jira.example.com
      Auto-add	Select Create a FishEye user on successful login so that your JIRA users will be automatically added as a FishEye user when they first log in.
      Periodically synchronise users with JIRA	Select Yes to ensure that JIRA will synchronize all changes in the user information on a regular basis. Change the value for Synchronise Period if required.
      When Synchronisation Happens	Select an option depending on whether you want to allow changes to user attributes from within FishEye.
      Single Sign On	Select Disabled. SSO is not available when using JIRA for user management and if enabled will make the integration fail.

   4. Click Next and select at least one user group to be synchronised from JIRA. If necessary, you could create a new group in JIRA, such as 'fisheye-users', and select this group here.
   5. Click Save.

Notes

• JIRA requires FishEye to manually refresh repository cache when repository changes are made — When a repository is removed, or when there has been any change in FishEye repositories, JIRA does not update the FishEye repository list cache automatically. You must manually refresh the repository list cache. This is done in JIRA: 'Administration' > 'FishEye Configuration' > 'Refresh Cache' link (next to 'Repository List Cache')

Related Topics

User Management Limitations and Recommendations
Configuring Application Links