How to extend the Remote agent installation command using JVM parameters
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
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.
Usage | Parameter | Default | Accepted values |
|---|---|---|---|
Change the Bamboo Home directory | bamboo.home | $USER_HOME/bamboo-agent-home | Location Path |
Change the Bamboo Home directory (alternative) | bamboo.agent.home | $USER_HOME/bamboo-agent-home | Location Path |
Set a custom SSL Truststore | javax.net.ssl.trustStore | JVM's builtin truststore | Filepath |
Set a custom SSL Keystore | javax.net.ssl.keyStoreFile | Default keystore | Filepath |
Set a custom SSL Keystore Password | javax.net.ssl.keyStorePassword | changeit | String (password) |
Set a custom SSL Keystore Type | javax.net.ssl.keyStoreType | Java Key Store (JKS) | KeyStoreType ENUM values, including: JKS PKCS12 |
Ignore SSL Certificate Name | bamboo.agent.ignoreServerCertName | false | Boolean: true false |
Set the Java Version | java.version | Version of installed JDK | Version number |
Set the JVM Vendor | java.vm.vendor | Vendor of installed JDK | String (vendor name) |
Set the File Encoding | sun.jnu.encoding | Default System encoding | Encoding code (eg: UTF-8) |
Change the HTTP connection timeout | bamboo.agent.http.client.timeout | 300 | Integer (seconds) |
Change the number of HTTP connection retries | bamboo.agent.http.client.retries | 10 | Integer |
These can be added into the installer command as follows:
1
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.
The Value to the parameter can be passed as -Dbamboo.home=/var/atlassian/application-data/bamboo
Note : /var/atlassian/application-data/bamboo is an example of bamboo-home path, please replace this path with your actual bamboo-home path
Additional Agent options need to be set manually after the installation:
Was this helpful?