Crucible Latest (3.1) : 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.

 

FISHEYE_INST – this is an environment variable that defines the path to the FishEye data directory, which is used for installations where the FishEye instance data is stored in a separate location from the install (home) directory. Both Crucible and FishEye use this environment variable.

(info) Read more about the FISHEYE_INST environment variable.

On this page:

Upgrade procedure

  • We strongly recommend that you make a backup of your data before following one of the methods below. Refer to making a backup.
  • 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>, separately from your FishEye data directory, which has 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.
Method 1: Without a FISHEYE_INST directory (default)
  1. Download Crucible.
  2. Extract the new Crucible archive into a directory, which we will refer to as <Crucible directory>.
  3. Shut down your existing FishEye server, if it is running.
  4. Copy <FishEye home directory>/config.xml to <Crucible directory>.
  5. Delete the <Crucible directory>/var directory.
  6. Copy the <FishEye home directory>/var directory to <Crucible directory>/var.
  7. Follow any version-specific instructions found in the Release Notes.
  8. Start Crucible from the new installation by running <Crucible 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. Shut down your existing FishEye server, if it is running.
  2. Make a backup of your FISHEYE_INST directory.
  3. Download Crucible and unzip the archive into a directory, which we will refer to as <Crucible 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 <Crucible directory>/bin/run.sh. (Use run.bat on Windows).
  6. Follow the initial configuration steps outlined below.
Method 3: No FISHEYE_INST directory, but wish to use one
  1. Shut down your existing FishEye server, if it is running.
  2. Create a new directory on your filesystem, then set up a FISHEYE_INST environment variable to point to the new directory.
  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 <Crucible directory>.
  7. Start Crucible from the new installation by running <Crucible directory>/bin/run.sh. (Use run.bat on Windows).
  8. Follow the initial configuration steps outlined below.
  9. If your 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  <Crucible directory> and FISHEYE_INST. Check that FISHEYE_INST is pointing to the correct directory - it should point to the location to where you copied the existing FishEye files in steps 3 and 4 above.

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 after upgrading, you must enter your Crucible license key. To do this, update your Crucible license by going to the admin area and clicking System Info (under 'System Settings'). Click Edit License (under 'License') to 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.