GoCD Configuration Reference

<cruise>
    <server>
        <siteUrls>
            <siteUrl/>
            <secureSiteUrl/>
        </siteUrls>
        <security>
            <ldap>
                <bases>
                    <base/>
                </bases>
            </ldap>
            <passwordFile/>
            <authConfigs>
              <authConfig>
                <property>
                  <key/>
                  <value/>
                </property>
              </authConfig>
            </authConfigs>
            <roles>
                <role>
                    <policy>
                      <allow/>
                      <deny/>
                    </policy>
                    <users/>
                        <user/>
                </role>
                <pluginRole/>
                    <policy>
                      <allow/>
                      <deny/>
                    </policy>
                    <property>
                      <key/>
                      <value/>
                    </property>
                </pluginRole>
            </roles>
            <admins>
                <role/>
                <user/>
            </admins>
        </security>
        <mailhost/>
        <backup/>
        <artifacts>
            <artifactsDir/>
            <purgeSettings>
                <purgeStartDiskSpace/>
                <purgeUptoDiskSpace/>
            </purgeSettings/>
         </artifacts>
    </server>
    <elastic>
        <agentProfiles>
            <agentProfile>
                <property>
                    <key/>
                    <value/>
                </property>
            </agentProfile>
        </agentProfiles>
        <clusterProfiles>
            <clusterProfile/>
        </clusterProfiles>
    </elastic>
    <repositories>
        <repository>
            <pluginConfiguration/>
            <configuration>
                <property>
                    <key/>
                    <value/>
                </property>
            </configuration>
            <packages>
                <package>
                    <configuration>
                        <property>
                            <key/>
                            <value/>
                        </property>
                    </configuration>
                </package>
            </packages>
        </repository>
    </repositories>
    <config-repos>
      <config-repo>
        <svn />
        <hg />
        <p4 />
        <git />
        <tfs />
        <scm />
        <configuration>
            <property>
                <key/>
                <value/>
            </property>
        </configuration>
        <rules>
            <allow>
            </allow>
            <deny>
            </deny>
        </rules>
      </config-repo>
    </config-repos>
    <artifactStores>
        <artifactStore>
            <property>
                <key/>
                <value/>
            </property>
        </artifactStore>
    </artifactStores>
    <secretConfigs>
        <secretConfig>
            <description>
            </description>
            <configuration>
                <property>
                    <key/>
                    <value/>
                </property>
            </configuration>
            <rules>
                <allow>
                </allow>
                <deny>
                </deny>
            </rules>
        </secretConfig>
    </secretConfigs>
    <pipelines>
        <authorization>
            <admins>
                <user/>
                <role/>
            </admins>
            <view>
                <user/>
                <role/>
            </view>
            <operate>
                <user/>
                <role/>
            </operate>
        </authorization>
        <pipeline>
            <params>
                <param/>
            </params>
            <trackingtool/>
            <timer/>
            <environmentvariables>
                <variable>
                    <value/>
                </variable>
            </environmentvariables>
            <materials>
                <svn>
                    <filter>
                        <ignore/>
                    </filter>
                </svn>
                <hg>
                    <filter>
                        <ignore/>
                    </filter>
                </hg>
                <p4>
                    <view/>
                    <filter>
                        <ignore/>
                    </filter>
                </p4>
                <git>
                    <filter>
                        <ignore/>
                    </filter>
                </git>
                <tfs>
                    <filter>
                        <ignore/>
                    </filter>
                </tfs>
                <package/>
                <pipeline/>
            </materials>
            <stage>
                <approval>
                    <authorization>
                        <role/>
                        <user/>
                    </authorization>
                </approval>
                <environmentvariables>
                    <variable>
                        <value/>
                    </variable>
                </environmentvariables>
                <jobs>
                    <job>
                        <environmentvariables>
                            <variable>
                                <value/>
                            </variable>
                        </environmentvariables>
                        <resources>
                            <resource/>
                        </resources>
                        <tasks>
                            <fetchartifact>
                                <runif/>
                                <oncancel/>
                            </fetchartifact>
                            <ant>
                                <runif/>
                                <oncancel/>
                            </ant>
                            <nant>
                                <runif/>
                                <oncancel/>
                            </nant>
                            <rake>
                                <runif/>
                                <oncancel/>
                            </rake>
                            <exec>
                                <arg/>
                                <runif/>
                                <oncancel/>
                            </exec>
                        </tasks>
                        <artifacts>
                            <artifact/>
                        </artifacts>
                        <tabs>
                            <tab/>
                        </tabs>
                    </job>
                </jobs>
            </stage>
        </pipeline>
    </pipelines>
    <templates>
        <pipeline>
            <stage>
                ...
            </stage>
        </pipeline>
    </templates>
    <environments>
        <environment>
            <environmentvariables>
                <variable>
                    <value/>
                </variable>
            </environmentvariables>
            <pipelines>
                <pipeline/>
            </pipelines>
        </environment>
    </environments>
</cruise>

top

Configuration reference

<cruise>

The <cruise> element is the root element of the configuration.

top

<server>

The <server> element can be used to define information and attributes of the Go Server.

Attributes

Examples

<cruise>
  <server jobTimeout='30'>
  </server>
</cruise>

top

<siteUrls>

The <siteUrls> element is used to define <siteUrl> and <secureSiteUrl>.

Notes

• If both <siteUrl> and <secureSiteUrl> are not defined, GoCD URLs will use the default domain which in most cases will be http://your-go-server:8153
• If only <siteUrl> is defined and is not HTTPS, GoCD URLs will be composed from the <siteUrl> entry. In this case, the secure pages of GoCD will not be navigable.
• If only <siteUrl> is defined and is HTTPS, GoCD URLs will be composed from the <siteUrl> entry and all pages will be HTTPS.
• If only <secureSiteUrl> is defined, GoCD URLs will use the default domain for non-HTTPS pages, while HTTPs pages will be composed from the <secureSiteUrl> entry.

Examples

<siteUrls>
  <siteUrl>http://siteUrl.com</siteUrl>
  <secureSiteUrl>https://secureSiteUrl.com</secureSiteUrl>
</siteUrls>

top

<siteUrl>

The <siteUrl> element is used by GoCD Server to generate links for emails, feeds etc., where we cannot have relative URLs. For example, if you have fronted GoCD with a reverse proxy, this value should be the base URL for the proxy and not the internal GoCD address. For this reason, it is necessary to specify this configuration. Format: [protocol]://[host]:[port]. You need to define the [port] in case GoCD uses a non-standard port. The [Protocol] can be HTTP or HTTPs.

Examples

<siteUrls>
  <siteUrl>http://siteUrl.com</siteUrl>
  ...
</siteUrls>

top

<secureSiteUrl>

The <secureSiteUrl> element is used to specify value of the base HTTPS URL.Certain features in GoCD require an HTTPS(SSL) endpoint. If you wish that your primary site URL be HTTP, but still want to have HTTPS endpoints for the features that require SSL,you can use this element. Format: https://[host]:[port]. You need to define the [port] in case GoCD uses a non-standard port.

Examples

<siteUrls>
  ...
  <secureSiteUrl>https://secureSiteUrl.com</secureSiteUrl>
</siteUrls>

top

<security>

The <security> element can be used to enable authentication. If the element is not defined anyone can use Go without logging in. We currently support enabling authentication using Authorization plugin endpoint. Support for LDAP and simple password-file authentication is available out of box via the bundled plugins for the same. You can use more than one authentication mechanism if you want. Support for inbuilt LDAP and password file tags in configuration has been deprecated.

Examples

<server artifactsdir="/var/lib/go/big-artifacts-folder">
  <security>
    <authConfigs>
     <authConfig id="profile-id" pluginId="cd.go.authentication.ldap">
       <property>
         <key>Url</key>
         <value>ldap://xxx.yourcompany.com</value>
       </property>
       <property>
         <key>ManagerDN</key>
         <value>cn=Acitivity Directory LDap User,ou=InformationSystems,ou=SharedAccounts,ou=Principal,dc=xxxx,dc=yyyy,dc=com</value>
       </property>
       <property>
         <key>Password</key>
         <value>secret</value>
       </property>
       <property>
         <key>SearchBases</key>
         <value>ou=Employees,ou=Enterprise,ou=Principal,dc=xxxx,dc=yyyy,dc=com</value>
       </property>
       <property>
         <key>UserLoginFilter</key>
         <value>(sAMAccountName={0})</value>
       </property>
       <property>
         <key>UserSearchFilter</key>
         <value>(sAMAccountName={0})</value>
       </property>
       <property>
         <key>DisplayNameAttribute</key>
         <value>displayName</value>
       </property>
       <property>
         <key>EmailAttribute</key>
         <value>mail</value>
       </property>
     </authConfig>
   </authConfigs>
  </security>
</server>

top

<mailhost>

The <mailhost> element is used to configure mail notifications. Mail notifications require security to be enabled.

Examples

<mailhost hostname="mailhost.yourcompany.com" port="25" username="go-user" password="crs123" tls="false" from="go@yourcompany.com" admin="goadministrator@yourcompany.com" />

top

<backup>

The <backup> element is used to configure backups.

Examples

For example: to perform a backup once a night at 10pm on weekdays and call the /usr/local/bin/upload-to-s3 script after the backup is done.

<server>
  <backup schedule="0 0 22 ? * MON-FRI" postBackupScript="/usr/local/bin/upload-to-s3" emailOnSuccess="false" emailOnFailure="true"/>
  ...
</server>

Go uses the Quartz scheduler internally. For convenience we reproduce the Quartz cron documentation here:

Format

A cron expression is a string comprised of 6 or 7 fields separated by white space. Fields can contain any of the allowed values, along with various combinations of the allowed special characters for that field. The fields are as follows:

So cron expressions can be as simple as this: * * * * * ? or more complex, like this: 0 15 10 ? * 6L 2002-2005

Special characters

• * (“all values”) - used to select all values within a field. For example, “*” in the minute field means “every minute”.

• ? (“no specific value”) - useful when you need to specify something in one of the two fields in which the character is allowed, but not the other. For example, if I want my trigger to fire on a particular day of the month (say, the 10th), but don’t care what day of the week that happens to be, I would put “10” in the day-of-month field, and “?” in the day-of-week field. See the examples below for clarification.

• - - used to specify ranges. For example, “10-12” in the hour field means “the hours 10, 11 and 12”.

• , - used to specify additional values. For example, “MON,WED,FRI” in the day-of-week field means “the days Monday, Wednesday, and Friday”.

• / - used to specify increments. For example, “0/15” in the seconds field means “the seconds 0, 15, 30, and 45”. And “5/15” in the seconds field means “the seconds 5, 20, 35, and 50”. You can also specify ‘/’ after the ‘’ character - in this case ‘’ is equivalent to having ‘0’ before the ‘/’. ‘1/3’ in the day-of-month field means “fire every 3 days starting on the first day of the month”.

• L (“last”) - has different meaning in each of the two fields in which it is allowed. For example, the value “L” in the day-of-month field means “the last day of the month” - day 31 for January, day 28 for February on non-leap years. If used in the day-of-week field by itself, it simply means “7” or “SAT”. But if used in the day-of-week field after another value, it means “the last xxx day of the month” - for example “6L” means “the last friday of the month”. When using the ‘L’ option, it is important not to specify lists, or ranges of values, as you’ll get confusing results.

• W (“weekday”) - used to specify the weekday (Monday-Friday) nearest the given day. As an example, if you were to specify “15W” as the value for the day-of-month field, the meaning is: “the nearest weekday to the 15th of the month”. So if the 15th is a Saturday, the trigger will fire on Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you specify “1W” as the value for day-of-month, and the 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not ‘jump’ over the boundary of a month’s days. The ‘W’ character can only be specified when the day-of-month is a single day, not a range or list of days. The ‘L’ and ‘W’ characters can also be combined in the day-of-month field to yield ‘LW’, which translates to “last weekday of the month”.

• # - used to specify “the nth” XXX day of the month. For example, the value of “6#3” in the day-of-week field means “the third Friday of the month” (day 6 = Friday and “#3” = the 3rd one in the month). Other examples: “2#1” = the first Monday of the month and “4#5” = the fifth Wednesday of the month. Note that if you specify “#5” and there is not 5 of the given day-of-week in the month, then no firing will occur that month. The legal characters and the names of months and days of the week are not case sensitive. MON is the same as mon.

Examples

Here are some full examples:

Pay attention to the effects of ‘?’ and ‘*’ in the day-of-week and day-of-month fields!

Notes

• Support for specifying both a day-of-week and a day-of-month value is not complete (you must currently use the ‘?’ character in one of these fields).
• Be careful when setting fire times between mid-night and 1:00 AM - “daylight savings” can cause a skip or a repeat depending on whether the time moves back or jumps forward.

top

<artifacts>

The <artifacts> element can be used to define information related to artifacts.In this, artifact directory can be defined using <artifactsDir> and purge settings can be using <purgeSettings>

Examples

<artifacts>
  <artifactsDir>artifacts</artifactsDir>
  <purgeSettings>
    <purgeStartDiskSpace>30.0</purgeStartDiskSpace>
    <purgeUptoDiskSpace>60.0</purgeUptoDiskSpace>
  </purgeSettings>
</artifacts>

top

<artifactDir>

The <artifactsDir> element is used to define the directory where GoCD will store its information, including artifacts published by jobs.The default value is ‘artifacts’ in the folder where the GoCD Server is installed. You can use an absolute path or a relative path which will take the server installed directory as the root.

Notes:

If you specify the attribute, please check whether GoCD has permission to access that directory. Also you should be aware of that changing this value while Go Server is running won’t take effect until GoCD Server is restarted.

Examples

<artifacts>
  <artifactsDir>artifacts</artifactsDir>
  ...
</artifacts>

top

<purgeSettings>

The <purgeSettings> element is used to configure GoCD to automatically delete old artifacts when the available disk space on the server is low.

The <purgeSettings> can be configured with <purgeStartDiskSpace> and <purgeUptoDiskSpace>. If available disk space on the server is lower than <purgeStartDiskSpace> GB, GoCD will purge old artifacts till the available disk space is greater than <purgeUptoDiskSpace>GB.

Notes

• Artifacts will never be deleted if purgeStartDiskSpace and purgeUptoDiskSpace are not defined.

• If purgeStartDiskSpace is defined,purgeUptoDiskSpaceshould be defined.

Examples

<purgeSettings>
    <purgeStartDiskSpace>30.0</purgeStartDiskSpace>
    <purgeUptoDiskSpace>60.0</purgeUptoDiskSpace>
</purgeSettings>

top

<purgeStartDiskSpace>

The <purgeStartDiskSpace> element is used to define the limit of available disk space. If actual available disk space is less than the limit, GoCD will start purging the artifacts.

Notes

• It should be smaller than <purgeUptoDiskSpace>.

Examples

<purgeSettings>
    <purgeStartDiskSpace>30.0</purgeStartDiskSpace>
    ...
</purgeSettings>

top

<purgeUptoDiskSpace>

The <purgeUptoDiskSpace> element is used to define the limit of available disk space. GoCD will stop purging artifacts, when the available disk space reaches the specified limit.

Notes

• It should be greater than <purgeStartDiskSpace>.

Examples

<purgeSettings>
    ...
    <purgeUptoDiskSpace>30.0</purgeUptoDiskSpace>
</purgeSettings>

top

<ldap> [Deprecated]

The <ldap> element is used to specify the ldap server. Users can access with their username and password from this ldap server.

Attributes

Examples

<security>
  <ldap uri="ldap://xxx.yourcompany.com"
     managerDn="cn=Acitivity Directory LDap User,ou=InformationSystems,ou=SharedAccounts,ou=Principal,dc=xxxx,dc=yyyy,dc=com"
     managerPassword="password"
     searchFilter="(sAMAccountName={0})" />
     <bases>
      <base value="ou=Employees,ou=Enterprise,ou=Principal,dc=xxxx,dc=yyyy,dc=com"/>
    </bases>
  <passwordFile path="/home/go/admins.properties"/>
  <roles>
    <role name="go-admin">
      <user>Jez</user>
      <user>lqiao</user>
    </role>
  </roles>
  <admins>
    <role>go-admin</role>
    <user>lqiao</user>
  </admins>
</security>

top

<bases>

The <bases> element is used to specify a list of search bases (the distinguished name of the search base object) which defines the location in the directory from which the LDAP search begins.

top

<base>

The <base> element is used to specify a search base (the distinguished name of the search base object) defines the location in the directory from which the LDAP search begins.

  <ldap uri="ldap://xxx.yourcompany.com"
     managerDn="cn=Acitivity Directory LDap User,ou=InformationSystems,ou=SharedAccounts,ou=Principal,dc=xxxx,dc=yyyy,dc=com"
     managerPassword="password"
     searchFilter="(sAMAccountName={0})" />
     <bases>
      <base value="ou=Employees,ou=Enterprise,ou=Principal,dc=xxxx,dc=yyyy,dc=com"/>
    </bases>
  </ldap>

top

<passwordFile> [Deprecated]

The <passwordFile> element is used to specify a file which has a set of username and password pairs. The format of username and password in this file is ${username}=${password which has been encrypted with SHA1}, with one line per user.

Examples

Suppose the password file is admins.properties, which is located in /home/go. You want to create two users as Administrators:

• one username is Jez, the password encrypted with SHA1 is ThmbShxAtJepX80c2JY1FzOEmUk=
• the other one is lqiao, the password encrypted with SHA1 is TfkgShslgJepX80c2JY1trwEskT=

The configuration could look like:

<security>
  <passwordFile path="/home/go/admins.properties"/>
</security>

The username and password could be set in admins.properties as follows:

Jez=ThmbShxAtJepX80c2JY1FzOEmUk
lqiao=TfkgShslgJepX80c2JY1trwEskT

top

<authConfigs>

Using <authConfigs> element GoCD administrators can provide one or more authorization configurations to connect with the authorization server(s).

Example

<authConfigs>
    <authConfig id="file-auth-config" pluginId="cd.go.authentication.passwordfile">
    ...
    </authConfig>
    <authConfig id="ldap" pluginId="cd.go.authentication.ldap">
    ...
    </authConfig>
</authConfigs>

top

<authConfig>

The <authConfig> specifies the configuration to be used by the authorization plugin. This will usually allow administrators to configure the connection settings for your authorization plugin, and may include configuration like URLs and credentials, among others.

An authConfig should have a unique id attribute and should be associated to plugin through the pluginId attribute.

Attributes

Refer to your plugin’s documentation to know the property keys to be configured.

Example:

<authConfig id="file-auth-config" pluginId="cd.go.authentication.passwordfile" allowOnlyKnownUsersToLogin="false">
  <property>
    <key>PasswordFilePath</key>
    <value>/etc/go/password.properties</value>
  </property>
</authConfig>

top

<roles>

The <roles> element is a container for roles that users defined. It can’t be defined without <role>.

Examples

<security>
  ...
  <roles>
    <role name="go-admin">
      <user>Jez</user>
      <user>lqiao</user>
    </role>
  </roles>
</security>

top

<role>

The <role> element is used to define a group of users who perform similar tasks. Optionally, the <role> element can specify a policy which defines the permission model for the users defined as part of the current role. In a <role> element, Users are added by adding the sub-tag <users> and Policy is added by adding the sub-tag <policy>.

Notes:

• If you want to define roles, you must define an authentication method, either <ldap> or <passwordFile>.
• These roles are not associated with roles defined in LDAP; they only work within Go. For example, you can assign a role to the manual-approval in a stage, so that only the users in that role can approve the stage to run.

Examples

Two users would be in the role ‘environment-operators’, they are Jez and lqiao have access to administer all the environments expect environments matching prod_* name.

<roles>
  <role name="environment-operators">
    <policy>
        <deny action="administer" type="environment">prod_*</deny>
        <allow action="administer" type="environment">*</allow>
    </policy>
    <users>
      <user>Jez</user>
      <user>lqiao</user>
    </users>
  </role>
</roles>

top

<users>

List of users in a role.

top

One <user> element defines a particular user in a role. You can add as many as you like.

<user>

One <user> element defines a particular user in a role. You can add as many as you like.

Notes:

• The user must be in your LDAP or passwordFile.

Examples

Two users would be in the role ‘pipeline-operators’, they are Jez and lqiao.

<role name="pipeline-operators">
  <users>
    <user>Jez</user>
    <user>lqiao</user>
  </users>
</role>

<policy>

The <policy> element defines the permissions for the users belonging to the users of a role.

In a <policy> element, the allow permission can added by adding the sub-tag <allow> and deny permission can be added by adding the sub-tag <deny>.

Examples

The following policy would grant users the permissions to administer to all environments expect environments matching prod_* name.

<policy>
    <deny action="administer" type="environment">prod_*</deny>
    <allow action="administer" type="environment">*</allow>
</policy>

<allow>

The <allow> element under policy grants permissions to the defined GoCD entity based on the type, action and resource.

The value of the allow element defines the resource on which policy should be applied.

Notes:

Examples

The following policy would grant users the permissions to administer to all environments matching prod_* name.

    <allow action="administer" type="environment">prod_*</allow>

An administrator can use * to provide allow access of all type and action.

Examples

     <allow action="*" type="*">*</allow>

<deny>

The <deny> element under policy deny the access to the defined GoCD entity based on the type, action and resource.

The value of the deny element defines the resource on which policy should be applied.

Notes:

Examples

The following policy would deny the administer access to all environments matching prod_* name.

    <deny action="administer" type="environment">prod_*</deny>

An administrator can use * to deny all the access of all type and action.

Examples

     <deny action="*" type="*">*</deny>

top

<pluginRole>

The <pluginRole> element is used to define roles in GoCD. Unlike role which contains a list of users, pluginRole provides configuration to map a GoCD role to a role defined in an external authorization server managed by an Authorization plugin. e.g pluginRole can be used to define mappings between LDAP group and GoCD roles.

Optionally, the <pluginRole> element can specify a policy which defines the permission model for the users of the current role.

Notes:

Refer to your plugin’s documentation to know the property keys to be configured for the pluginRole.

Examples

<roles>
<pluginRole name="SuperAdmin" authConfigId="auth_config_id">
  <policy>
    <deny action="administer" type="environment">prod_*</deny>
    <allow action="administer" type="environment">*</allow>
  </policy>
  <property>
    <key>MemberOfAttribute</key>
    <value>memberOf</value>
  </property>
  <property>
    <key>MatchingGroups</key>
    <value>CN=Dev,OU=Groups,DC=some,DC=enterprise,DC=com</value>
  </property>
</pluginRole>
</roles>

top

<admins>

The <admins> element specifies which users are administrators. Only administrators can open the Administration tab to maintain Go Configuration. Administrators can perform all functions in Go (including triggering pipelines, deploying to environments etc.)

Notes:

The user must be in your LDAP or passwordFile.

Examples

<security>
  ...
  <admins>
    <role>go-admin</role>
    <user>lqiao</user>
  </admins>
</security>

top

<role>

One <role> element in <admins> is used to specify a group as administrators. You can add as many as you like.

Notes:

• The role must refer to <roles>.

Examples

The users in role ‘go-admin’ would be administrators.

<admins>
  <role>go-admin</role>
  <user>lqiao</user>
</admins>

top

<user>

Notes:

• The user must be in your LDAP or passwordFile.

Examples

Two users would be administrators, they are Jez and lqiao.

<admins>
  <user>Jez</user>
  <user>lqiao</user>
</admins>

top

<role>

Notes:

• The role must be defined in <roles>.

Examples

<view>
   <user>lqiao<user>
   <role>_readonly_member<role>
</view>

<elastic>

The <elastic> element is used to provide configurations for the elastic agents.

Examples

<elastic jobStarvationTimeout="10">
  <agentProfiles>
    <agentProfile id="aws.small" pluginId="aws">
      ...
    </agentProfile>
  </agentProfiles>
</elastic>

top

<agentProfiles>

<agentProfiles> element specifies the profiles to configure elastic agents.

There can be zero or more profiles.

Examples

<agentProfiles>
  <agentProfile id="aws.small" pluginId="aws" clusterProfileId="cluster-profile-id" >
    ...
  </agentProfile>
</agentProfiles>

top

<agentProfile>

<agentProfile> specifies the configuration to be used to create an elastic-agent instance. A profile should have a unique id attribute, should be associated with a cluster via clusterProfileId attribute and with plugin through the pluginId attribute.

Attributes

Example:

<agentProfile id="ec2.small-us-east" pluginId="com.example.ec2" clusterProfileId="cluster-profile-id">
  <property>
    <key>ami-id</key>
    <value>ami-6ac7408f</value>
  </property>
  <property>
    <key>region</key>
    <value>us-east-1</value>
  </property>
</agentProfile>

top

<clusterProfiles>

<clusterProfiles> element specifies the profiles to configure clusters.

There can be zero or more cluster profile.

Examples

<clusterProfiles>
  <clusterProfile id="cluster.small" pluginId="aws">
    ...
  </clusterProfile>
</clusterProfiles>

top

<clusterProfile>

<clusterProfile> specifies the configuration to be used to to create/manage a cluster. A cluster profile should have a unique id attribute and should be associated to plugin through the pluginId attribute.

Attributes

Example:

<clusterProfile id="cluster-us-east" pluginId="com.example.ec2">
  <property>
    <key>GoServerUrl</key>
    <value>https://your-server-host:8154/go</value>
  </property>
  <property>
    <key>ClusterName</key>
    <value>Cluster</value>
  </property>
</profile>

top

<config-repos>

The <config-repos> element is a container of many <config-repo>.

Example

<cruise>
  ...
  <config-repos>
    <config-repo pluginId="json.config.plugin" id="gocd-json-config-example">
      <git url="https://github.com/tomzo/gocd-json-config-example.git" />
    </config-repo>
    <config-repo pluginId="yaml.config.plugin" id="gocd-yaml-config-example">
      <git url="https://github.com/tomzo/gocd-yaml-config-example.git" />
      <configuration>
        <property>
          <key>file_pattern</key>
          <value>**/*.gocd.yaml</value>
        </property>
      </configuration>
    </config-repo>
  </config-repos>
</cruise>

top

<config-repo>

The <config-repo> element specifies a single configuration repository. It must contain exactly one SCM material and may contain additional configuration section.

Attributes

Example

<cruise>
    ...
    <config-repos>
      <config-repo pluginId="yaml.config.plugin" id="gocd-yaml-config-example">
        <git url="https://github.com/tomzo/gocd-yaml-config-example.git" />
        <configuration>
          <property>
            <key>file_pattern</key>
            <value>**/*.gocd.yaml</value>
          </property>
        </configuration>
      </config-repo>
  </config-repos>
</cruise>

<configuration> {#config-repo-configuration}

The <configuration> element is optional part of config repo definition. Keys and values are specified and handled by particular plugin. This section can be used to customize how config repo plugin works when parsing this specific repository.

#Example

<configuration>
  <property>
    <key>file_pattern</key>
    <value>*.go.yaml</value>
  </property>
  <property>
    <key>allowed_pipelines_regex</key>
    <value>project-X-.*</value>
  </property>
</configuration>

top

<svn>

The config repo <svn> material element specifies the location of your code base in Subversion repository.

Attributes

Notes:

Go cannot automatically accept svn SSL certificates. If you are using https for svn repository, you have to go to the Server, and as the user ‘go’ do a command “svn update” to store the certificates in the cache permanently.

Examples:

<config-repo pluginId="json.config.plugin" id="repo1">
    <svn  url="http://svn-server.com/framework" />
</config-repo>

top

<hg>

The config repo <hg> material element specifies the location of your code base in a Mercurial repository. Go supports the following protocols for Mercurial: http, ssh.

Notes:

You must install Mercurial 1.5 or above on the Go Server. Go does not ship with Mercurial.

Attributes

Examples

<config-repo pluginId="json.config.plugin" id="repo1">
    <hg url="http://username:password@your-hg/"/>
</config-repo>

#Specifying a mercurial branch.

<config-repo pluginId="json.config.plugin" id="repo1">
    <hg url="http://username:password@your-hg#branch_name"/>
</config-repo>

Note: Do not use configrepo material type for config-repo pipeline material configuration when using mercurial branch as it will result in merge error.

top

<p4>

The config repo <p4> material element specifies the location of your code base in a Perforce repository.

Attributes

Notes:

Views consist of multiple mappings. Each mapping has two parts:

1. The left-hand side specifies one or more files in the depot and has the form: //depotname/file_specification
2. The right-hand side specifies one or more files in the client workspace and has the form: //clientname/file_specification

Go creates a p4 client to check out files into its sandbox with the ‘clobber’ option set. All other options use default values as defined by Perforce. Client name is generated automatically by Go. Hence, you can use anything as ‘clientname’ on the right-hand side in view mapping. The client name format is: cruise-[hostname]-[config repo id]-[a random hash code], for example “cruise-myhostname-configrepo1-wOaJ9kjpfgOLQCncki19ikXt5Q”.

Go views are in the same format as that used by Perforce itself. In fact you should be able to copy a Perforce view from your existing Perforce setup and paste it into the view section.

For example:

<config-repo pluginId="json.config.plugin" id="repo1">
    <p4 port="10.18.3.102:1666" username="userName" password="passwd">
      <view><![CDATA[
    //depot/dev/src...          //anything/src/...
    //depot/dev/test...         //anything/test/...
    //depot/dev/main/docs/...   //anything/docs/...
      ]]></view>
    </p4>
</config-repo>

top

<git>

The config repo <git> material element specifies the location of your code base in a GIT repository. Go only supports remote repositories.

Notes:

git versions 1.9 and above are supported by Go.

If ‘branch’ is defined, Go will check out the specified branch. Otherwise, Go will check out the master branch.

If there are submodules in the repository, Go will check out them as well.

While installing msysGit On Windows machines for Go server, please choose Option iii, namely Run Git and included UNIX tools from windows command prompt

If you are using git through SSH on windows, please ensure that the HOME user environment variable is set to the full path of the parent directory where the .ssh/ directory is located.

Attributes

Examples are:

<config-repo pluginId="json.config.plugin" id="repo1">
    <git url="git://127.0.0.1/precommit.git" branch="1.3branch"/>
</config-repo>

top

<tfs>

The config repo <tfs> material element specifies the location of your code base in a TFS Source repository.

Attributes

Examples are:

<config-repo pluginId="json.config.plugin" id="repo1">
    <tfs url="http://10.21.3.210:8080/tfs/New" domain="DOMAIN" username="jim" password="as802nsk9==" projectPath="$/webapp" />
</config-repo>

top

<scm>

The config repo <scm> material element specifies the location of your code base in any of the SCM repositories.

Attributes

Examples are:

<config-repo pluginId="json.config.plugin" id="repo1">
    <scm ref="e289f497-057b-46bc-bb69-8043454f5c1b"/>
</config-repo>

top

<rules>

The config repo <rules> rules element is a container for allow and deny rule. More about rules can be read from here.

Examples are:

<rules>
    <allow action="refer" type="environment">dev</allow>
    <deny action="refer" type="environment">prod</allow>
</rules>

top

<allow>

The <allow> element is the rule which allows referring the specified configured type and resource.

Attributes

Example:

<allow action="refer" type="*">*</allow>

top

<deny>

The <deny> element is the rule which denies the referral of the defined type and resource.

Attributes

Example:

<deny action="refer" type="*">*</deny>

top

<repositories>

The <repositories> element is a container of package repositories.

Example

<cruise>
  ...
  <repositories>
    <repository id="repo-id" name="repo-name">
      <pluginConfiguration id="plugin-id" version="plugin-version" />
      <configuration>
        <property>
            <key>property-name</key>
            <value>property-value</value>
        </property>
        ...
      </configuration>
      <packages>
        <package id="package-id" name="package-name"  >
          <configuration>
            <property>
                <key>property-name</key>
                <value>property-value</value>
            </property>
            ...
          </configuration>
        </package>
      </packages>
    </repository>
  </repositories>
</cruise>

top

<repository>

The <repository> element specifies a single repository. Repository must be be unique by id and name (name is case-insensitive) across repositories configuration.

Attributes

Example

<cruise>
  ...
  <repositories>
    <repository id="repo-id" name="repo-name">
      <pluginConfiguration id="plugin-id" version="plugin-version" />
      <configuration>
        <property>
            <key>property-name</key>
            <value>property-value</value>
        </property>
        ...
      </configuration>
      <packages>
        <package id="package-id" name="package-name"  >
          <configuration>
            <property>
                <key>property-name</key>
                <value>property-value</value>
            </property>
            ...
          </configuration>
        </package>
      </packages>
    </repository>
  </repositories>
</cruise>

top

<pluginConfiguration>

The <pluginConfiguration> element specifies configuration related to plugin.

Attributes

top

<configuration>

The <configuration> element specifies configuration related repository or package as one or more properties.

top

<property>

The <property> element holds key and value.

top

<key>

The <key> element specifies name of property.

top

<value>

The <value> element specifies value of property.

top

<packages>

The <packages> element specifies list of packages under a repository.

top

<package>

The <package> element specifies single package under a repository. This tag holds configuration related to package

Attributes

top

<artifactStores>

The <artifactStores> element is a container of many <artifactStore>.

Example

<cruise>
  ...
  <artifactStores>
      <artifactStore id="dockerhub" pluginId="cd.go.artifact.docker.registry">
        <property>
          <key>RegistryURL</key>
          <value>https://index.docker.io/v1/</value>
        </property>
        <property>
          <key>Username</key>
          <value>boohoo</value>
        </property>
        <property>
          <key>Password</key>
          <value>password</value>
        </property>
      </artifactStore>
    </artifactStores>
</cruise>

top

<artifactStore>

The <artifactStore> element specifies a global artifact store to publish/fetch external artifacts. It can contain zero or more <property> elements to specify the plugin properties.

Attributes

top

<secretConfigs>

The <secretConfigs> element is a container of secret configurations.

There can be zero or more secret configurations.

Examples

<secretConfigs>
  <secretConfig id="secret" pluginId="secret-plugin">
    ...
  </secretConfig>
</secretConfigs>

top

<secretConfig>

The <secretConfig> element specifies a single secret configuration. It must be unique (including case) across the entire configuration.

A secretConfig should have a unique id attribute and should be associated to plugin through the pluginId attribute.

Attributes

Example:

<secretconfig id="secret" pluginId="secret-plugin">
  <configuration>
    <property>
      <key>SecretsFilePath</key>
      <value>/users/go/secret.db</value>
    </property>
  </configuration>
</secretconfig>

top

<description>

The <description> element specifies description for the element.

Example:

<description>
This is a sample description.
</description>

top

<rules>

The <rules> element is a container for allow and deny rule. More about rules can be read from here.

Example:

<rules>
  <allow action="refer" type="*">*</allow>
  <deny action="refer" type="*">*</deny>
</rules>

top

<allow>

The <allow> element is the rule which allows the usage of the defined secret based on action, configured type and resource.

Attributes

Example:

<allow action="refer" type="*">*</allow>

top

<deny>

The <deny> element is the rule which denies the usage of the defined secret based on action, configured type and resource.

Attributes

Example:

<deny action="refer" type="*">*</deny>

top

<pipelines>

The <pipelines> element is a container of pipelines.

Attributes

Examples

<cruise>
  ...
  <pipelines group="studios">
    <pipeline name="yourproject" labeltemplate="foo-1.0.${COUNT}">
      <materials>
        <svn url="http://your-svn/"/>
      </materials>
      <stage name="ut">
    <jobs>
      <job name="linux">
        <resources>
          <resource>linux</resource>
        </resources>
        <tasks>
          <ant target="unit-test" />
        </tasks>
      </job>
    </jobs>
      </stage>
    </pipeline>
  </pipelines>
</cruise>

top

<authorization>

The <authorization> tag allows you to specify the what users and roles are able to administer, view or operate any particular group of pipelines.

top

<admins>

The <admins> element is a permission section to specify who can administer the pipeline group. Go administrators can define roles and users in the tag.

Users and Roles defined as group admins can view and operate on all pipelines in this pipeline group. They are allowed to navigate to the admin page where they can only see and edit this pipeline group which includes creating and modifying pipelines in this group,via the Pipeline Configuration Tab. They have no permission to view or modify the Pipeline Templates even if they are used by any pipeline in this group.

Note: Go Administrators (admins) defined in security tab, can administer all pipeline groups.

Examples

Given the following configuration only admins, lqiao and any users having the role ‘studios_group_admin’.

<cruise>
  ...
  <pipelines group="studios">
    <authorization>
        <admins>
           <user>lqiao</user>
           <role>studios_group_admin</role>
        </admins>
    </authorization>
    <pipeline name="yourproject" labeltemplate="foo-1.0.${COUNT}">
    ......
    </pipeline>
  </pipelines>
</cruise>

top

<view>

The <view> element is a permission section to specify who can see the pipelines under the pipeline group. You can define roles and users in the tag.

**Note:**Administrators (admins) can see all pipeline groups. Any other users or roles that are not listed under the <view> tag will be unable to see this pipeline group

Examples

Given the following configuration only administrators can operate the pipeline group, and only admins, lqiao and any users having the role ‘go_readonly_member’ can see the pipeline.

<cruise>
  ...
  <pipelines group="studios">
    <authorization>
        <view>
           <user>lqiao</user>
           <role>go_readonly_member</role>
        </view>
    </authorization>
    <pipeline name="yourproject" labeltemplate="foo-1.0.${COUNT}">
    ......
    </pipeline>
  </pipelines>
</cruise>

top

<operate>

The <operate> element specifies who can operate the pipelines under the pipeline group. You can define roles and users.

**Note:**Any users/roles that are not listed under the <view> tag will be unable to see this pipeline group (even if they are listed as being allowed to <operate> that pipeline group)

Examples

Given the following configuration, only admins, lqiao, jez and the users having the role ‘go_core_member’ can operate the pipeline group. Only admins, lqiao and the users having the role ‘go_readonly_member’ can see the pipeline (jez and go_core_member cannot).

<cruise>
  ...
  <pipelines group="studios">
    <authorization>
        <view>
           <user>lqiao</user>
           <role>go_readonly_member</role>
        </view>
        <operate>
           <user>lqiao</user>
           <user>jez</user>
           <role>go_core_member</role>
        </operate>
    </authorization>
    <pipeline name="yourproject" labeltemplate="foo-1.0.${COUNT}">
    ......
    </pipeline>
  </pipelines>
</cruise>

top

<pipeline>

The <pipeline> element specifies a single pipeline. It must be unique (including case) across the entire configuration (not only in the pipeline group).

Notes:

There should be at least one stage in one pipeline. Go uses the pipeline name to identify the pipeline. If you change the pipeline name, you will lose the history of the pipeline.

Attributes

Examples

<pipelines>
  <pipeline name="yourproject" labeltemplate="foo-1.0.${COUNT}-${svn}" lockBehavior="lockOnFailure">
  <environmentvariables>
     <variable name="FOO"><value>bar</value></variable>
   </environmentvariables>
    <materials>
      <svn url="http://your-svn/" materialName="svn" />
    </materials>
    <stage name="ut">
      <jobs>
    <job name="linux">
      <resources>
        <resource>linux</resource>
      </resources>
      <tasks>
        <ant target="unit-test" />
      </tasks>
    </job>
      </jobs>
    </stage>
  </pipeline>
</pipelines>

top

<params>

The element <params> specifies the list of parameters (Element param) elements to be used in a pipeline or a pipeline template. You can specify these under a <pipeline> and can be used anywhere inside pipeline/stage/job definition.

top

<param>

A <param> defines the parameter name that will be substituted with the paramerter value that will be substituted in a pipeline or a pipeline template.

Example:

<params>
    <param name="COMMAND">echo</param>
    <param name="WORKING_DIR">/repo/branch</param>
</params>

top

<trackingtool>

The <trackingtool> element can be used to specify links to an issue tracker. Go will construct a link based on the commit message that you can use to take you to your tracking tool (JIRA issue, Trac issue etc).

Attributes

Examples

Suppose you are using a Web Application to manage your tasks or bugs, and the link looks like http://your-trackingtool/yourproject/512, ‘512’ is your task ID. Your configuration would be:

<pipeline name="yourproject">
  <trackingtool link="http://your-trackingtool/yourproject/${ID}" regex="evo-(\d+)"/>
  ...
</pipeline>

If you check in some code with a commit message which includes the characters ‘evo-512’ then that will appear in the modification pop-up box as a link. When you click it, Go will take you to the web page http://your-trackingtool/yourproject/512.

For example: If you use Jira for your task manager, the configuration would be:

<pipeline name="yourproject">
  <trackingtool link="https://your-jira-server/browse/yourproject-${ID}" regex="##(\d+)"/>
  ...
</pipeline>

Notes: You can not define multiple tracking tools in one pipeline.

top

<timer>

The <timer> element specifies a cron-like schedule to build the pipeline.

Attributes

Examples

For example to run a pipeline once a night at 10pm on weekdays:

<pipeline name="yourproject">
  <timer>0 0 22 ? * MON-FRI</timer>
  ...
</pipeline>

Go uses the Quartz scheduler internally. For convenience we reproduce the Quartz cron documentation here:

Format

A cron expression is a string comprised of 6 or 7 fields separated by white space. Fields can contain any of the allowed values, along with various combinations of the allowed special characters for that field. The fields are as follows:

So cron expressions can be as simple as this: * * * * * ? or more complex, like this: 0 15 10 ? * 6L 2002-2005

Special characters

• * (“all values”) - used to select all values within a field. For example, “*” in the minute field means “every minute”.

• ? (“no specific value”) - useful when you need to specify something in one of the two fields in which the character is allowed, but not the other. For example, if I want my trigger to fire on a particular day of the month (say, the 10th), but don’t care what day of the week that happens to be, I would put “10” in the day-of-month field, and “?” in the day-of-week field. See the examples below for clarification.

• - - used to specify ranges. For example, “10-12” in the hour field means “the hours 10, 11 and 12”.

• , - used to specify additional values. For example, “MON,WED,FRI” in the day-of-week field means “the days Monday, Wednesday, and Friday”.

• / - used to specify increments. For example, “0/15” in the seconds field means “the seconds 0, 15, 30, and 45”. And “5/15” in the seconds field means “the seconds 5, 20, 35, and 50”. You can also specify ‘/’ after the ‘’ character - in this case ‘’ is equivalent to having ‘0’ before the ‘/’. ‘1/3’ in the day-of-month field means “fire every 3 days starting on the first day of the month”.

• L (“last”) - has different meaning in each of the two fields in which it is allowed. For example, the value “L” in the day-of-month field means “the last day of the month” - day 31 for January, day 28 for February on non-leap years. If used in the day-of-week field by itself, it simply means “7” or “SAT”. But if used in the day-of-week field after another value, it means “the last xxx day of the month” - for example “6L” means “the last friday of the month”. When using the ‘L’ option, it is important not to specify lists, or ranges of values, as you’ll get confusing results.

• W (“weekday”) - used to specify the weekday (Monday-Friday) nearest the given day. As an example, if you were to specify “15W” as the value for the day-of-month field, the meaning is: “the nearest weekday to the 15th of the month”. So if the 15th is a Saturday, the trigger will fire on Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you specify “1W” as the value for day-of-month, and the 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not ‘jump’ over the boundary of a month’s days. The ‘W’ character can only be specified when the day-of-month is a single day, not a range or list of days. The ‘L’ and ‘W’ characters can also be combined in the day-of-month field to yield ‘LW’, which translates to “last weekday of the month”.

• # - used to specify “the nth” XXX day of the month. For example, the value of “6#3” in the day-of-week field means “the third Friday of the month” (day 6 = Friday and “#3” = the 3rd one in the month). Other examples: “2#1” = the first Monday of the month and “4#5” = the fifth Wednesday of the month. Note that if you specify “#5” and there is not 5 of the given day-of-week in the month, then no firing will occur that month. The legal characters and the names of months and days of the week are not case sensitive. MON is the same as mon.

Examples

Here are some full examples:

Pay attention to the effects of ‘?’ and ‘*’ in the day-of-week and day-of-month fields!

Notes

• Support for specifying both a day-of-week and a day-of-month value is not complete (you must currently use the ‘?’ character in one of these fields).
• Be careful when setting fire times between mid-night and 1:00 AM - “daylight savings” can cause a skip or a repeat depending on whether the time moves back or jumps forward.

top

<materials>

The <materials> element specifies the source of the pipeline changes. Generally this will be your codebase in your source control repository.

Notes:

Go supports multiple materials with the restriction that every material must contain a unique “dest” folder (that is not a subfolder of any other material). Go will check out the source code into this folder for each material.

Examples

<pipeline name="yourproject" labeltemplate="foo-1.0.${COUNT}">
  <materials>
    <svn url="http://your-svn/"/>
  </materials>
  ...
</pipeline>

Multiple materials:

<pipeline name="yourproject" labeltemplate="foo-1.0.${COUNT}">
  <materials>
    <svn url="http://your-svn/" dest="svn-folder" />
    <git url="git://127.0.0.1/precommit.git" branch="1.3branch" dest="git-folder" />
    <hg url="http://your-hg/" dest="hg-folder" />
    <p4 port="10.18.3.102:1666" username="userName" password="passwd" dest="p4-folder">
      <view><![CDATA[
    //depot/dev/src...          //anything/src/...
      ]]></view>
    </p4>
  </materials>
  ...
</pipeline>

top

<filter>

The <filter> element specifies files in changesets that should not trigger a pipeline automatically. When a pipeline is triggered by files that are not ignored the filtered files will still be updated with other files. You can only define one filter under each SCM material. When you trigger a pipeline manually, it will update to most recent revision, including filtered files.

Examples

<svn url="http://your-svn/">
  <filter>
    <ignore pattern="doc/**/*.*" />
  </filter>
</svn>

top

<ignore>

The <ignore> element is used to specify a set of files that are ignored when Go checks for changes. Repository changesets which only contain these files will not trigger a pipeline automatically.

Attributes

Notes

• <ignore> can occur multiple times under <filter>.
• The pattern is relative to the root directory of the SCM repository, not the sandbox in the agent side or the materials URL.
• Ignored files are still updated when other files are updated.

Examples:

<ignore pattern="doc/**/*" />

Ignore everything under the folder ‘doc’.

<ignore pattern="doc/*" />

Ignore files under the folder ‘doc’, excluding any subfolder.

<ignore pattern="framework/helper/*.doc" />

Ignore files that are under the directory ‘framework/helper’ and the file extension is .doc.

<ignore pattern="*.pdf" />

Ignore files that are under the root directory of SCM repository and the file extension is .pdf.

<ignore pattern="**/helper/*.pdf" />

Ignore all the files that is under any ‘helper’ folder and the file extension is .pdf.

<ignore pattern="helper/**/*.pdf" />

Ignore all the files that are in the nested directory under folder ‘helper’ of the repository and the file extension is .pdf.

top

<svn>

The <svn> element specifies the location of your code base in Subversion repository.

Attributes

Notes:

Go cannot automatically accept svn SSL certificates. If you are using https for svn repository, you have to go to the Server and each Agent, and as the user ‘go’ do a command “svn update” to store the certificates in the cache permanently.

Examples:

For a Go Agent on linux with the following configuration:

<pipeline name="myproduct">
  <materials>
    <svn  url="http://svn-server.com/framework" dest="framework"/>
    <svn  url="http://svn-server.com/componentOne" dest="mycomponent"/>
  </materials>
  ...
</pipeline>

Go Agent will check out source code from http://svn-server.com/framework to /var/lib/go-agent/pipelines/myproduct/framwork, and from http://svn-server.com/componentOne to /var/lib/go-agent/pipelines/myproduct/mycomponent.

top

<hg>

The <hg> element specifies the location of your code base in a Mercurial repository. Go supports the http and ssh for Mercurial.

Notes:

You must install Mercurial 1.5 or above on the Go Server and Go Agents for the jobs need Mercurial. Go does not ship with Mercurial.

Attributes

Examples

<pipeline name="yourproject">
  <materials>
    <hg url="http://username:password@your-hg/"/>
  </materials>
  ...
</pipeline>

#Specifying a mercurial branch.

<pipeline name="yourproject_branch">
  <materials>
    <hg url="http://username:password@your-hg##branch_name"/>
  </materials>
  ...
</pipeline>

Note that # needs to be escaped with another # - hence the ## in the url above.

top

<p4>

The <p4> element specifies the location of your code base in a Perforce repository.

Notes:

Go will use directory under pipelines/{pipelineName} in agent side as Perforce root directory of perforce client workspace.

Attributes

Notes:

You do not need to specify the above attributes if you have already defined them as system variables. So if you have a P4PASSWD variable defined then you can leave out the “password” tag defined above. If you already have them defined as system variables and also in Go configuration, Go will overwrite them before running p4.

Views consist of multiple mappings. Each mapping has two parts:

1. The left-hand side specifies one or more files in the depot and has the form: //depotname/file_specification
2. The right-hand side specifies one or more files in the client workspace and has the form: //clientname/file_specification

Go creates a p4 client to check out files into its sandbox with the ‘clobber’ option set. This means, during material update all writable-but-unopened files in the workspace would be overwritten on the agent. All other options use default values as defined by Perforce. Client name is generated automatically by Go. Hence, you can use anything as ‘clientname’ on the right-hand side in view mapping. The client name format is: cruise-[hostname]-[pipeline name]-[a random hash code], for example “cruise-myhostname-mypipelinename-wOaJ9kjpfgOLQCncki19ikXt5Q”. THE GO_P4_CLIENT environment variable will have the client name used. This variable can be used in scripts to get the client name

Go views are in the same format as that used by Perforce itself. In fact you should be able to copy a Perforce view from your existing Perforce setup and paste it into the view section.

For example:

<pipeline name="perforce-example"/>
  <materials>
    <p4 port="10.18.3.102:1666" username="userName" password="passwd">
      <view><![CDATA[
    //depot/dev/src...          //anything/src/...
    //depot/dev/test...         //anything/test/...
    //depot/dev/main/docs/...   //anything/docs/...
      ]]></view>
    </p4>
  </materials>
  ...
</pipeline>

top

<git>

The <git> element specifies the location of your code base in a GIT repository. Go only supports remote repositories.

Notes:

git versions 1.7 and above are supported by Go.

If ‘branch’ is defined, Go will check out the specified branch. Otherwise, Go will check out the master branch.

If there are submodules in the repository, Go will check out them as well.

msysGit on Windows has a defect which causes an error when using Go. Please ensure to use a build which fixes this.

While installing msysGit On Windows machines for Go server or agents, please choose Option iii, namely Run Git and included UNIX tools from windows command prompt

If you are using git through SSH on windows, please ensure that the HOME user environment variable is set to the full path of the parent directory where the .ssh/ directory is located.

Attributes

Examples are:

<pipeline name="yourproject">
  <materials>
    <git url="git://127.0.0.1/precommit.git" branch="1.3branch"/>
  </materials>
  ...
</pipeline>

<pipeline name="yourproject">
  <materials>
    <git url="http://ccegit:pst@goserver.yourcompany.com/httpgit.git" />
  </materials>
  ...
</pipeline>

top

<tfs>

The <tfs> element specifies the location of your code base in a TFS Source repository.

Attributes

Examples are:

<pipeline name="webproject">
  <materials>
    <tfs url="http://10.21.3.210:8080/tfs/New" domain="DOMAIN" username="jim" password="as802nsk9==" projectPath="$/webapp" />
  </materials>
  ...
</pipeline>

<pipeline name="myproject">
  <materials>
    <tfs url="http://tfshost.tw.com:8080/tfs/DefaultCollection" domain="DOMAIN" username="jim" password="as802nsk9==" projectPath="$/webapp/component/branch" />
  </materials>
  ...
</pipeline>

top

<package>

The <package> element refers to package which is defined as part of repositories configuration.

Attributes

Example

<cruise>
  ...
  <repositories>
    <repository id="repo-id" name="repo-name">
      <pluginConfiguration id="plugin-id" version="plugin-version" />
      <configuration>
        <property>
            <key>property-name</key>
            <value>property-value</value>
        </property>
        ...
      </configuration>
      <packages>
        <package id="1234-12242-232312" name="sample-package" >
          <configuration>
            <property>
                <key>property-name</key>
                <value>property-value</value>
            </property>
            ...
          </configuration>
        </package>
      </packages>
    </repository>
  </repositories>
  <pipelines name="webproject">
    ...
    <pipeline name="webproject">
        <materials>
            <package ref="1234-12242-232312" />
        </materials>
        ...
    </pipeline>
    ...
   </pipelines>
</cruise>

top

<pipeline>

The <pipeline> element specifies that successful completion of a stage in another pipeline will trigger the current pipeline to start.

If there are multiple pipeline dependencies, then any one of them passing will trigger a new pipeline.

Note that you can not specify two (or more) dependencies for the same upstream pipeline.

Attributes

Notes:

The downstream pipeline will only run if the upstream pipeline stage has passed.

Examples

Suppose there are four pipelines: commonLib1, commonLib2, Server, and Client.

We can configure these such that:

• When the stage distStage from pipeline commonLib1 passes, it will run pipelines Server and Client
• When the stage pkgstage from pipeline commonLib2 passes, it will run the Server pipeline

The corresponding configuration would be:

<pipeline name="Server">
  <materials>
    <pipeline pipelineName="commonLib1" stageName="distStage"/>
    <pipeline pipelineName="commonLib2" stageName="pkgStage"/>
  </materials>
  ...
</pipeline>
<pipeline name="Client">
  <materials>
    <pipeline pipelineName="commonLib1" stageName="distStage"/>
  </materials>
  ...
</pipeline>

If instead, we want the Server pipeline to run when the stage commonLib2/distStage passes but not on commonLib1/pkgStage, we can set the ignoreForScheduling flag to true on the commonLib1/pkgStage material:

<pipeline name="Server">
  <materials>
    <pipeline pipelineName="commonLib1" stageName="distStage" ignoreForScheduling="true"/>
    <pipeline pipelineName="commonLib2" stageName="pkgStage"/>
  </materials>
  ...
</pipeline>

top

<stage>

The <stage> element specifies a set of jobs. If any job in a given stage fails then the stage will fail. If a stage has an <approval> configuration with manual type it can only be triggered manually (i.e. a user must click on the trigger button on the UI). If the previous stage has failed, you can still trigger the following stage manually.

Notes:

There must be at least one job in stage.

Attributes

Examples

<pipeline name="yourproject">
  ...
  <stage name="ut">
  <environmentvariables>
     <variable name="FOO"><value>bar</value></variable>
   </environmentvariables>
    <jobs>
      <job name="linux">
    <resources>
      <resource>linux</resource>
    </resources>
    <tasks>
      <ant target="unit-test" />
    </tasks>
      </job>
    </jobs>
  </stage>
</pipeline>

top

<jobs>

The <jobs> element specify the set of jobs for a stage.

Note:

<jobs> can contain several <job> elements. These jobs can run in parallel on different agents.

Examples

<stage name="ut">
  <jobs>
    <job name="linux">
      <resources>
        <resource>linux</resource>
      </resources>
      <tasks>
        <ant target="unit-test" />
      </tasks>
    </job>
  </jobs>
</stage>

top

<job>

A job is the basic unit of work. It is executed on an agent. A job can fetch artifacts from Go Server, execute tasks and publish artifacts back to Go Server.

A job can also be associated with a set of <resources> or an elastic profile through the elasticProfileId attribute. Resources are used to match a Job to an Agent. ElasticProfileId is used to match a job to an Elastic Agent. An Agent can run a Job if it has all the resources or elasticProfileId that the Job specifies.

A job cannot have both resources as well as elasticProfileId. If a Job has no resources then it can be built by any Agent (But not by an elastic agent)

Attributes

Examples

<job name="linux">
  <environmentvariables>
    <variable name="FOO">
      <value>bar</value>
    </variable>
  </environmentvariables>
  <resources>
    <resource>linux</resource>
  </resources>
  <tasks>
    <ant target="unit-test" />
  </tasks>
</job>

<job name="run-upgrade" runOnAllAgents="true" timeout='30' elasticProfileId="aws.small">
  <tasks>
    <ant target="upgrade" />
  </tasks>
</job>

<job name="run-upgrade" runInstanceCount="5" timeout='30'>
  <resources>
    <resource>linux</resource>
  </resources>
  <tasks>
    <ant target="upgrade" />
  </tasks>
</job>

top

<resources>

<resources> specifies the resources needed for a job. A job can have zero or more resources.

If a job has no resources it can be built on any agent.

Example:

<job name="linux">
  <resources>
    <resource>jdk5</resource>
    <resource>tomcat5</resource>
    <resource>mercurial</resource>
  </resources>
</job>

top

<resource>

A <resource> is a text tag that specifies a resource which a job requires to build. An Agent must have all the Resources specified for a Job to be able to run that Job.

Validations:

Resources are case-insensitive. A resource name can contain alphanumeric characters, hyphens (-), spaces, periods (.) and pipes (|).

Example:

<resources>
  <resource>jdk5</resource>
  <resource>tomcat5</resource>
  <resource>mercurial</resource>
</resources>

top

<tasks>

<tasks> specifies the tasks (like <ant>, <rake> etc) that will run as part of a job.

There can be zero or more tasks. These tasks are executed in the order specified in the configuration file. If a task fails, the subsequent tasks are not run unless they have <runif status="failed" /> defined.

The following environment variables are set for all tasks:

Examples

<job name="linux">
  <tasks>
    <ant target="unit-test" />
  </tasks>
</job>

top

<ant>

Specifies an Ant build to run. Ant is assumed to be present from the command line on the agent. Go depends on and uses JDK 1.6. If JDK 1.4 or 1.5 binaries are required by a build, it can be specified in the Ant javac task.

All paths specified are relative to the pipeline working directory.

Attributes

Examples

• Invoke Ant, specifying a set of targets to run:

  <tasks>
    <ant target="-Drun=all clean.ivy.localivy clean ft.long_running"/>
  </tasks>
  

• Invoke Ant in a specific working directory with a set of targets:

  <tasks>
    <ant workingdir="build" buildfile="mybuild.xml" target="-Drun=all clean.ivy.localivy clean ft.long_running"/>
  </tasks>
  

top

<exec>

Runs a specified command. The build fails if the command cannot be run or if it returns an error.

All paths specified are relative to the pipeline working directory.

Attributes

Examples

• Invoke ruby, specifying the working directory as tools/my-ruby-tool and executing the ruby script backup.rb.

  <tasks>
    <exec command="/usr/local/bin/ruby" args="backup.rb" workingdir="tools/my-ruby-tool"/>
  </tasks>
  

top

<arg>

Specify a single argument for exec command.

This element is optional and can occur multiple times. It serves as an alternative to the “args” attribute of exec, but it allows the use of any character required for making argument. For example, you can specify double quote using the xml escaped format: "

**Note:**When running commands on Windows, Go won’t launch your command with system shell (cmd.exe), so you can’t use shell commands (like echo) directly. If you want, you can pass your shell command as arguments to the cmd.exe.

On Windows you should specify the full name of your script file such as “mybuild.bat”. (Only specifying “mybuild” won’t work)

Examples

• Echo something on Windows:

  <exec command="cmd">
    <arg>/c</arg>
    <arg>echo</arg>
    <arg>something to print out</arg>
  </exec>
  

• Run command with pipe character in arguments:

  <exec command="MsBuild">
    <arg>D:\projects\project\project-8.sln</arg>
    <arg>/REBUILD</arg>
    <arg>/CFG="Release_99|Win32"</arg>
  </exec>
  

top

<nant>

Specifies a NAnt build to run. NAnt is assumed to be present from the command line on the agent.

All paths specified must be relative to the pipeline working directory.

Attributes

Examples

Invoke NAnt, specifying a set of targets to run:

<tasks>
  <nant buildfile="myproject.build" target="smoke-test"/>
</tasks>

top

<rake>

Specifies a Rake build to be run. Ruby and Rake are assumed to be present from the command line on the agent.

All paths specified must be relative to the pipeline working directory.

Attributes

Examples

Invoke rake, specifying a set of targets to run:

<tasks>
  <rake buildfile="rakefile" target="smoke-test"/>
</tasks>

top

<fetchartifact>

Fetch artifacts from:

• 1. previous stages in the same pipeline, or
• 2. stages of pipelines that this pipeline depends on, directly or indirectly (ancestor pipelines).

When pointed to parent/ancestor pipeline, fetch task can pull artifacts from the upstream-stage or stages before it. This restriction has been introduced in 12.2. Stages after the upstream stage can not be fetched from, because they may not be complete when the fetch call executes.

All file paths specified are relative to the pipeline working directory.

Attributes

Note: If the file does not exist, the job will fail. Go will not fetch the artifact again if it has not changed. The directory path is relative to the pipeline working directory. |

Example:

1. Fetch all artifacts in the directory ‘pkg’ from the previous stage in the same pipeline and put them under the directory ‘lib’

   <pipelines>
     <pipeline name="go">
       ...
       <stage name="dev">
         <jobs>
       <job name="unit">
         <artifacts>
           <artifact type="build" src="target/deployable.jar" dest="pkg"/>
           <artifact type="external" id="artifact_jar" storeId="dummy-s3">
             <configuration>
               <property>
                 <key>Filename</key>
                 <value>target/deployable.jar</value>
               </property>
             </configuration>
           </artifact>
         </artifacts>
       </job>
         </jobs>
       </stage>
       <stage name="ft">
         <jobs>
       <job name="functional">
         <tasks>
           <fetchartifact artifactOrigin="gocd" stage="dev" job="unit" srcdir="pkg" dest="lib"/>
           <fetchartifact artifactOrigin="external" stage="dev" job="unit" artifactId="artifact_jar">
             <configuration>
               <property>
                 <key>dest_on_agent</key>
                 <value>release_candidate.jar</value>
               </property>
             </configuration>
           </fetchartifact>
         </tasks>
       </job>
         </jobs>
       </stage>
     </pipeline>
   </pipelines>
   

2. Fetch a single artifact from a stage in the upstream pipeline ‘framework’ and put it under the directory ‘lib’

   <pipeline name="go">
     <materials>
       <pipeline name="framework" stage="ft"/>
     </materials>
     <stage name="dev">
       <jobs>
         <job name="unit">
       <tasks>
         <fetchartifact origin="gocd" pipeline="framework" stage="dev" job="unit"
                srcfile="pkg/deployable.jar" dest="lib" />
       </tasks>
         </job>
       </jobs>
     </stage>
   </pipeline>
   

3. Fetch a single artifact from a stage in an ancestor pipeline ‘Build’ and put it under the directory ‘pkg’

   <pipeline name="deploy">
     <materials>
       <pipeline name="acceptance" stage="ft"/>
     </materials>
     <stage name="deply-pkg">
       <jobs>
         <job name="deploy-win">
       <tasks>
         <fetchartifact origin="gocd" pipeline="build" stage="dist" job="create-installer"
                srcfile="installers/deployable-setup.exe" dest="installer" />
       </tasks>
         </job>
       </jobs>
     </stage>
   </pipeline>
   

top

<runif>

Specifies when a task should be allowed to run. Multiple conditions may be defined for each task.

A running job on an agent has two possible states: passed or failed. A job starts in the state “passed”. If any task fails, it transitions to the state “failed”"”.

A task can specify any of three possible runif filters: ‘passed’, ‘failed’ or ‘any’. (‘passed’ is the default)

Attributes

Notes:

<runif> can also be defined under <exec> task even if <exec> has some <arg>s e.g.

    <exec command="echo">
       <arg value="test" />
       <runif status="passed" />
    </exec>

Examples

Given the tasks in a job is following:

<tasks>
    <ant  buildfile="build.xml" target="complie-test-source"/>
    <fetchartifact origin="gocd" pipeline="my_app" stage="dist" job="package-artifact" srcdir="pkg">
       <runif  status="passed"/>
    </fetchartifact>
    <exec command="./copy_error_log_to_someplace" >
       <runif status="failed"/>
    </exec>
</tasks>

#Scenario one:

If task 1 <ant> passed, task 2 <fetchartifact> would be executed.

If task 2 <fetchartifact> passed, task 3 <exec> would NOT be executed.

If task 2 <fetchartifact> failed, task 3 <exec> would be executed.

#Scenario two:

If task 1 <ant> failed, task 2 <fetchartifact> would NOT be executed.

Instead, task 3 <exec> would be executed.

top

<oncancel>

Specifies a task to execute when a stage is cancelled. Only one task can be defined in <oncancel>.

If a job is cancelled during the assigning phase, the job will not start preparing

If a job is cancelled during the preparing phase, preparing will complete, but no tasks will be executed

If a job is cancelled during the building phase:

• If the currently running task does not have <oncancel> defined, the task will be killed
• If the currently running task does have <oncancel> defined, the task defined within <oncancel> will execute immediately. As soon as both the original task and the <oncancel> task are completed, no other tasks will execute

If a job is cancelled during the completing phase, the agent will ignore the request and complete as planned

Examples

The task ‘start_server’ starts a process on an agent. When the stage is cancelled, the agent will invoke the cancel task ‘kill_server’ to kill the process early and clean up any extra files.

<tasks>
  <ant target="start_server">
    <oncancel>
      <ant target="kill_server" />
    </oncancel>
  </ant>
</tasks>

top

<artifacts>

<artifacts> specifies what files the agent will publish to the server or an external artifact store.

Examples

<job name="unit">
  <artifacts>
    <artifact type="build" src="target/deployable.jar" dest="pkg"/>
    <artifact type="test" src="target/junit-output" dest="junit"/>
    <artifact type="external" id="docker-image" storeId="dockerhub">
      <configuration>
        <property>
          <key>Image</key>
          <value>gocd/gocd-demo</value>
        </property>
        <property>
          <key>Tag</key>
          <value>v${GO_PIPELINE_COUNTER}</value>
        </property>
      </configuration>
    </artifact>
  </artifacts>
</job>

top

<artifact>

Publish build or test artifacts to the artifact repository for the job. The src attribute should point towards a folder that contains the test output files. Go will use these to generate a test report if the artifact type is test. Test information is placed in the Failures and Test sub-tabs. Test results from multiple jobs are aggregated on the stage detail pages. This allows you to see the results of tests from both functional and unit tests even if they are run in different jobs.

Attributes

You can use wildcards to specify which files to upload to the go server in case of build or test artifacts. The wildcard syntax follows the commonly used ant/nant style. So “target/**/*.xml” would upload all xml files in the target directory and any of its subdirectories. The original directory structure is preserved on the server.

Examples for build artifact

<job name="unit">
  <artifacts>
    <artifact type="build" src="target/deployable.jar" dest="pkg"/>
  </artifacts>
</job>

<job name="unit">
  <artifacts>
    <artifact type="build" src="target/**/*Test.xml" dest="pkg"/>
  </artifacts>
</job>

The following will upload all xml files to the server’s artifact repository.

<job name="unit">
  <artifacts>
    <artifact type="build" src="target/**/*.xml" />
  </artifacts>
</job>

top

Examples for test artifact

<job name="unit">
  <artifacts>
    <artifact type="test" src="target/junit-output" dest="junit"/>
  </artifacts>
</job>

Examples for external artifact

<job name="build_image">
  <artifacts>
    <artifact type="external" id="docker-image" storeId="dockerhub">
      <configuration>
        <property>
          <key>Image</key>
          <value>gocd/gocd-demo</value>
        </property>
        <property>
          <key>Tag</key>
          <value>v${GO_PIPELINE_COUNTER}</value>
        </property>
      </configuration>
    </artifact>
  </artifacts>
</job>

top

<tabs>

The <tabs> element allows you to add tabs to the Job Details page. You can put any artifact that can be rendered by a web browser into a tab. For example, if your coverage tool produces an html report, you can easily place that report into a tab. Tabs are implemented as iframes (see W3C iframe definition ).

Example:

<job name="unit">
  <artifacts>
    <artifact type="build" src="target/jcoverage" dest="Jcoverage"/>
  </artifacts>
  <tabs>
    <tab name="coverage" path="Jcoverage/index.html"/>
  </tabs>
</job>

top

<tab>

Define a tab with specific name and artifact to show.

Attributes

Example:

Given some coverage information in ‘target/Jcoverage’ folder on the agent side, We configure a tab to show the coverage information by specifying a tab with the index.html file.

<job name="unit">
  <artifacts>
    <artifact type="build" src="target/jcoverage" dest="Jcoverage"/>
  </artifacts>
  <tabs>
    <tab name="coverage" path="Jcoverage/index.html"/>
  </tabs>
</job>

top

<approval>

Specifies how a stage should be triggered. <approval> of type ‘manual’ or ‘success’ can be used to stop a pipeline execution at the start of a stage and can only be resumed when it is manually approved on the pipeline activity page, stage details page or through RESTful url.

Attributes

Notes:

• <approval> must be the first sub-element of <stage>.
• If an approval is not specified then the behavior is same as ‘success’ i.e. the stage will be automatically triggered when the previous stage passes.
• If attribute allowOnlyOnSuccess is not specified, then the behaviour is same as false.

Example:

<stage name="ut">
  <approval type="manual" allowOnlyOnSuccess="true"/>
  ...
</stage>

top

<authorization>

You can use <authorization> under an <approval> with a ‘manual’ or ‘success’ type to specify who can approve this stage. There are two sub-elements: <user> and <role>.

Examples

<approval type="manual">
  <authorization>
    <user>lqiao</user>
    <role>go_admins</role>
  </authorization>
</approval>

<approval type="success">
  <authorization>
    <user>lqiao</user>
    <role>go_admins</role>
  </authorization>
</approval>

top

<templates>

The <templates> element specifies the set of templates known by the server.

top

<pipeline>

Allows you to provide a template for pipeline definition

Attributes

Examples

<cruise>
  ...
  <pipelines group="studios" >
    <pipeline name="yourproject" template="project-template" >
      <materials>
        <svn url="http://your-svn/"/>
      </materials>
    </pipeline>
  </pipelines>
  <templates>
    <pipeline name="project-template">
        <authorization>
            <admins>
                <user>jez</user>
            </admins>
        </authorization>
      <stage name="ut">
    <jobs>
      <job name="linux">
        <resources>
          <resource>linux</resource>
        </resources>
        <tasks>
          <ant target="unit-test" />
        </tasks>
      </job>
    </jobs>
      </stage>
    </pipeline>
  </templates>
</cruise>

top

<environments>

The <environments> element specifies the set of environments known by the server.

top

<environment>

Allows you to group a set of agents and pipelines together for exclusive use.

Attributes

Examples

<cruise>
  ...
  <pipelines group="studios" />
    <pipeline name="yourproject" labeltemplate="foo-1.0.${COUNT}" >
    ...
    </pipeline>
  </pipelines>
  <environments>
    <environment name="UAT">
      <environmentvariables>
      <variable name="FOO"><value>bar</value></variable>
      </environmentvariables>
      <pipelines>
        <pipeline name="yourproject"/>
      </pipelines>
    </environment>
  </environments>
</cruise>

top

<environmentvariables>

<environmentvariables> specifies the variables to pass to jobs and their tasks. You can specify these on a <pipeline>, <stage>, <job> or an <environment>. If the same environment variable is definied either on the agent where the job runs or on the pipeline/stage/environment of the job, the precedence is in the order <job>, <stage>, <pipeline>, <environment> and the system environment variable. For example, variable “FOO” defined in a job overrides the variable definied in the job’s stage.

top

<variable>

A <variable> defines the variable name and property value that will be passed to a job. It will be set on the system environment when the job is run. The value can be include multiple lines or CDATA. Note that the behaviour is operating system dependent. Your operating system may not allow certain variable names and/or values.

Attributes

Example:

  <environmentvariables>
     <variable name="FOO"><value>bar</value></variable>
     <variable name="MULTIPLE_LINES"><value>multiplelines</value></variable>
     <variable name="COMPLEX"><value>![CDATA[This has very <complex> data]]</value></variable>
  </environmentvariables>

top

<pipelines>

The <pipelines> element inside the <environment> element specifies the set of pipelines that it references.

top

<pipeline>

References a pipeline to be associated with this environment.

Attributes

Examples

<environment name="UAT">
  <pipelines>
    <pipeline name="yourproject"/>
  </pipelines>
</environment>

top