CruiseControl
Cruise Control continuous integration facility
Overview
CruiseControl:
Cruise Control continuous integration facility
Design
- Super Type
- Service
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name |
Constraints
Allowed Child Dependencies
- Builder
- CruiseControlJavaHome 1
- CruiseControlJmxPort 1
- CruiseControlPath 1
- CruiseControlRmiPort 1
- CruiseControlThreads 1
- CruiseControlWebPort 1
- CruiseControlZip 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- CruiseControlService
- Node
- Site
Attributes
Default port numbers are 1 more than upstream default in order to avoid conflicts with ControlTier.
Exported Attributes
| Name | Property |
|---|---|
| ccDir | deployment-install-root |
Defaults for Imported Attributes
| Name | Default |
|---|---|
| cruiseControlInterval | 300 |
| cruiseControlJavaHome | ${env.JAVA_HOME} |
| cruiseControlJmxPort | 8001 |
| cruiseControlMailHost | localhost |
| cruiseControlPath | /bin:/usr/bin |
| cruiseControlRmiPort | 1100 |
| cruiseControlThreads | 1 |
| cruiseControlWebPort | 8081 |
Commands
Docs-Generate
generates all defined docs
Generates main CruiseControl configuration, then calls Builders' Docs-Generate command to generate configuration snippets to be included in config.xml
- Usage
- Docs-Generate [-ccdir <${entity.attribute.ccDir}>] [-threads <>]
Options
| Option | Description |
|---|---|
| ccdir | The Cruise Control package installation directory |
| threads | Maximum number of threads to be in use simultaneously to build projects |
assertServiceIsDown
checks if process is down
- Usage
- assertServiceIsDown [-ccdir <${entity.attribute.ccDir}>]
Options
| Option | Description |
|---|---|
| ccdir | The Cruise Control package installation directory |
assertServiceIsUp
checks if process is running
- Usage
- assertServiceIsUp [-ccdir <${entity.attribute.ccDir}>]
Options
| Option | Description |
|---|---|
| ccdir | The Cruise Control package installation directory |
startService
start the service process
- Usage
- startService [-ccdir <${entity.attribute.ccDir}>] [-javahome <>] [-path <>] [-spawn <true>]
Options
| Option | Description |
|---|---|
| ccdir | The Cruise Control package installation directory |
| javahome | The Cruise Control JAVA_HOME directory |
| path | The Cruise Control PATH environment variable |
| spawn | Whether or not to run in background |
stopService
stops the service process
- Usage
- stopService [-ccdir <${entity.attribute.ccDir}>]
Options
| Option | Description |
|---|---|
| ccdir | The Cruise Control package installation directory |
Related Types
The following types are defined for use with CruiseControl.
CruiseControlSetting
Overview
CruiseControlSetting:
CruiseControl configuration setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
CruiseControlPath
Overview
CruiseControlPath:
PATH to use to run Cruise Control
Default: /bin:/usr/bin
Design
- Super Type
- CruiseControlSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| cruiseControlPath | settingValue |
CruiseControlJavaHome
Overview
CruiseControlJavaHome:
Java installation to use to run Cruise Control
Defaults to JAVA_HOME from environment
Design
- Super Type
- CruiseControlSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| cruiseControlJavaHome | settingValue |
CruiseControlJmxPort
Overview
CruiseControlJmxPort:
JMX port used by CruiseControl
Port number for the Java Management Extensions web interface. Default: 8001
Design
- Super Type
- CruiseControlSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| cruiseControlJmxPort | settingValue |
CruiseControlWebPort
Overview
CruiseControlWebPort:
Web port used by CruiseControl
Port number for the CruiseControl web interface and dashboard. Default: 8081
Design
- Super Type
- CruiseControlSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| cruiseControlWebPort | settingValue |
CruiseControlRmiPort
Overview
CruiseControlRmiPort:
RMI port used by CruiseControl
Port for the JMX RMI adaptor and Connector Server. Default: 1100
Design
- Super Type
- CruiseControlSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| cruiseControlRmiPort | settingValue |
CruiseControlInterval
Overview
CruiseControlInterval:
Schedule interval (in seconds) to be used for a project
How often to check for a SCM change. Default: 5 minutes
Design
- Super Type
- CruiseControlSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
- Builder
Attributes
Exported Attributes
| Name | Property |
|---|---|
| cruiseControlInterval | settingValue |
CruiseControlThreads
Overview
CruiseControlThreads:
Maximum number of threads to be in use simultaneously to build projects
Default: 1
Design
- Super Type
- CruiseControlSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| cruiseControlThreads | settingValue |
CruiseControlMailHost
Overview
CruiseControlMailHost:
CruiseControl mail server address
SMTP host with which to send mail. Attach to builders to be used for CruiseControl configuration generation. Default: localhost
Design
- Super Type
- CruiseControlSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
- Builder
Attributes
Exported Attributes
| Name | Property |
|---|---|
| cruiseControlMailHost | settingValue |
CruiseControlReturnAddress
Overview
CruiseControlReturnAddress:
CruiseControl return email address
Return address of CruiseControl-sent emails. Attach to builders to be used for CruiseControl configuration generation.
Design
- Super Type
- CruiseControlSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
- Builder
Attributes
Exported Attributes
| Name | Property |
|---|---|
| cruiseControlReturnAddress | settingValue |
CruiseControlArtifact
Overview
CruiseControlArtifact:
File or directory to be published as a CruiseControl artifact
Adds an artifactspublisher tag to the CruiseControl configuration. Attach to builders.
Design
- Super Type
- CruiseControlSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
- Builder
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| cruiseControlArtifactName | settingValue | |
| cruiseControlArtifactType | settingType | Allowed values: file or dir |