Dashboard
What is a CruiseControl Dashboard
The CruiseControl Dashboard is a powerful tool to help you visualise your projects statuses. Project builds’ statuses are colour-coded so that you can get a snapshot of how your projects are doing instantly.
When you mouse-over the project builds, represented in the coloured squares, the status is shown.
What do the squares mean?
- This indicates a project build has been successful for more than 24 hours.
- This indicates a project build has been successful for less than 24 hours.
- This indicates a project build that has failed for more than 24 hours.
- This indicates a project build that has failed for less than 24 hours.
- This indicates a project is currently building.
- This indicates an inactive project.
Here is a list of options you can do: add a project, link up the RSS feed to the project build, XML for CCTray, and access the CruiseControl JMX console.
Build Page
This is the Build page. It enables you to look at each project build and its status. You can do the following actions on each project build:
- View all successful build
- View all builds
- Force build
- Access individual project build's RSS feed and the CruiseControl JMX console
Build Detail Page
The build detail page contains project build information such as the last successful build, build number, duration of the build and the last 25 builds.
Building Page
This is the building page. Whilst the project is building, the Ant output is displayed on-screen.
Extending the project detail page
You can extend what you can see about a particular project build by adding tabs to the default ones.
Panopticode
Panopticode is provided by default. You can easily enable Panopticode views on your project builds. For more details go to CruiseControl Widgets.
Administration Page
In this page you can enter the configuration file path and edit the configuration file. You can also remove project builds via this page by manually deleting the project builds.
Installation guide
Users are free to use system properties or context parameters in web.xml to configure the dashboard application.
System property
Administrators can pass system properties through cruisecontronl.sh/cruisecontrol.bat or the startup script of the web container.
| Property | Value | Default Value | Description |
| cc.config.file | String | N/A | path to CRUISE_HOME/config.xml |
| cc.config.editable | true/false | true | whether users can edit config.xml from gui |
| cc.jmxport | int | 8000 | port of the JMX HttpAdapter |
| cc.rmiport | int | 1099 | RMI port of the JMX Controller |
| cc.config.forcebuild | enabled/disabled | enabled | whether users can force a build from gui |
Context parameter
Administrators can manually edit the web.xml to configure the dashboard application.
| Property | Value | Default Value | Description |
| cruisecontrol.config.file | String | N/A | path to CRUISE_HOME/config.xml |
| cruisecontrol.config.editable | true/false | true | whether users can edit config.xml from gui |
| cruisecontrol.jmxport | int | 8000 | port of the JMX HttpAdapter |
| cruisecontrol.rmiport | int | 1099 | RMI port of the JMX Controller |
| cruisecontrol.config.forcebuild | enabled/disabled | enabled | whether users can force a build from gui |