To upgrade from a previous version of Cruise, it is only necessary to upgrade the Server. It is not necessary to stop or backup the Cruise Agents. Agents will automatically update to the correct version of Cruise.
It is possible to backup the Cruise server while the server is still running. However we recommend that you stop and backup the server manually before performing these steps.
Before you start
Since Cruise 1.1, we do not include a bundled version of the Subversion version control system.
This means that if you use Subversion for your projects the server and all Cruise Agents need to have Subversion installed and available on the system path.
Since Cruise 1.2, we do not include a bundled version of ANT.
This means that if you use ANT for your projects the server and all Cruise Agents need to have ANT installed and available on the system path.
Backing up your data
Backup the cruise-config.xml file
In linux/unix installations this can be found in /etc/cruise
On Windows this is in [Cruise install directory]\config - normally this would be C:\Program Files\Cruise Server\config
On Macintosh OSX this folder is found in /Library/Application Support/Cruise Server
Backup the Cruise server's db directory
On linux this is found in /var/lib/cruise-server/db
On Windows this is in [Cruise install directory]\db - for a default installation this would be C:\Program Files\Cruise Server\db
On Macintosh OSX this folder is found in /Library/Application Support/Cruise Server/db
Backup the Cruise server's artifacts directory
On linux this is found in /var/lib/cruise-server/logs as default installation.
On Windows this is in [Cruise install directory]\logs - for default installation this would be C:\Program Files\Cruise Server\logs
On Macintosh OSX this folder is found in /Library/Application Support/Cruise Server/logs
Upgrading to the new version
You do not need to stop the Agents to perform an upgrade. Cruise agents will automatically update to the correct version of the software. You do not need to upgrade the Cruise agents. Any builds in progress will be rescheduled, and the existing pipelines will complete as expected.
Cruise will perform upgrades of its internal data structures when it starts. This process may take some time for installations with a large number of historical builds (10 to 15 minutes on very large installations). If you suspect that there is a problem with the upgrade, check the cruise-server.log to see if there are any reported errors. This is a one-time migration and subsequent restarts will be much faster.
Run the Cruise installer. Make sure that you specify the same directory as your previously installed version.
If you have changed the Cruise Server Windows service to run as a different user, you will need to repeat this configuration change.
The installer will automatically start the service. Once Cruise completes its internal data changes, you should be able to see the Cruise webpage. Any existing Agents should automatically reconnect. Any builds in progress should continue, or be rescheduled.
Debian based distributions (i.e. Ubuntu)
Run the Cruise installer as described 'sudo dpkg -i [cruise-server-package-name]'.
RPM based distributions (i.e. RedHat)
Run the Cruise installer as described 'sudo rpm -U [cruise-server-package-name]'.
The Macintosh OSX version of Cruise is packaged as a normal Macintosh Application. you can drag the application to your preferred location (normally the /Applications folder) and double-click it to start. To remove the previous version, drag it to the Trash.
The Solaris version is new in Cruise 1.2. You should follow the installation guide for a new version.