All Versions

   Bamboo 5.0.x
   Bamboo 4.4.x
   Bamboo 4.3.x
   Bamboo 4.2.x  
   More... 

Bamboo 3.0 Documentation

Index
Downloads (PDF, HTML & XML formats)

This documentation relates to an earlier version of Bamboo.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata
Bamboo 101

Thank you for choosing Bamboo. To help you get up and running quickly, we've compiled some easy instructions for configuring and using Bamboo.

Getting Started

1. Installing Bamboo

First things first. If you haven't already got Bamboo up and running, carry out the following steps:

  For Windows: (click to expand)
  1. Go to the Atlassian Download Center.
  2. Download the Bamboo Standalone Windows Installer (.EXE) file.
  3. Run the Windows Installer .EXE file, choose an installation directory and a home directory.
  4. Start the Bamboo server by selecting the 'Start in Console' option from the new 'Bamboo' folder that has been created in your Windows 'Start' menu.
  5. To access Bamboo, go to your web browser and type this address: http://localhost:8085/.
  6. Follow the Setup Wizard. This will guide you through the process of setting up your Bamboo server, database and creating an Admin user.

For more help on the technical procedures in this section, see the Bamboo Installation Guide.

If you need assistance, please create a support ticket.

(warning) Before using Bamboo as a production system, you need to switch from the embedded HSQL database, which is provided for evaluation purposes only. Please see the documentation for details.

  For Mac: (click to expand)
  1. Go to the Atlassian Download Center.
  2. Download the Bamboo Standalone (Mac OS X Installer) file.
  3. Run the Mac OS X Installer .DMG file, choose an installation directory and a home directory.
  4. Start the Bamboo server by running ./bamboo.sh console in the installation root directory.
  5. To access Bamboo, go to your web browser and type this address: http://localhost:8085/.
  6. Follow the Setup Wizard. This will guide you through the process of setting up your Bamboo server, database and creating an Admin user.

For more help on the technical procedures in this section, see the Bamboo Installation Guide.

If you need assistance, please create a support ticket.

(warning) Before using Bamboo as a production system, you need to switch from the embedded HSQL database, which is provided for evaluation purposes only. Please see the documentation for details.

  For Unix or Linux: (click to expand)
  1. Go to the Atlassian Download Center.
  2. Download the Bamboo Standalone (TAR.GZ Archive) file.
  3. Extract the files to a directory of your choice. This directory will be referred to as your 'Bamboo installation directory'.
  4. Set up your Bamboo home directory by opening the file named bamboo-init.properties in the <Bamboo installation directory>/webapp/WEB-INF/classes directory. In this file, insert the property "bamboo.home", with an absolute path to your desired Bamboo home directory. e.g.
    bamboo.home=/test/bamboo-home
    (warning) Please ensure that your Bamboo home directory is not located inside the Bamboo installation directory.
  5. Start the Bamboo server by running ./bamboo.sh console in the installation root directory.
  6. To access Bamboo, go to your web browser and type this address: http://localhost:8085/.
  7. Follow the Setup Wizard. This will guide you through the process of setting up your Bamboo server, database and creating an Admin user.

For more help on the technical procedures in this section, see the Bamboo Installation Guide.

If you need assistance, please create a support ticket.

(warning) Before using Bamboo as a production system, you need to switch from the embedded HSQL database, which is provided for evaluation purposes only. Please see the documentation for details.

2. Configuring the Default Agent

  Why would I do this? (click to expand)

Your default local agent will inherit all local server capabilities that are defined in your Bamboo system. If you had system environment variables set up for builders and JDKs on your system, then the Bamboo installation process will have set them up as local server capabilities. However, if they were not automatically configured, you can configure them yourself. You may also want to set up additional custom capabilities to match specific types of builds to the agent (e.g. functional.tests=true, fast.builds=true, operating.system=linux, etc.

  To configure the default local agent: (click to expand)
  1. Click the 'Administration' link in the top navigation bar.
  2. Click the 'Agents' link in the left navigation column. The 'Agents' screen will display.
  3. Click the 'Default Agent' in the list of agents.
  4. Click the 'Add Capability link to add agent-specific capabilities that override shared capabilities (e.g. custom capability: operating.system=linux). See the following pages for detailed instructions:

Running your First Build

3. Creating a Plan

  To create a new plan in Bamboo: (click to expand)

(info) To run your build on your default agent, you will need to ensure that the capability requirements of the plan can be met by the capabilities of your default agent.

  1. Click the 'Create Plan' link in the top navigation bar. This opens the Create Plan introductory page.
  2. Click the large 'Create a New Plan' button and commence creating your new Plan as described in the Creating a Plan topic.

(tick) If you are using Atlassian's FishEye, you can link your Bamboo plan to your FishEye project when specifying your plan's source repository. Enter the URL of your FishEye project in the 'Web Repository URL' (e.g. https://svn.myrepo.com/fisheye/browse/myproject) and the Code Changes' section of a build result will display links to your files via FishEye.

(tick) You can extend Bamboo to support additional repositories, builders and build tools for your plans by installing plugins. Check out our plugin library for more information.

4. Running a Build

  To run your build: (click to expand)
  1. Click 'Home' to go to the Dashboard and click the 'All Plans' tab.
  2. Locate the relevant plan and click the 'Check Out and Build' icon:
  3. You can view the build's activity on the 'Current Activity' tab.
    (if your plan does not build, check whether all of its capability requirements can be met by the remote agent's capabilities)

(tick) You can configure your build plan to be triggered by code changes or on a schedule, rather than manually triggering it. See Triggering a Plan Build for more information.

  To view the build results: (click to expand)
  1. Click 'Home' to go to the Dashboard and click the 'All Plans' tab.
  2. Locate the relevant plan and click the plan name. The plan summary will display, showing the latest build result. You can also click the 'Completed Builds' tab to see a summary list of build results.

Using Bamboo with your Development Tools

5. Using Bamboo with your IDE

  Why would I do this? (click to expand)

Integrating Bamboo with your IDE (via an Atlassian IDE Connector) allows you to work with Bamboo from within your IDE. You won't have to switch between applications to see what's happening with your builds. You can start them, monitor them and view the results without leaving your IDE.

The Atlassian IDE Connectors are currently available for IntelliJ IDEA and Eclipse.

  To use Bamboo with Eclipse: (click to expand)
  1. Install the Atlassian Eclipse Connector by following the instructions in this document: Installing the Eclipse Connector
  2. Configure Bamboo options in Eclipse by following the instructions in this document: Configuring your Bamboo Options in Eclipse
  3. Read the following document for instructions on how to use Bamboo from within Eclipse: Working with Bamboo Builds in Eclipse
  To use Bamboo with IntelliJ IDEA: (click to expand)
  1. Install the Atlassian IntelliJ Connector by following the instructions in this document: Installing the IntelliJ Connector
  2. Configure Bamboo options in IntelliJ IDEA by following the instructions in this document: Configuring your Bamboo Options in IDEA
  3. Read the following document for instructions on how to use Bamboo from within IntelliJ: Working with Bamboo Builds in IDEA

6. Using Bamboo with JIRA

  Why would I do this? (click to expand)

Integrating Bamboo with Atlassian's JIRA allows you to access Bamboo information from within JIRA and vice versa. Your team will be able to see which issues are being actively coded, which builds have run for an issue, find the build that fixed the issue, download your distribution and much more.

  To use Bamboo with JIRA: (click to expand)
  1. Configure the JIRA plugin for Bamboo and the Bamboo plugin for JIRA on your Bamboo and JIRA servers by following the instructions in this document: Integrating Bamboo with JIRA
  2. Read the following documents for instructions on how to use Bamboo with JIRA:

7. Using Bamboo with Confluence

  Why would I do this? (click to expand)

Integrating Bamboo with Atlassian's Confluence allows you to easily access Bamboo information from within Confluence. You will be able to view the status of builds, build history and charts from within your wiki and share it with team members.

  To use Bamboo with Confluence: (click to expand)
  1. Configure the Bamboo plugin for Confluence by following the instructions in this document: Bamboo Plugin
  2. The Bamboo Plugin document also contains information on how to use the various Confluence macros made available by the Bamboo Plugin.

8. Using Bamboo with Clover

  Why would I do this? (click to expand)

If your organisation uses the Atlassian Clover code-coverage tool, Bamboo can record code-coverage details (i.e. the percentage of code covered by tests) for each build result. This can help you to monitor and improve code-coverage over your builds.

  To use Bamboo with Clover: (click to expand)
  1. Edit the plan that you wish to record code-coverage details for.
  2. Click the 'Builder' tab.
  3. Configure the Clover details for your plan, as described on Enabling the Clover Plugin.

You will now be able to view Clover code-coverage for any subsequent builds of this plan. Please see Viewing the Clover Code-Coverage for a Build Result for further details.

Collaborating with your Team in Bamboo

9. Adding User Groups and Users

  Before you create additional users, you may wish to create a non-administrator user group. Here's how (click to expand):
  1. Click the 'Administration' link in the top navigation bar.
  2. Click the 'Groups' link in the left navigation column. The 'Manage Groups' screen will be displayed.
  3. In the 'Group Name' field (in the 'Create Group' section), type a name for your new group. You can add users to this group when you create them in the next section.
  4. Click 'Save' to save your new group.
  For each of the users that you wish to add, you will need to do the following: (click to expand)
  1. Click the 'Administration' link in the top navigation bar.
  2. Click the 'Users' link in the left navigation column.
  3. Enter the 'Username', 'Password', 'Full Name', 'Email' and optionally the instant messaging 'Jabber Address' for the user.
  4. Select a user group for the user.
  5. Click the 'Save' button.

10. Configuring Notifications

  Why would I do this? (click to expand)

Bamboo can automatically notify users when certain events occur in a build. For example, if the build has hung you can ensure that an email is sent to the appropriate people. Setting up the appropriate notifications can help your users to keep in touch with build activity on Bamboo. You can also help foster collaboration between team members by configuring notifications to be sent whenever someone comments on a build result.

  To set up SMTP email and/or instant messages for Bamboo: (click to expand)

Bamboo can send notifications based on build plan configuration. For example, you may wish to send an email to all users when a build has hung. To take advantage of this feature, you will first need to configure Bamboo to send SMTP email and/or instant messages.

  To configure notifications for a build plan: (click to expand)
  1. Click 'Home' to go to the Dashboard.
  2. Click the 'All Plans' tab.
  3. Locate the plan in the list and click this icon:
  4. The 'Configuration' tab will be displayed. Click the 'Notifications' sub-tab.
  5. Add a new notification in the 'Add Build Notification' section by doing the following:
    • Specify the 'Event' and the 'Recipient Type' (this may include a child field such as 'User') for the notification.
    • Click the 'Add' button to add the notification.
  6. Repeat the last step if you want to add more notifications for the plan.
  7. Click the 'Done' button

11. Labelling Builds

  Why would I do this? (click to expand)

A label is a convenient way to tag and group build results that are logically related to each other. For example, it might not be practical for your QA team to review every build, and you need to know which builds they have reviewed. By using labels such as "qa_passed" and "qa_failed", Bamboo allows them to simply indicate which builds have passed and failed QA.

Labels can be applied to build results automatically by specifying the label(s) in a build plan (note that only Bamboo administrators can do this) or applied ad hoc to build results by Bamboo users. Labels can also be used to define RSS feeds and to control build expiry.

  To add a label to a build result: (click to expand)
  1. Go to the build result.
  2. Locate the 'Labels' link at the top of the screen (above the 'Summary' tab).
  3. Click the 'Add' link. The 'Enter labels to add to this build' textbox will display.
  4. Type the relevant label (or multiple labels, separated by commas).
  5. Click the 'Done' button.
  To view all build results with a particular label: (click to expand)
  1. Go to the build result.
  2. Locate the 'Labels' link at the top of the screen (above the 'Summary' tab).
  3. Click the label that you want to view the build results for. All build results with that label will be displayed.

12. Commenting on Build Results

  Why would I do this? (click to expand)

Comments are a useful way to record and share information about builds. Together with notifications, they can help your team to collaborate more effectively. Comments made when code was committed are automatically copied from the repository. Comments can also be manually added to a particular build result.

  To add a comment to a build result: (click to expand)
  1. From within the 'Build Result' screen, click the 'Comments' tab. A list of existing comments about this build result will be displayed.
  2. Type your comment into the 'Add Comment' box, then click the 'Save' button.

Scaling your Build System

13. Setting up Distributed Builds

  Why would I do this? (click to expand)

You can set up remote agents to distribute builds across multiple build servers. This is particularly useful if you need to run your builds in different geographic locations, or on different platforms. Installing a Bamboo agent on a new build server is a simple process and once installed, your main Bamboo server will be able to manage them.

  To set up a remote agent on a machine: (click to expand)
  1. Create a directory on the agent machine (e.g. bamboo-agent-home) to serve as the Bamboo agent home for the remote agent.
  2. On your Bamboo server, click the 'Administration' link in the top navigation bar.
  3. Click the 'Agents' link in the left navigation column. The 'Agents' screen will display.
  4. Enable remote agent support by clicking the 'Enable Remote Agent Support' link.
  5. Click the 'Install Remote Agent' link. The 'Installing a Remote Agent' screen will display.
  6. Click the 'DOWNLOAD Remote Agent JAR' button and save the JAR file to the Bamboo agent home directory on your agent machine.
  7. Copy the command under 'Running a Remote Agent' to your clipboard, e.g. java -jar atlassian-bamboo-agent-installer-2.2.4.jar http://172.20.5.83:8085/agentServer/, and execute it on your agent machine to start the remote agent.
  8. Follow the instructions on the pages linked below to set up agent-specific capabilities for your remote agent:

Once you have set up a remote agent, builds will be assigned to it, just as they are assigned to any other agent.

(info) For information on more remote agent configuration options, see the full Bamboo Remote Agent Installation Guide.

14. Building in the Cloud

(Please note, you need to have an Amazon Web Services (AWS) account to use Elastic Bamboo. If you don't have one, you will need to register for one on the AWS registration page.)

  Why would I do this? (click to expand)

The Elastic Bamboo feature allows you to run your builds in the Amazon Elastic Compute Cloud (EC2). This provides you with instant scalability for your builds, allowing you to keep your build queues short while minimising your hardware costs.

  To set up Elastic Bamboo: (click to expand)
  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 'Enable' button to enable Elastic Bamboo for your Bamboo installation. The 'Elastic Bamboo Configuration' screen will display.
  4. Enter your 'AWS Access Key ID' and 'AWS Secret Access Key' (what are these?)
  5. Click the 'Save' button.

(tick) You can configure advanced features of Elastic Bamboo on this screen, such as using the Amazon Elastic Block Store (EBS) to improve build times and customise elastic agents. Read Configuring Elastic Bamboo for more information.

  To start an elastic agent: (click to expand)

An elastic agent is essentially a remote agent that runs in the Amazon EC2. You can create elastic agents on the fly when you need them to run builds and shut them down when not required. This allows you to dynamically scale your computing resources to meet build demand.

  1. Click the 'Administration' link in the top navigation bar.
  2. Click the 'Instances' link in the left navigation column. The 'Manage Elastic Instances' screen will display.
  3. Click the 'Start New Elastic Instances' link. The 'Start New Elastic Instances' screen will display.
    An elastic agent process runs in an elastic instance and will automatically start when an instance is started.
    • Enter '1' in the 'Number of instances' field.
    • Select the 'Default' elastic image configuration in the 'Elastic Image Configuration Name' dropdown.
      (info) Your elastic agent will inherit its capabilities from this elastic image. It is possible to set up additional elastic images for use with Elastic Bamboo. Read Managing your Elastic Image Configurations for more information.
  4. Click the 'Submit' button. The 'Manage Elastic Instances' page will display, showing the startup of your new instance.

Once you have set up an elastic agent, builds will be assigned to it, just as they are assigned to any other agent.

(warning) Amazon EC2 charges for the period of time that you have an instance running. Please ensure that you remember to shut down any elastic instances you start, to minimise your costs.

Analysing and Improving your Builds

15. Generating Reports

  Why would I do this? (click to expand)

You can generate reports in Bamboo to help you identify problem areas to improve upon for your builds, based on the most common failures, tests that take longest to fix, long-running tests and more.

  To generate a report on selected authors: (click to expand)
  1. Click the 'Authors' link in the top navigation bar. The 'User and Author Statistics' screen will display.
  2. Click the 'Statistics' tab. The 'Report Parameters' screen will display.
  3. Select the parameters for your report, as follows:
  4. Click the 'Submit' button to generate your report.
  To report on build statistics per plan: (click to expand)
  1. Click the 'Reports' link in the top navigation bar. The 'Report Parameters' screen will display.
  2. Select the parameters for your report, as follows:
  3. 'Date Filter' — date range to report on.
  4. Click the 'Submit' button to generate your report.

Important Next Steps

(Please note, you need to be an Administrator to do the tasks in this section.)

16. Connecting to an External Database

Before using Bamboo as a production system, you need to switch from the default HSQL database, which is provided for evaluation purposes only. Please see the documentation for details.

17. Backing up Data

To back up your Bamboo data, and establish processes for regular backups, please see the documentation.

Thank you for using Bamboo.

Thanks for choosing Bamboo. We're always happy to help. Feel free to email or call us with any questions you have.