Elastic Bamboo configuration settings include information that is required for Elastic Bamboo to work and parameters for optional features. These settings are divided into three logical groups:

On this page:

All three groups of settings are located on the Elastic Bamboo Configuration screen (see screenshot). The instructions below describe how to update each of the groups of settings separately, but you can update all of the settings at once, if you wish.

If you have disabled remote agent support, you must enable it before you can enable Elastic Bamboo. The Disabling Remote Agents Support documentation also contains instructions on how to enable remote agent support.

Screenshot: 'Elastic Bamboo Configuration' (click to view full-size image)

Amazon Web Services (AWS) Settings

 

Before you can use Elastic Bamboo in your Bamboo instance, you must enter your Amazon Web Services (AWS) account details into the Bamboo application. If you do not have an AWS account, you must register for one on the AWS registration page before you can enable Elastic Bamboo.

Elastic Bamboo dynamically creates and runs remote agents in the Amazon Elastic Compute Cloud (EC2). Hence, if you choose to use Elastic Bamboo, you will be charged by Amazon for your EC2 compute usage (separate to your Bamboo license fee). These charges will be billed to the AWS account that you provide. Please read Elastic Bamboo Costs for more details.


To configure your Amazon Web Services (AWS) account details,
(warning) Please note, if you change your AWS account details, Bamboo will stop all elastic agents that are currently running.

  1. Click the 'Administration' link in the top navigation bar.
  2. Click the 'Configuration' link in the left navigation column under the 'Elastic Bamboo' sub-header. The 'Elastic Bamboo Configuration' screen will display.
  3. Click the 'Edit' button to edit your Elastic Bamboo configuration.
  4. Enter or update your 'AWS Access Key ID'.
  5. Check the 'Change AWS Secret Access Key?' checkbox, if you wish to enter or update your AWS Secret Access Key. The 'AWS Secret Access Key' field will display. Enter or update 'AWS Secret Access Key' as desired.

    Your AWS Access Key ID and AWS Secret Access Key are used together to identify yourself when accessing Amazon EC2 services. If you are unsure what your AWS Account ID and AWS Secret Access Key are, please refer to the Amazon documentation on AWS access identifiers.

  6. Click the 'Save' button to update your Account Details. If the details you have provided are invalid, a validation message will display and you will be required to update your account details to correct the error.

Elastic Bamboo Global Settings

 

Elastic Bamboo provides you with a number of global configuration options to help you optimise EC2 usage for your Bamboo builds. These settings control how the Bamboo server operates and how it manages its elastic instances and agents.

To configure your Elastic Bamboo global settings,

  1. Click the 'Administration' link in the top navigation bar.
  2. Click the 'Configuration' link in the left navigation column under the 'Elastic Bamboo' sub-header. The 'Elastic Bamboo Configuration' screen will display.
  3. Click the 'Edit' button to edit your Elastic Bamboo configuration.
  4. Your elastic instance settings will be displayed under the 'Elastic Instance Settings' header. Update these settings as desired:
    • Maximum Number of Elastic Instances — this setting controls how many elastic agents can be running at one time. For example, you may wish to change this setting to a small value if you are concerned about EC2 compute costs, and you have a large number of concurrent builds that cannot be supported by your non-elastic agents.
    • Automatically shut down elastic instance when elastic agent process ends — this setting controls whether your elastic instances will automatically shut down after the elastic agents running on them end. If you have automated the starting and stopping of elastic agents (i.e. via the Bamboo Remote API), you can use this option to automatically shut down their instances as well.
      • Shutdown Delay — this setting will only display if you have checked the 'Automatically shut down elastic instance when elastic agent process ends' option. It controls how long an elastic instance will wait before shutting down, after its elastic agent process ends.
  5. Click the 'Save' button to update your elastic instance settings.

Elastic Instance Settings

 

These settings control how elastic instances operate. This section includes settings that are used to configure elastic instances to work with the Amazon Elastic Block Store (EBS).

Using EBS with your elastic instances can significantly reduce the amount of data transfer required to run a build, compared with starting a clean elastic instance. To find out more about this feature and how to set it up in Elastic Bamboo, read Configuring Elastic Instances to use EBS.

To configure your elastic instance settings,

  1. Click the 'Administration' link in the top navigation bar.
  2. Click the 'Configuration' link in the left navigation column under the 'Elastic Bamboo' sub-header. The 'Configure Elastic Bamboo' screen will display (see screenshot below).
  3. Click the 'Edit' button to edit your account details.
  4. The 'Elastic Bamboo Configuration' screen will display. Update your elastic instance settings as desired:
    • Upload AWS account identifiers to new elastic instances (mandatory if EBS Snapshot ID specified) — Check this option to upload the AWS Account Private Key File and Account Certificate File to all new elastic instances started. This is mandatory if you wish to use EBS to store snapshot build information. However, you can also check this option if you are not using EBS (e.g. if you wish upload the AWS account identifiers in order to use Amazon's AWS command line tools).
      • Account Private Key File — this setting will only display if you have checked the 'Upload AWS account identifiers to new elastic instances (mandatory if EBS Snapshot ID specified)' option. You must specify the location of this file (on your Bamboo server) to use the Amazon EBS with Elastic Bamboo.
      • Account Certificate File — this setting will only display if you have checked the 'Upload AWS account identifiers to new elastic instances (mandatory if EBS Snapshot ID specified)' option. You must specify the location of this file (on your Bamboo server) to use the Amazon EBS with Elastic Bamboo.

        If you haven't downloaded an AWS private key file or certificate file to your Bamboo server yet, please see Generating your AWS Private Key File and Certificate File for instructions.

  5. Click the 'Save' button to update your elastic instance settings.