How to extend the Remote agent installation command using JVM parameters

Still need help?

The Atlassian Community is here for you.

Ask the community

Purpose

When installing a Remote agent, you may want to customize the settings for the new agent. This can be done using Java Virtual Machine (JVM) arguments, which are listed below.

Solution

As mentioned in the previous section, we can use JVM arguments to customize your Agent. Below is a non-exhaustive list of common parameters, their defaults, and supported values.

Please scroll horizontally to see all columns

UsageParameterDefaultAccepted values
Change the Bamboo Home directorybamboo.home$USER_HOME/bamboo-agent-homeLocation Path
Change the Bamboo Home directory (alternative)bamboo.agent.home$USER_HOME/bamboo-agent-homeLocation Path
Set a custom SSL Truststorejavax.net.ssl.trustStoreJVM's builtin truststoreFilepath
Set a custom SSL Keystorejavax.net.ssl.keyStoreFileDefault keystoreFilepath
Set a custom SSL Keystore Passwordjavax.net.ssl.keyStorePasswordchangeitString (password)
Set a custom SSL Keystore Typejavax.net.ssl.keyStoreTypeJava Key Store (JKS)

KeyStoreType ENUM values, including:

  • JKS
  • PKCS12
Ignore SSL Certificate Namebamboo.agent.ignoreServerCertNamefalse

Boolean:

  • true
  • false
Set the Java Versionjava.versionVersion of installed JDKVersion number
Set the JVM Vendorjava.vm.vendorVendor of installed JDKString (vendor name)
Set the File Encodingsun.jnu.encodingDefault System encodingEncoding code (eg: UTF-8)
Change the HTTP connection timeoutbamboo.agent.http.client.timeout300Integer (seconds)
Change the number of HTTP connection retriesbamboo.agent.http.client.retries10Integer


These can be added into the installer command as follows:

java [parameters] -jar atlassian-bamboo-agent-installer-X.X.jar <bamboo-server-url>/agentServer/

JVM parameters are all prefixed by -D, so bamboo.home would be added to the Java command as -Dbamboo.home.

Last modified on Dec 31, 2019

Was this helpful?

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