ControlTier > controltier-elements
 
 
PDF -icon
PDF

CruiseControl

Cruise Control continuous integration facility

Overview

Open in Workbench 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

1: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

Attributes

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

Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.

Docs-Generate

generates all defined docs

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

Open in Workbench CruiseControlSetting: CruiseControl configuration setting

Design

Super Type
Setting
Role Abstract. (Objects cannot be created.)
Instance Names Unique

CruiseControlPath

Overview

Open in Workbench CruiseControlPath: PATH to use to run Cruise Control

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

Open in Workbench CruiseControlJavaHome: Java installation to use to run Cruise Control

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

Open in Workbench CruiseControlJmxPort: JMX port used by CruiseControl

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

Open in Workbench CruiseControlWebPort: Web port used by CruiseControl

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

Open in Workbench CruiseControlRmiPort: RMI port used by CruiseControl

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

Open in Workbench CruiseControlInterval: Schedule interval (in seconds) to be used for a project

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

Open in Workbench CruiseControlThreads: Maximum number of threads to be in use simultaneously to build projects

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

Open in Workbench CruiseControlMailHost: CruiseControl mail server address

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

Open in Workbench CruiseControlReturnAddress: CruiseControl returned mail address

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

Open in Workbench CruiseControlArtifact: File or directory to be published as a CruiseControl artifact

Design

Super Type
CruiseControlSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Parent Dependencies
  • Builder

Attributes

Exported Attributes
Name Property
cruiseControlArtifactName settingValue
cruiseControlArtifactType settingType