Installing Cruise server
Introduction
The Cruise server is the core of your system.
Installation
How to install Cruise server for Windows
You must be logged in as a user with Administrator privileges to install the Cruise server on Windows.
- Double-click the cruise-server-${version}.exe installer file and follow the prompts to install Cruise.
- During installation you will be asked to select a directory that will serve as the root path for your Cruise server installation. Cruise server will store all of its associated data in this directory by default.
- At the end of the installation, Cruise server will register itself as a windows service owned by 'Local System' and start running automatically.
- Shortcuts to Cruise will be placed on your Desktop and in your Start Menu for convenience - double-click the shortcut to go to the Cruise dashboard.
We recommend changing the owner to a login user (i.e. Administrator) and restarting the service. This is due to the fact that the 'Local System' account has limited system permissions which can lead to difficulty in running a build.
How to install Cruise server for Mac OSX
- Double-click the downloaded file to unzip the contents.
- Drag the Cruise server Application to the Applications folder.
- Cruise server will store its data in /Library/Application Support/Cruise Server
- Double-click on the Cruise Server.app icon to open the launcher.
-
While the Cruise server is starting up, you'll see a progress bar in the top left of your screen.
- Once the Cruise server has started, it will open your default browser to the Cruise dashboard page.
- To get back to the Cruise dashboard page when the server is running, click on the link in the About box of the Cruise server
How to install Cruise server for Linux
You must be logged in as root, or use sudo, to install Cruise on Linux. Cruise server also requires that the Sun Java 6 JRE is installed.
The Linux installer will create a user called cruise if one does not exist on the machine. The home directory will be set to /var/cruise. If you want to create your own cruise user, make sure you do it before you install the Cruise server
RPM based distributions (i.e. RedHat)
The Cruise server RPM installer has only been tested on RedHat Enterprise Linux 5, CentOS 5 and SUSE(Linux Enterprise Server 10 SP2).
- Run rpm -i cruise-server-${version}.noarch.rpm to install Cruise server.
Debian based distributions (i.e. Ubuntu)
The Cruise server installer has only been tested on Ubuntu 7.10. However it should work on most Linux distributions which use debs.
- Run dpkg -i cruise-server-${version}.deb to install Cruise server.
Once the installation is complete the Cruise server will be started and it will print out the URL for the Dashboard page. This will be http://<server host name>:8153/cruise
How to install Cruise server for Solaris
The Cruise server installer has been tested on SunOS Solaris10 5.10.
You must be logged in as root, or use sudo or pfexec, to install Cruise under Solaris. Cruise server also requires that the Sun Java 6 JRE is installed.
The Linux installer will create a user called cruise if one does not exist on the machine. The home directory will be set to /var/cruise. If you want to create your own cruise user, make sure you do it before you install the Cruise server.
- Uncompress the package with the command gzip -d cruise-server-${version}-solaris.gz
- Install the package with the command pkgadd -d cruise-server-${version}-solaris
Location of files after installation of Cruise server
Windows
All the files for the Cruise server are under the root installation path on Windows. The default location is C:\Program Files\Cruise Server.
Linux
/var/lib/cruise-server #contains the binaries and database /etc/cruise #contains the pipeline configuration files /var/log/cruise-server #contains the server logs /usr/share/cruise-server #contains the start script
Mac OSX
/Library/Application Support/CruiseServer /Library/Logs/CruiseServer
Some logging information is also written to /var/log/system.log
Solaris
/var/lib/cruise-server #contains the binaries and database /etc/cruise #contains the configuration files /var/log/cruise-server #contains the server logs /usr/share/cruise-server #contains the start script
Entering your license key
Cruise requires you to enter a license key before you can use it. The first screen you should see upon opening the Cruise dashboard is the screen that prompts you to enter your license key. Cruise will automatically recognise a license key from version 1.0. You do not need to get a new license key if you have one already.
You should have been emailed a license key when you downloaded Cruise. If not, you can get a free trial license key from the Studios website: go to the Cruise page and follow the instructions to get your free license.
Your license key is tied to the username you used to register. Enter the username you used to register, and copy and paste the license key from your email into the textbox provided. Cruise will ignore spaces, line breaks and so forth in the license key. When you are done, click on "Save license" to save your license key. Cruise should tell you either that your license key has been updated successfully, or give you an error message telling you what went wrong.
Once you've entered your license key, you can proceed to set up your first pipeline by clicking on the "Current Activity" tab.
Artifact repository configuration
Cruise needs no configuration once installed. However, we recommend that you create a separate partition on your computer's hard disk for Cruise server artifacts. The artifact repository can grow in size very quickly. If located on your system's main partition you may experience data loss and unpredictable application behaviour as the disk fills up.
Once you have created a new disk partition, you need to tell Cruise where to find it. Go to the "Administration" tab, and click on the tab marked "Source XML". Then click on "edit" to edit Cruise's configuration file. You want to update the configuration so it looks like this:
<cruise>
<server artifactsdir="/path/to/artifacts/directory">
...
</server>
</cruise>
In Windows, you may need to assign your artifact repository partition a separate drive letter. In Windows, your configuration might look like this:
<cruise>
<server artifactsdir="E:\cruise-artifacts">
...
</server>
</cruise>
When you have entered this information, click "Save" to save the configuration file.
You can change the artifacts directory location at any time using the method described above, even when Cruise is running. However Cruise will not move existing artifacts to the new location for you, and changing the location while Cruise is running can result in data loss.
If you decide to move your artifact repository, the safe way to do it is:
- pause all pipelines and wait until all active jobs on the agent grid has completed (all agents are in the state "idle")
- shut down Cruise server
- copy the artifact repository to the new location
- edit Cruise's configuration file manually as described above to tell Cruise where to find the artifacts
- restart Cruise server
Even when all active jobs on the agent grid have stopped, users may still be uploading artifacts using the RESTful URLs. This is why we need to stop Cruise server completely in order to be safe.
