Configuring remote agent capabilities using bamboo-capabilities.properties

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

You can define the capabilities for a specific remote agent by using a configuration file on the agent machine. When the Bamboo agent starts up, it will look in the current runtime directory (i.e. <bamboo-agent-home>/bin) for a file named bamboo-capabilities.properties. The capabilities defined in that file will then be published for the Bamboo agent after registering.

We are aware of an issue that prevents a remote agent capability from being updated once it has been added using the bamboo-capabilities.properties file. If you choose to add capabilities with the bamboo-capabilities.properties file, you will only be able to update them by deleting the capability in Bamboo and restarting the remote agent. Please see BAM-4213 for further details.

To configure remote agent capabilities:

  1. Shut down the remote agent, if it is running.
  2. Create a file named bamboo-capabilities.properties in the current runtime directory (i.e. <bamboo-agent-home>/bin) on the agent machine.
  3. Edit the bamboo-capabilities.properties file to add capabilities. You need to use the formats shown below:
    Notes: 

    • Use '\' to escape spaces, periods and backslashes ('\'). 
    • All capabilities, other than custom capabilities, should start with 'system'. 

    JDK capabilities

    system.jdk.JDK\ <jdk number>=<jdk location>

    Examples:

    system.jdk.JDK\ 1.6=/System/Library/Frameworks/JavaVM.framework/Versions/1.6
    system.jdk.JDK\ 1.6=C:\\Program Files\\Java\\jdk6.0.17

    Executable capabilities

    system.builder.<executable type>.<executable label>=<executable path>

    Examples:

    system.builder.ant.Ant=/opt/apache-ant-1.7.1
    system.builder.maven.Maven\ 1=/opt/maven-1.0.2
    system.builder.mvn2.Maven\ 2=/opt/maven-2.0
    system.builder.node.Node.js\ 0.12=/opt/node-0.12/bin/node

    Version control capabilities

    system.<DVCS>.executable=<DVCS command location> 

    Examples: 

    system.git.executable=/usr/bin/git
    system.hg.executable=/usr/bin/hg

    Perforce capabilities

    system.p4Executable=<perforce executable location>
    Example: 

    system.p4Executable=/usr/bin/p4

    Custom capabilities

    <custom capability name>=<custom capability value> 

    Example: 

    system.os=osx
  4. Save your changes to the bamboo-capabilities.properties file.
  5. Start up your remote agent. The capabilities defined in the bamboo-capabilities.properties file will be configured for your agent.

     

Last modified on Feb 5, 2019

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.