Crucible upgrade guide

This page describes how to upgrade to a new version of Crucible. We strongly recommend that you update Crucible by performing the steps below.

Note that:

  • This update process does not perform an in-place upgrade, but installs the new version of Crucible into a fresh installation directory. The new Crucible uses your existing Crucible home directory and external database.
  • For production environments we recommend that you test the Crucible update on a QA server before deploying to production.
  • You can update from any previous version to the latest version of Crucible.

If you want to migrate Crucible, as well as upgrade, see Migrating and Upgrading FishEye/Crucible.

1. Review the upgrade notes

There are specific upgrade notes further down this page for each version of Crucible. 

You should read the relevant sections for each version between your current version of Crucible and the version you are upgrading to.

2. Backup your Crucible data

Back up your entire Crucible instance (see Backing up and restoring Crucible data):

  • If you are backing up your Crucible instance via the Admin interface, tick all of the 'Include' checkboxes (e.g. plugins, templates, uploads, SQL database, etc).
  • If you are backing up your Crucible instance using the command-line interface, do not use any exclusion options.

3. Stop Crucible

In a terminal, change directory to the <Crucible home directory> and run this:

bin/stop.sh

4. Install Crucible

This update process does not perform an in-place upgrade, but installs the new version of Crucible into a fresh installation directory. The new Crucible uses your existing Crucible home directory and external database.

Download the Crucible zip file. On Windows, download the installer. See Installing Crucible on Linux and Mac or Installing Crucible on Windows for detailed installation instructions.

Your upgrade procedure depends on whether you are using a FISHEYE_INST directory (i.e. "FishEye instance" directory).
  • The FISHEYE_INST directory is the FishEye data directory (not the installation directory) and has a location defined by the FISHEYE_INST environment variable. It is used to keep the FishEye data completely separate from the FishEye/Crucible application files. We recommend that you configure FishEye/Crucible to use a FISHEYE_INST directory for production instances. Read more about FISHEYE_INST in Installing FishEye on Windows or Installing FishEye on Linux and Mac.
  • The <FishEye install directory>  is the location of the FishEye/Crucible application files.
Method 1: Using a FISHEYE_INST directory
  Click here to expand...

If you have FishEye/Crucible configured to use a FISHEYE_INST directory, then follow the instructions below. This is the recommended scenario for production installations.

  1. Shut down your existing FishEye/Crucible server, using bin\stop.bat or bin\stop.sh from the <FishEye install directory>.
  2. Make a backup of your FISHEYE_INST directory.
  3. Download FishEye or Crucible.
  4. Extract the new FishEye/Crucible version to a new directory.
  5. Leave your  FISHEYE_INST  environment variable set to its existing location. Both FishEye and Crucible use this variable.
    • Please be aware that jar files in the FISHEYE_INST/lib directory may conflict with those required for FishEye's normal operation. Jar files in this directory should be limited to those which provide functionality not provided by FishEye (e.g. database drivers).
  6. Start FishEye/Crucible from the new installation directory by running bin/run.sh. (Use run.bat on Windows.)
  7. Follow any version-specific instructions found in the FishEye upgrade guide or Crucible upgrade guide.
Method 2: Without a FISHEYE_INST directory
  Click here to expand...

If you do not have FishEye/Crucible configured to use a FISHEYE_INST directory and do not want to set one up, then follow the instructions below. The <FishEye install directory> is the location of the existing FishEye/Crucible installation. Note that this is the typical scenario for evaluation installations, and is not recommended for production installations.

You will need to copy some files from your old FishEye/Crucible installation to your new one.

  1. Download FishEye or Crucible.
  2. Extract the new FishEye/Crucible archive into a directory such as <New FishEye install directory>.
  3. Shut down the old FishEye/Crucible server, using bin\stop.bat or bin\stop.sh from the <FishEye install directory> .
  4. Copy <FishEye install directory>/config.xml to  <New FishEye install directory>.
  5. Delete the following directories from the <New FishEye install directory> directory:
    • <New FishEye install directory>/var/cache
    • <New FishEye install directory>/var/data
    • <New FishEye install directory>/var/log
    • <New FishEye install directory>/data (If it exists) 
  6. Copy (or move) the following directories from  <FishEye install directory> to <New FishEye install directory>:
    • <FishEye install directory>/var/cache
    • <FishEye install directory>/var/data
    • <FishEye install directory>/var/log
    • <New FishEye install directory>/data (If it exists) 
    DO NOT include the following directories when you do that:
    • <FishEye install directory>/var/osgi-cache
    • <FishEye install directory>/var/plugins
    • <FishEye install directory>/var/tmp
  7. Delete the  <New FishEye install directory>/cache  directory.
  8. Copy (or move) the  <FishEye install directory>/cache directory to   <New FishEye install directory>/cache.
  9. Start FishEye/Crucible from the new installation by running  <New FishEye install directory>/bin/run.sh. (Use run.bat on Windows.)
  10. Follow any version-specific instructions found in the  FishEye upgrade guide    or  Crucible upgrade guide .
Method 3: Without a FISHEYE_INST directory, but would like to set one up
  Click here to expand...

If you do not have FishEye/Crucible configured to use a FISHEYE_INST directory but would like to set one up, then follow the instructions below. You may wish to do this when reconfiguring an existing installation for a production environment.

The FISHEYE_INST directory is the FishEye data directory, which has a location defined by the  FISHEYE_INST  environment variable, and which should be completely separate from the <FishEye install directory>. The <FishEye install directory> is the location of the existing FishEye/Crucible installation.

  1. Download FishEye or Crucible.
  2. Shut down the existing FishEye/Crucible server, using bin\stop.bat or bin\stop.sh from the <FishEye install directory> .
  3. Set up the FISHEYE_INST environment variable, then create the FISHEYE_INST directory on your file system.
  4. Copy  <FishEye install directory>/config.xml to the FISHEYE_INST directory.
  5. Copy the  <FishEye install directory>/var directory to the FISHEYE_INST directory.
  6. Copy the  <FishEye install directory>/cache directory to the FISHEYE_INST directory.
  7. If it exists, copy the  <FishEye install directory>/data directory to the FISHEYE_INST directory.
  8. Extract the new FishEye/Crucible archive into a directory such as  <New FishEye install directory> .
  9. Start FishEye/Crucible from the new installation by running  <New FishEye install directory> /bin/run.sh. (Use run.bat on Windows.)
    • 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 <FishEye install directory> and FISHEYE_INST. Check that your FISHEYE_INST is pointing to the right directory.
  10. Follow any version-specific instructions found in the  FishEye upgrade guide    or  Crucible upgrade guide .
Method 4: Using the FishEye Installer for Windows
  Click here to expand...

Using a FISHEYE_INST directory (including when previously running as a Windows Service using the wrapper)

  Click here to expand...

If you have FishEye/Crucible configured to use a FISHEYE_INST directory, then follow the instructions below. This is the recommended scenario for production installations. This also applies when previously running FishEye as a Windows Service and the FISHEYE_INST location is defined within the wrapper.

  1. Shut down your existing FishEye/Crucible server, using bin\stop.bat or bin\stop.sh from the <FishEye install directory>.
    If you currently run FishEye or Crucible as a Windows service, see  Upgrading FishEye on Windows  for instructions on uninstalling the service.
  2. Make a backup of your FISHEYE_INST directory.
  3. Download FishEye or Crucible.
  4. Run the installer.
  5. Select the option to use the Custom Install. Proceed with the install.
  6. Select the folder where FishEye will be installed. In this step you can leave the default value selected. Proceed with the install.
  7. Select the folder where your data will be stored, which in this case is the folder pointed by your FISHEYE_INST. Ensure to select the correct folder in order to have all your data being read by FishEye. For example, if your FISHEYE_INST is currently set to C:\Atlassian\fish_inst, this is the folder you have to select. Proceed with the install until the end.
    • Please be aware that jar files in the FISHEYE_INST/lib directory may conflict with those required for FishEye's normal operation. Jar files in this directory should be limited to those which provide functionality not provided by FishEye (e.g. database drivers).
  8. FishEye will be installed and running as a service by the end of the install process.
  9. Follow any version-specific instructions found in the FishEye upgrade guide or Crucible upgrade guide.

Without a FISHEYE_INST directory (including when previously running as a Windows Service using the wrapper)

  Click here to expand...

If you do not have FishEye/Crucible configured to use a FISHEYE_INST directory, the installer will create a directory for you and will create a FISHEYE_INST environment variable pointing to it. In the following instructions, <FishEye install directory> refers to the location of the previous FishEye/Crucible installation. This also applies when previously running FishEye as a Windows Service and there is no FISHEYE_INST defined.

  1. Shut down your existing FishEye/Crucible server, using bin\stop.bat or bin\stop.sh from the <FishEye install directory>.
    If you currently run FishEye or Crucible as a Windows service, see  Upgrading FishEye on Windows  for instructions on uninstalling the service. 
  2. Download FishEye or Crucible.
  3. Run the installer.
  4. Select the option to use the Default Install. You may also use Custom Install if you want to select the directories where FishEye will be installed and where your data will be stored. Proceed with the install.
  5. FishEye will be installed and running as a service by the end of the install process.
  6. Stop FishEye service (names as Atlassian FishEye).
  7. Copy  <FishEye install directory>/config.xml to <FISHEYE_INST>.
  8. Delete the following directories from the <FISHEYE_INST> directory:
    • <FISHEYE_INST>/var/cache
    • <FISHEYE_INST>/var/data
    • <FISHEYE_INST>/var/log
    • <FISHEYE_INST>/data (If it exists) 
  9. Copy (or move) the following directories from  <FishEye install directory> to <FISHEYE_INST>: 
    • <FishEye install directory>/var/cache
    • <FishEye install directory>/var/data
    • <FishEye install directory>/var/log
    • <FishEye install directory>/data (If it exists)  
      DO NOT include the following directories when you do that:
    • <FishEye install directory>/var/osgi-cache
    • <FishEye install directory>/var/plugins
    • <FishEye install directory>/var/tmp
  10. Delete the  <FISHEYE_INST>/cache  directory.
  11. Copy (or move) the  <FishEye install directory>/cache directory to <FISHEYE_INST>/cache.
  12. Start the Atlassian FishEye service.
  13. Follow any version-specific instructions found in the FishEye upgrade guide or Crucible upgrade guide.

5. Update any custom configurations

Once the new vesion of Crucible is installed, remember to update any custom configurations in the new version of Crucible, for example your SQL driver and your wrapper.config file.

If you are using MySQL, read about the JDBC driver.

If you currently run Crucible as a Windows service and are installing the new version of Crucible in a new location, you need to uninstall and then reinstall Crucible as a Windows service. Please see  Upgrading FishEye on Windows  for instructions.

For Crucible 3.4 and later, on Windows, you can edit the Java VM properties using the tool included in the download. See JVM system properties.

 

6. Start Crucible

In a terminal, change directory to the <Crucible home directory> and run this:

bin/start.sh

After a few moments, in a web browser on the same machine, go to http://localhost:8060/ (or, from another machine, type  http://hostname:8060/ , where hostname is the name of the machine where you installed Crucible).

Version-specific update notes

This section provides specific update notes for each version of Crucible. These notes supplement the primary update guide above.

You should read the relevant sections for each version between your current version of Crucible and the version you are upgrading to.

Crucible 4.1 upgrade notes

Please also see:

Subversion 1.9 is supported

Crucible 4.1 supports Subversion 1.9 and the new FSFS format 7 introduced by this release. You may add new Subversion 1.9 repositories to Crucible as well as upgrade (with 'svnadmin upgrade' command) repositories that you've already added. Subversion 1.9 support covers both the bundled SVN client (SVNKit) as well as the Subversion 1.9 native library setup.

Please note however that during internal performance tests we've observed some indexing slowdowns when SVN 1.9 (FSFS format 7) repositories were accessed with the file:// protocol using the bundled SVN client (comparing to SVN 1.8 ones). Therefore, if indexing time is a priority for you, we recommend that you continue to use SVN 1.5 - 1.8 repositories, if possible. 

Subversion 1.1 - 1.4 is no longer supported

As of Crucible 4.1, the oldest Subversion version supported is 1.5 (released in 2008). This applies also to the repository format: the lowest supported is format 5 and FSFS format 3. Therefore, before you upgrade to Crucible 4.1, please upgrade both the Subversion client and server binaries as well as your repositories (using the 'svn upgrade' command). 

Subversion merges are supported

Crucible 4.1 supports merge operation in Subversion. You may merge branches in Subversion and see information about this in commit graph and on changeset page. More information is available on official documentation page.

Please note that merge information is processed only for new changesets. The repository history does not rescanned in order to expose the merge information for old changesets, however, if you need such historical information, you can perform a full repository reindex.

Crucible 4.0 upgrade notes

Please also see:

User directories migration

Crucible 4.0 includes new user directories administration. Please refer to FishEye 4.0 user directories migration for details of how users-related settings are migrated.

API changes for plugin developers

Please note that if you're not a plugin developer, changes described in this section will not affect you.

Plugins System 4.0 upgrade

Crucible 4.0 ships with an upgraded Plugins System. Please refer to the Atlassian Plugins 4.0 Upgrade Guide for a detailed list of changes introduced by the upgrade.

Crucible API changes

Crucible API changes in Crucible 4.0 are mainly related to the introduction of user directories. Host-based authentication has been removed, and LDAP-based authentication is now handled by Crowd rather than directly by Crucible, resulting in the removal of the HostAuthSettings and LdapAuthSettings classes. You could implement a custom authenticator for Crucible or a custom directory connector for Crowd, if absolutely necessary, but we strongly recommend that you rely on existing authentication methods.

The UserService# getActiveUserCount method is deprecated - use the getLicensedUserCount instead.

You can no longer call UserService# setCrucibleEnabledForUsers to enable Crucible access for certain users, as this method has been removed. Instead, you should assign users to a proper group and set group permissions using the new GlobalPermissionService# setPermissionsForGroup method.

The REST API has minor changes related to user and group management. See the documentation for more details.

Dropping Host-based Authentication 

As already announced, host-based authentication is no longer supported by Crucible 4.0 and later versions.

Known issues for Crucible 4.0

Loading
Key Summary T Created Updated Due Assignee Reporter P Status Resolution
CRUC-7828 Reply comment gets rendered on the review page but not in CRAS Bug Aug 17, 2016 Aug 26, 2016 Unassigned Vitalii Petrychuk Low Open Unresolved
CRUC-7614 broken scroll view port on Review Statistics Bug Mar 08, 2016 Aug 26, 2016 Unassigned Adam Borowski Low Open Unresolved
CRUC-7613 Edit Review Details screen won't allow to see linked JIRA error details Bug Mar 08, 2016 Aug 26, 2016 Unassigned Cezary Zawadka Low Open Unresolved
CRUC-7611 Can't link issue with review until all applinks authenticated Bug Mar 08, 2016 Aug 26, 2016 Unassigned Piotr Swiecicki [Atlassian] Low Open Unresolved
CRUC-7608 nav:review - NP when viewing repository activity stream by a user with no permission to view review Bug Mar 04, 2016 Aug 26, 2016 Unassigned Maciej Swinarski [Atlassian] Low Open Unresolved
CRUC-7540 Unable to create branch review for branch with unicode characters in its name Bug Jan 04, 2016 Aug 26, 2016 Unassigned Piotr Swiecicki [Atlassian] Low Open Unresolved
CRUC-7130 Crucible does not clear all Tokens when Browser is Closed Bug Feb 13, 2015 Aug 26, 2016 Unassigned David Mahoney Low Open Unresolved
CRUC-6285 Non-crucible users are still able to view Review content Bug Nov 28, 2012 Aug 26, 2016 Unassigned Nick Pellow [Atlassian] Low Open Unresolved
CRUC-6206 User Sync from Crowd/JIRA/LDAP Does Not Prevent Duplicated Emails Bug Sep 02, 2012 Aug 26, 2016 Unassigned Renan Battaglin Low Open Unresolved

Crucible 3.10 upgrade notes

Please also see:

Secure connections using self-signed certificates may fail

Crucible 3.10 uses an updated version of commons-httpclient that provides SNI (Server Name Indication) support. However, this version of commons-httpclient uses stricter domain name verification, so webhooks and application links that use a secure connection may stop working. This is only likely to happen when Crucible accesses an application using a secure connection verified by a self-signed certificate, where the application domain name (for example 'jira.company.com') does not match the certificate common name (such as 'company.com').

You may need to update the SSL certificates you use with secure connections between Crucible 3.10 and other applications – self-signed certificates may no longer work as before.

Uppercase project keys upgrade task

The project key upgrade task runs on startup after upgrading to Crucible 3.10; it should only take a few seconds to run.

This is required because  Crucible 3.10 now only allows uppercase project keys. We've made this change so that the DB project key column can be properly indexed, allowing much improved performance for a number of different method calls.

  • All existing project keys will be converted to be all uppercase and all unique. For Crucible, this also includes the project key part of review keys.
  • If a project key conflict occurs, the project key will be renamed by adding an  UPGRADE[Number]  suffix. You can change renamed project keys manually after the upgrade if necessary.
  • The upgrade task produces logs for project key changes. Look for logs starting with [projectKey.uppercase]
  • All operations using the project key as an argument are case sensitive, with the exception that  view operations in the browser are case insensitive and will upper case the project key automatically.
  • FishEye and Crucible track recently visited projects, reviews and snippets for every user. Any projects, reviews and snippets with renamed project keys however will not appear in the recently visited cache. 

If there are entity links between JIRA Software and Crucible projects, the mapping will be automatically updated. You can check this by visiting

Administration > Add-ons > FishEye configuration > FishEye/Crucible entity mappings in JIRA. If Crucible projects are not all uppercased, click Refresh cache to update the mapping. 

Note that FishEye and Crucible will refuse to start if the DB is not case-sensitive with UTF-8 default encoding, to avoid potential data corruption during the upgrade task. In this case you'll see the following log message:

FeCru connecting to DB not using case-sensitive UTF8 encoding

LDAP synchronization

Crucible 3.10 now  supports paging (with a default page size of 1000) when requesting data from the LDAP server, and works seamlessly when the number of user accounts exceeds 1000 in Active Directory.  It  reverts to the previous behavior with servers that don't support LDAPv3.

The paging size can be controlled with the fisheye.ldap.sync.page.size system property. Setting it to 0 disables paging.

Known issues for Crucible 3.10

Crucible 3.9 upgrade notes

Please also see:

Lucene index upgrade task

A reindex of the Lucene index runs on startup after upgrading to Crucible 3.9. This is required because new fields have been added to the Lucene index to enable sorting of reviews by the Review column ( CRUC-6560 - Review dashboard can't be sorted by Review key CLOSED  ).  

Reindexing takes about 10 minutes for 15000 reviews. During reindex, Crucible is usable but some reviews may not be visible.

Smart Commits now use the JIRA REST API

As of version 3.9.0, Crucible uses the JIRA REST API instead of the JIRA FishEye Plugin for JIRA Smart Commits. This change ensures that you will be able to use Smart Commits with future versions of JIRA. Note that using Smart Commits with previous versions of Crucible (earlier than 3.9.0) and JIRA 7 will cause an error notification via email. 

Git clone changes

As of version 3.9.0, Crucible turns Git garbage collection off when cloning a repository (by adding the gc.pruneExpire=never option) to prevent unreferenced objects being removed from local clones. Also, when cloning a repository, git config is run on each repository during instance startup. This change bumps the Git cache version ( CACHE_VERSION ) to 22.

Supported platform upgrades

  • Oracle 12c is now supported.
  • Git 2.4.6 and Mercurial 3.4.2 are now supported.
  • Support for Java 7 has been removed from Crucible 3.9, as previously announced.
  • Support for Internet Explorer 9 has been removed from Crucible 3.9, as previously announced.

Known issues for Crucible 3.9

Loading
T Key Summary Status
Bug CRUC-7368 Changeset checkbox not synchronized with added revisions on Crucible Add Content Dialog Open
Bug CRUC-7316 long comment may result with StackOverflowError Open
Bug CRUC-1689 ArrayIndexOutOfBoundsException thrown when trying to expand files in crucible. Open
Bug CRUC-7665 Images broken in Crucible notifications Open
Bug CRUC-7468 Crucible is inconsistent with redirects causing some Ajax to fail Open
Bug CRUC-7447 Commit messages aren't autoescaped for crucible markup when creating a review Open
Bug CRUC-7420 Branch selector in add changeset dialog doesn't show all branches if their names are funny Open
Bug CRUC-7417 When posting a long comment sometimes you can't scroll the review properly afterwards. Open
Bug CRUC-7415 FRX removal might cause intermittent error messages Open
Bug CRUC-7413 FRX with 500 comments loads ~40 seconds Open
Bug CRUC-7411 When open FRX in the new tab page is not scrolled down to the "sticky" position Open
Bug CRUC-7410 Clicking on a snippet line in IE/Safari causes an error Open
Bug CRUC-7408 'Sorry, you're not authorized to read/unread a file from this review now' after leaving a review Open
Bug CRUC-7381 SVN LightScm plugin times out connecting to HTTPS repositories Open
Bug CRUC-7356 allClosedReviews REST Review Filter is Slow Open
Bug CRUC-7344 Comments on lines of code disappear in a review when highlight lines are edited Open
Bug CRUC-7325 Edit Reivew Details Dialog Should Prevent Reload When Changes Have Been Made Open
Bug CRUC-7321 Reviews in 'Waiting for Approval' State Cannot be Transitioned if Changed to a Permission Scheme without a Moderator Open
Bug CRUC-7318 Dialogs content is not scrollable when CRAS is opened Open
Bug CRUC-7315 Collapsed comment body is not properly aligned Open
Showing 20 out of 24 issues Refresh

Crucible 3.8 upgrade notes

Please also see:

New database index to improve Review Dashboard and Review Search pages load time

A database upgrade task is run on startup that adds a database index. This task should take no more than a few minutes, and should complete within seconds on most instances.

Improved Git indexing time for newly created branches

In order to allow faster Git indexing, a new field was added to the internal repository caches. The cache for each Git repository is automatically upgraded when the repository is started for the first time after upgrading. It is expected to take under a minute per repository, but may take slightly longer if repositories have thousands of branches.

Supported platform upgrades

Known issues for Crucible 3.8

Loading
T Key Summary Status
Bug CRUC-5898 Unable to add content to review via "Browse Changeset" when using "Diffs to..." Open
Bug CRUC-5833 Problem creating FRXDO from frx: Index: 395 Open
Bug CRUC-5570 Crucible comment and general search potentially excludes valid results Open
Bug CRUC-1689 ArrayIndexOutOfBoundsException thrown when trying to expand files in crucible. Open
Bug CRUC-7660 NullPointerException when closing a review with a deleted comment Open
Bug CRUC-7617 Json serialization problem on fisheye1.atlassian.com/cru/CR-1 Open
Bug CRUC-7444 Running crucible.py throws error: Expected diff hunk descriptor but found Open
Bug CRUC-7425 Review Coverage Report not expanding changeset when clicking on arrow Open
Bug CRUC-7417 When posting a long comment sometimes you can't scroll the review properly afterwards. Open
Bug CRUC-7387 Error adding a patch ending with diffs for binary files Open
Bug CRUC-7344 Comments on lines of code disappear in a review when highlight lines are edited Open
Bug CRUC-7341 Review page OutOfMemoryError caused by large commit messages Open
Bug CRUC-7315 Collapsed comment body is not properly aligned Open
Bug CRUC-7313 Navigating to comments doesn't scroll the page to the comment when displayed "above" Open
Bug CRUC-7287 Multiple Spaces after Project Key in Smart Commit causes reviewers not to be assigned Open
Bug CRUC-7258 log4j cannot find log appenders for amazonaws Open
Bug CRUC-7245 No reviews displayed when browsing Review Dashboard as not logged in user although counters suggest otherwise Open
Bug CRUC-7239 Crucible Comment Search is Case Sensitive Open
Bug CRUC-7237 Every user admin action leaves old url Open
Bug CRUC-7229 Esc key cancels "Edit Details" when "Wiki Markup Tips" is open Open
Showing 20 out of 22 issues Refresh

Crucible 3.7 upgrade notes

Please also see:

Supported platform upgrades

Known issues for Crucible 3.7

Loading
T Key Summary Status
Bug CRUC-7292 Adding changesets from branch is broken when specific priviledges apply to repos Open
Bug CRUC-7186 Error when trying to add the latest revision of a file to a Review if comment is present on previous revision Open
Bug CRUC-1689 ArrayIndexOutOfBoundsException thrown when trying to expand files in crucible. Open
Bug CRUC-7728 Pressing 'r' for reply in a comment thread replies to the top comment and not the current one Open
Bug CRUC-7344 Comments on lines of code disappear in a review when highlight lines are edited Open
Bug CRUC-7225 Browsers have problem processing big revisions Open
Bug CRUC-7220 Revisions from closed heads are considered ancestors for files Open
Bug CRUC-7212 Days to complete metics doesn't handle reopened and in draft state reviews Open
Bug CRUC-7209 Truncated error/warning message when updating a review Open
Bug CRUC-7201 Inconsistent diff when using branch review during initial indexing Open
Bug CRUC-7197 JIRA Blockers Report detect Abandoned Review as Open Open
Bug CRUC-7196 crucible drops the rename in patch files Open
Bug CRUC-7192 Reviews created for the first commit in a branch do not show diff information if created during indexing Open
Bug CRUC-7160 branch review auto update issue on review reopening Open
Bug CRUC-7148 crucible.py not finding matching FishEye repository for Subversion Open
Bug CRUC-7112 Trying to create a branch review for a changeset that has had a branch removed recently might pick the removed branch and show a Internal Server Error Open
Bug CRUC-6847 Remind REST API Issue Open
Bug CRUC-2351 "Remove All Revisions from Review" link formatting is broken Open

Crucible 3.6 upgrade notes

Please also see:

Supported platform upgrades

SSLv3 support disabled by default

As of Crucible 3.6, SSLv3 support is disabled by default. This shouldn't affect normal operations in supported browsers. If you need to re-enable SSLv3 support, please consult Configuring SSL cipher suites for Jetty.

Known issues for Crucible 3.6

Crucible 3.5 upgrade notes

An upgrade from an earlier version of FishEye/Crucible to 3.5.0 may cause problems if you have upgraded the Universal Plugin Manager Plugin to a newer version than is shipped with FishEye/Crucible 3.5.0.

The workaround for this is to remove the custom installed version of the Universal Plugin Manager Plugin.

After upgrading from 3.4.5 to 3.5.0, this error is printed in the web browser when you try to access some pages:

javax.servlet.jsp.JspException: javax.el.ELException: java.lang.NullPointerException: couldn't locate WebResourceIntegration service

Workaround:

  • Stop the new FishEye instance;
  • Remove your newer version of the Universal Plugin Manager Plugin at $FISHEYE_INST/var/plugins/user/plugin.xxxxxx.atlassian-universal-plugin-manager-plugin*.jar;
  • Start the new FishEye instance again.

Please also see:

Known issues for Crucible 3.5

Crucible 3.4 upgrade notes

Please also see:

Windows installer

We've produced 32-bit and 64-bit installers for Crucible on Windows. Each installer adds Crucible as a Windows service, and starts the service, automatically. The express install creates, by default, a Data directory and a separate install directory  in C:\Atlassian. The custom install mode allows you to choose different locations for the install and Data directories, with the restriction that the Data directory must not be contained in the install directory. The installer creates the FISHEYE_INST system environment variable.

See Installing Crucible on Windows for detailed installation instructions.

Download the Crucible installer here.

Crucible may now bind to a different IP address on Windows

Prior to Crucible 3.4, a bug in Crucible (  FE-4909 CLOSED ) meant that Crucible may not have correctly bound to the IP address you configured. This may have happened if you configured Crucible to bind to a single IP address on a network interface that has several IP addresses; Crucible may in fact have bound to a different IP address. For example, if you have an interface with the IP addresses 1.2.3.4 and 1.2.3.5, and you configured Crucible to use 1.2.3.5, it may have incorrectly bound to 1.2.3.4.

Now that the bug is fixed, Crucible 3.4, and later versions, will now correctly bind to the configured IP address, although this may now be different from the previously bound address.

v1 REST API resources deprecated

Note that the 'v1' REST API resources are deprecated and will be removed in a future release. See the FishEye Crucible REST API.

Known issues for Crucible 3.4

Crucible 3.3 upgrade notes

Please also see the Upgrade steps section above.

As previously announced, the following platforms are no longer supported by Crucible 3.3:

  • Internet Explorer 8
  • MySQL 5.0
  • PostgreSQL 8.2
  • SQL Server 2005

Please read the End of Support Announcements for Crucible.

Supported platform upgrades

  • SVN 1.8 is supported by Crucible 3.3.
  • Microsoft Internet Explorer 11 is supported by Crucible 3.3.

See the Crucible Supported platforms.

Known issues for Crucible 3.3

Crucible 3.2 upgrade notes

Please also see the Upgrade steps section above, and read the End of Support Announcements for Crucible page.

Please note the following changes in Crucible 3.2:

REST endpoint change

For Crucible 3.2, the RestReviewService.remindIncompleteReviewers() ('/rest-service/reviews-v1/{reviewId}/remind') end point was changed from accepting 'application/x-www-form-urlencoded' content type with 'message' and 'recipient' params to 'application/json' content type with 'message' and 'recipients' JSON fields. See  https://docs.atlassian.com/fisheye-crucible/latest/wadl/crucible.html#d2e1881.

User data is moved from data0.bin to the SQL database

An upgrade task is run on startup that moves user data to the SQL database. We are doing this to mitigate the risk of data corruption or loss.

XSRF protection

FishEye/Crucible 3.2.0 includes protection against XSRF attacks.

If you have implemented a LightSCM plugin, and have used the SimpleConfigurationServlet base class provided in the scmutils library, you will need to modify your administration page so that it performs 'delete' operations using an HTTP POST, not a GET.

You can have FishEye convert your anchor tags to form POSTs at runtime by giving them the class "anchor-post". For example, the anchor:

<a class="anchor-post" href="#" data-href="./fsscm?name=TEST&delete=true">Delete</a>

will be converted into a form which POSTs to ./fsscm with form parameters name=TEST and delete=true.

Internally managed Git repositories no longer supported

As previously announced, internally managed Git repositories are no longer supported by FishEye 3.2.

Please read the migration guide for information about options and procedures for migrating your internally managed Git repositories – note that we recommend that you upgrade to FishEye 3.2 before migrating any internally managed repositories.

Supported platform upgrades

See the Crucible Supported platforms.

Known issues for Crucible 3.2

Crucible 3.1 upgrade notes

Please also see the Upgrade steps section above, and read the End of Support Announcements for Crucible page.

Please note the following changes in Crucible 3.1:

Crucible 3.1 Merge some per-repository Lucene indices into a global cross-repository Lucene index

Crucible 3.1 has greatly improved performance and scalability for QuickSearch and QuickNav. To achieve this, the per-repository 'METADATA' Lucene indices will be moved into a single global cross-repository Lucene index. This means Crucible is able to search across more repositories in less time because now only a single search index needs to be queried instead of the previous N. Merging these indices into the single cross-repository index can be refreshed in two ways:

  1. Recommended: As an upgrade task that is run automatically when Crucible 3.1 is run for the first time.
  2. As an offline process on a separate staging server.

During the automatic upgrade task, Crucible is fully usable and functional, although search results for files, commits and committers may be incomplete.

In our testing we have found that the automatic upgrade task took 4 hours to complete on a Crucible instance with 144 repositories of different kinds, with 58 GB of data in the FISHEYE_INST folder (excluding logs). We are confident that the automatic upgrade task is suitable for the majority of production Crucible installations. It is worth repeating that the instance was fully functional (reviews, JIRA Integration, Activity Streams, Charts etc) apart from Quick Nav and Quick Search during this time.

Nevertheless, where required, we provide instructions for performing the reindex as an offline process on a separate staging server.

Plugin Settings will be moved from the config.xml to the SQL database

As of Crucible 3.1.0, plugin settings which were previously stored in the <properties> element inside config.xml will be stored in the SQL database. This includes settings for any bundled plugins such as ApplicationLinks, the UniversalPluginManager etc, and any 3rd party plugins. 

An upgrade task is run on startup which will first insert all the properties found in config.xml into a new table in the SQL database. Once successful, the properties are removed from config.xml. 

As part of this change, the RepositoryOptions.setProperties (Map<String, String>properties) and RepositoryOptions.getProperties() methods have been removed from our API. If you are using a plugin which uses either of these methods, you will need to update the plugin to a version which uses the Spring component PluginSettingsFactory. Plugins can use this to access the migrated global and per-repository properties that were previously available via the old RepositoryOptions API. 

Known issues for Crucible 3.1

Crucible 3.0 upgrade notes

Please also see the Upgrade steps section above.

Please note the following changes in Crucible 3.0:

Jetty 8

Crucible 3.0 now uses Jetty 8 as its web server and Java servelet container. This change should be completely transparent when you upgrade to Crucible 3.0. However, if you have customized either your jetty-web.xml file, or the maxFormContentSize system property, you will need to update those in the new version. See Enabling Access Logging in FishEye and this FishEye KB page for more information.

Infinity DB

Crucible 3.0 now uses the InfinityDB 3.0 database internally to provide improved performance for concurrent access to Crucible. This change is transparent to users in all respects.

Pipelined indexing

Crucible 3.0 introduces a new indexing approach that splits the repository indexing process into separate tasks that can be performed in a phased and concurrent way. Users will benefit from the way in which Crucible functionality, such as review creation, now becomes available as indexing progresses. This change is transparent to users in all other respects. See Pipelined indexing.

Improved handling of user preferences with session cookies 

Upgrading may result in some users losing their preferences.

SQL Server transaction isolation configuration

We recommend a configuration change for SQL Server to use snapshot mode for the transaction isolation level – see Migrating to SQL Server. This change avoids occasional database deadlocks, and prevents performance warning messages in the logs and admin screens.

Known issues for Crucible 3.0

Checking for known issues and troubleshooting the Crucible upgrade

If something is not working correctly after you have completed the steps above to upgrade your Crucible installation, please check for known Crucible issues and try troubleshooting your upgrade as described below:

  • Check for known issues. Sometimes we find out about a problem with the latest version of Crucible after we have released the software. In such cases we publish information about the known issues in the Crucible Knowledge Base. Please check the Fisheye and Crucible Known Issues in the Crucible Knowledge Base and follow the instructions to apply any necessary patches if necessary.
  • Did you encounter a problem during the Crucible upgrade? Please refer to the guide to troubleshooting upgrades in the Crucible Knowledge Base.
  • If you encounter a problem during the upgrade and cannot solve it, please create a support ticket and one of our support engineers will help you.

 

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport