Installing Cruise Agent
Introduction
Installation
How to install Cruise Agent for Windows
You must be logged in as a user with Admin privileges to install the Cruise Agent on Windows.
- Double-click the cruise-agent-${version}.exe installer file and follow the prompts to install Cruise.
- During installation you will be asked to select a directory to install the Cruise Agent in to. This will also be the directory where the agent checks out and builds the code.
-
After installing the files, the installer will prompt you for the hostname or IP address of the Cruise Server. If you leave this blank it will default to the local machine.
- At the end of the installation, Cruise Agent registers itself as a windows service and starts running automatically.
How to install Cruise Agent for Mac OSX
- Double-click the downloaded file to unzip the contents.
- Drag the Cruise Agent.app icon to the Applications folder. This will also be the directory where the agent checks out and builds the code.
- Double-click on the Cruise Agent.app icon to open the launcher.
-
The very first time you run the Cruise Agent on your machine you will be prompted for the hostname or IP address of your Cruise Server. By default it will try connecting to the local machine. Click the OK button to continue.
How to install Cruise Agent for Linux
The 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 Agent. You must be logged in as root, or use "sudo", to install Cruise under Linux. Cruise Agent also requires that the Sun Java 6 JDK is installed.
RPM based distributions (ie RedHat)
The Cruise Agent RPM installer has only been tested on RedHat Enterprise Linux 5 and CentOS 5. However it should work on most Linux distributions which use rpms.
- Run 'sudo rpm -i cruise-agent-${version}.noarch.rpm' to install Cruise Agent.
Debian based distributions (ie Ubuntu)
The Cruise Agent .deb installer has only been tested on Ubuntu 7.10. However it should work on most Linux distributions which use debs.
- Run 'sudo dpkg -i cruise-agent-${version}.deb' to install Cruise Agent.
Once the package has been installed you need to configure the hostname or IP address of your Cruise Server and start the agent. To do this, do the following:
- Open '/etc/default/cruise-agent' in your favourite text editor.
- Change the line 'CRUISE_SERVER=127.0.0.1" to list the hostname or IP address of your Cruise Server.
- Save the file and exit your editor.
- Run '/etc/init.d/cruise-agent start' to start the agent.
How to install Cruise Agent for Solaris
The 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 Agent. You must be logged in as root, or use "sudo", to install Cruise under Solaris. Cruise Agent also requires that the Sun Java 6 JDK is installed.
- Uncompress the package with the command 'gzip -d cruise-agent-${version}-solaris.gz'
- Install the package with the command 'sudo pkgadd -d cruise-agent-${version}-solaris'
- By default the agent will try connecting to localhost as the server. To change this, run:
- svccfg -s svc:/application/cruise/agent:default setprop cruise-agent/server = <Server hostname or IP>
- svcadm refresh svc:/application/cruise/agent
- svcadm restart svc:/application/cruise/agent
File location after installations of Cruise Agent
Windows
All the files of Cruise Agent are under the installed directory on Windows, the default location is c:/Program Files/Cruise Agent.
linux
/var/lib/cruise-agent
/etc/default/cruise-agent
/var/log/cruise-agent
/usr/share/cruise-agent
Mac OSX
/Applications/Cruise Agent
/Library/Logs/CruiseAgent
agentbootstrapper.log information is in /var/log/system.log
Solaris
/var/cruise-agent
/usr/share/cruise-agent
/var/log/cruise-agent
Registering your Agent with the Server
For security reasons, all newly installed Cruise Agents need to be approved on the Cruise Server before it will allocate work to them. This prevents unauthorized people getting access to your source code. To approve a newly installed Cruise Agent, do the following:
- Open the Cruise Server dashboard
-
Click on the "Agents" tab and find the Cruise Agent you've just installed on the list
-
Click on "Approve" and the agent listing will turn green. The Cruise Server will now schedule work for this agent
