Crucible 2.8 : Upgrading from FishEye to Crucible

If you have been using FishEye and now want to move to Crucible, you can do this without losing your FishEye repositories.

(info) Read about how your Crucible installation works with FishEye.

Before you start

We strongly recommend you make a backup of your data before following the steps below. Refer to the documentation on making a backup.

Upgrade procedure

  • Follow Method 1 if you have a default configuration and are not using a FISHEYE_INST directory (that is, your FishEye binaries and data are all stored under the same location, in the default <FishEye home directory>). This is the typical scenario for evaluation installations.
  • Follow Method 2 below if you have FishEye configured to use a FISHEYE_INST directory (that is, your FishEye binaries are stored in the <FishEye home directory>, separate from your FishEye data directory with a location defined by FISHEYE_INST). This is the recommended scenario for production installations.
  • Follow Method 3 if you are not using a FISHEYE_INST directory but would now like to start using one. You may wish to do this when configuring an existing installation for a production environment.

(info) Read more about the FISHEYE_INST environment variable.

Method 1: Without a FISHEYE_INST Directory (default)
  1. Download Crucible.
  2. Extract the new Crucible archive into a directory such as <New FishEye directory> .
  3. Shut down the old FishEye instance if it is running.
  4. Copy <FishEye home directory>/config.xml to <New FishEye directory> .
  5. Delete the <New FishEye directory> /var directory.
  6. Copy the <FishEye home directory>/var directory to <New FishEye directory>/ var.
  7. Follow any version-specific instructions found in the Release Notes.
  8. Start Crucible from the new installation by running <New FishEye directory>/bin/run.sh. (Use run.bat on Windows).
  9. Follow the initial configuration steps outlined below.
Method 2: Using a FISHEYE_INST Directory
  1. Shutdown your existing fisheye server.
  2. Make a backup of your FISHEYE_INST directory.
  3. Download Crucible and unzip the archive into a folder. This document assumes you have extracted your Crucible zip file into a directory called <New FishEye directory> .
  4. Leave your FISHEYE_INST environment variable set to its existing location. Crucible will use this variable.
  5. Start Crucible from the new installation by running <New FishEye directory> /bin/run.sh. (Use run.bat on Windows).
  6. Follow the initial configuration steps outlined below.
Method 3: Without a FISHEYE_INST Directory, but intending to set one up
  1. Shut down the old FishEye instance if it is running.
  2. Set up the FISHEYE_INST environment variable, then create the FISHEYE_INST directory on your filesystem.
  3. Copy the <FishEye home directory> /config.xml to the FISHEYE_INST directory.
  4. Copy the <FishEye home directory> /var directory to the FISHEYE_INST directory.
  5. Download Crucible.
  6. Extract the new Crucible archive into a directory such as <New FishEye directory> .
  7. Start Crucible from the new installation by running <New FishEye directory> /bin/run.sh. (Use run.bat on Windows).
  8. Follow the initial configuration steps outlined below.
  9. If you configuration is not automatically picked up and you cannot see your existing repositories, check your Administration > Sys-Info page, where you will see information about the  <New FishEye directory> and FISHEYE_INST. Check that FISHEYE_INST is pointing to the correct directory.

Initial Crucible configuration

  1. You can access FishEye immediately by going to http://HOSTNAME:8060/ in a browser.
  2. The first time you run FishEye, enter your Crucible license key. To do this, update your Crucible license by opening 'Administration', then 'Sys-Info/Support'. On this screen, you can enter your Crucible license key. You can view your license key here. The Crucible functionality will be instantly unlocked.
  3. If you do not already have user accounts configured, you will need to do this via the Administration screens or by configuring Crucible/FishEye to use external authentication.
    To add users:
  4. Crucible can email each review participant on a range of changes. Each user can then set up their own preferences. This is described in the User Profile guide. First, you must set up the SMTP Server.