JIRA's FishEye integration allows you to browse your source-control repository from inside JIRA, provided you are using Atlassian FishEye with your source-control repository. FishEye integration is implemented as a plugin (drop-in extension) to JIRA, which ships with JIRA.
FishEye integration allows you to:
Step 1. Create an Application Link Between a JIRA and a FishEye/Crucible Server
To begin integrating JIRA with either FishEye or Crucible, you must create an application link between your JIRA server and FishEye or Crucible server.
Before you begin:
- You require JIRA System Administration permissions in order to perform this procedure.
- For JIRA to successfully integrate with FishEye, you must set up the FishEye web server to receive remote API calls. A FishEye administrator can do this by visiting the FishEye web server's 'Server Settings' page (which can be accessed from FishEye's 'Administration' area) and setting the 'Remote API' setting to 'On'. See Configuring the FishEye Web Server for more information.
To create an application link between a JIRA and a FishEye/Crucible server:
- In JIRA, click 'Administration' in the top navigation bar to open the JIRA Administration console.
- Click 'Application Links' in the left-hand panel.
- The 'Configure Application Links' screen will appear. Click 'Add Application Link'.
- The first screen of the 'Add Application Link' wizard will appear. Copy the base URL for your FishEye site (e.g.
http://fisheye.example.com:8060
and paste it into the 'Server URL' field.
- Click 'Next'.
- The 'Link to FishEye' screen will appear. Enter the following information:
- Create a link back to this server – This option is selected by default. Leave it selected, if you want create a reciprocal link back from your FishEye server to your JIRA server.
- Username – Enter the username of the administrator on your FishEye site.
- Password – Enter the password of the administrator on your FishEye site.
- Reciprocal Link URL – Leave this field at its default value, pointing to your JIRA site.
- Click 'Next'.
- The 'Set Users and Trust' screen will appear. Enter the following information:
- The servers have the same set of users – This option is selected by default. Let it remain selected.
- These servers fully trust each other – This option is selected by default. Let it remain selected.
- Click 'Create'. The application link will be created and displayed on the 'Configure Application Links' page.
The FishEye plugin for JIRA is bundled as part of the JIRA package, so there is no need to install it. Now you will configure the plugin for your installation and configure JIRA to trust FishEye.
- Navigate to the JIRA Administration console.
- Click 'FishEye Configuration' in the left-hand panel (in the 'Global Settings' section).
- The 'JIRA FishEye Plugin' screen will appear. Click 'Edit Primary Configuration'.
- Enter the following information:
- Enable Crucible Integration – Select 'True' if you want to enable Crucible integration (e.g. view reviews related to an issue).
- Update the other fields as desired.
- Click 'Update'.
- Click 'Application Links Configuration' at the bottom of the screen.
- Click 'Trusted Applications' in the 'Outgoing Authentication' column for your FishEye/Crucible link.
- Click 'Modify' and enter the following information:
- 'IP Patterns': Enter the IP addresses for your FishEye/Crucible instance (separated by commas), e.g. 127.0.0.1, 172.20.5.95.
- Click 'Apply'.
- Click 'Incoming Authentication' in the left menu.
- Click 'Modify' and enter the following information:
- 'IP Patterns': Enter the IP addresses for your JIRA instance (one per line), e.g. 127.0.0.1, 172.20.5.95.
- 'URL Patterns': Enter the following paths (one per line):
/plugins/servlet/streams
, /sr/jira.issueviews:searchrequest
, /secure/RunPortlet
, /rest
, /rpc/soap
- Click 'Apply' and then 'Close'.
Step 3. Link FishEye Repositories to JIRA Projects
In this step you link your FishEye repository to your JIRA project via an "entity link". Associating JIRA projects with FishEye repositories or Crucible projects is recommended as it greatly improves JIRA's responsiveness when your users view the 'Source' or 'Review' tabs on JIRA issues. Otherwise, JIRA must scan for all FishEye repositories/Crucible projects which are accessible to a user, whenever that user views these tabs on a JIRA issue.
This process is mandatory if your FishEye/Crucible server has no publicly accessible repositories/projects and JIRA's application link to this FishEye/Crucible server uses OAuth outgoing authentication.
Before you begin:
- You can only perform this procedure once an application link has been established between your JIRA and FishEye/Crucible servers (above).
To create an application link between a JIRA and a FishEye/Crucible server:
- Go to your JIRA URL in your browser, e.g.
http://jira.mycompany.com:8080
.
- Click 'Administration' in the top navigation bar to open the JIRA Administration console.
- Click 'Projects' link in the 'Project' section of the left-hand navigation panel.
- Click the name of the JIRA project that you want to associate with a FishEye repository/Crucible project. The JIRA project's configuration page will appear.
- Locate the 'Application Links' option and click 'Configure Application Links'. The page for configuring links from your JIRA project to the entities of applications (already linked on your JIRA server) will appear.
- Create an entity link between your JIRA project and the appropriate FishEye repository/Crucible project. (See the procedure on Linking your JIRA Project to another Entity from step 4 for details.)
Step 4. (Optional) Subscribe JIRA to FishEye Gadgets
In this optional step, you will make your FishEye gadgets available for use in JIRA. This will allow JIRA users will be able to add any FishEye gadget to their dashboards.
- Click 'Dashboards' in JIRA's top navigation bar.
- Click 'Add Gadget'.
- The 'Gadget Directory' popup window will appear. Click 'Gadget Subscriptions'.
- The 'Gadget Subscriptions' popup window will appear. Click 'Add Subscription'.
- The 'Add Subscriptions' popup window will appear. Copy the base URL for your FishEye site (e.g.
http://fisheye.example.com:8060
and paste it into the text box on the screen.
- Click 'Add Subscription'.
- Click 'Finished'. The FishEye gadgets are now available in your JIRA gadget directory.
Notes
- Integrating FishEye with JIRA – You can also configure FishEye to integrate with JIRA, which enables you to view JIRA data from within FishEye. Please see Jira Integration in Fisheye in the FishEye documentation for instructions.
- 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')
- For frequently-asked questions about using the FishEye for JIRA plugin, please see Integration FAQ
- For troubleshooting issues with the FishEye-JIRA integration, please see Troubleshooting JIRA Fisheye Plugin
- For information on viewing FishEye data in JIRA (after the integration has been completed successfully) please see: