Bamboo 101

1. Go to the Atlassian Download Center.
2. Download the Bamboo 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.

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.

1. Go to the Atlassian Download Center.
2. Download the Bamboo (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.

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.

1. Go to the Atlassian Download Center.
2. Download the Bamboo (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
   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.

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.

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.

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

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 Create Plan 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.

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 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.

You can install plugins to extend Bamboo's for support additional repositories, builders and build tools for your plans. Check out our plugin library for more information.

1. Click Dashboard and then click the All Plans tab.
2. Locate the relevant plan and click the 'Check Out and Build' icon: start_build.gif
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)

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.

1. Click Dashboard and then 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 Historytab to see a summary list of build results.
   • To view the test results, click the Tests tab.
   • To view the build artifacts, click the Artifacts tab.
   • To view the build logs, click the Logs tab.
   • If you have Atlassian's Clover installed, you can also view the Clover code coverage by clicking the Clover tab. See '8. Using Bamboo with Clover' below for details.

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.

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

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

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.

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:
   • View the Bamboo builds that relate to a particular JIRA issue.
   • View the Bamboo builds that relate to a JIRA project or version.
   • View the JIRA issues for a build result.
   • Add JIRA portlets to display the status of your builds or a graphical summary of each build plan.

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.

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.

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.

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.

1. Click Administration in the top navigation bar.
2. Click Groups 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.

1. Click Administration in the top navigation bar.
2. Click Users in the left navigation column.
3. Enter details for the user: 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 Save.

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.

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.

1. Click Dashboard, and then the All Plans tab.
2. Locate the plan in the list and click this icon:
3. Click the Notifications tab.
4. Add a new notification in the 'Add Build Notification' section by doing the following:
   • Specify an Event and Recipient Type (this may include a child field such as User) for the notification.
   • Click Add.
5. Repeat the last step if you want to add more notifications for the plan.
6. Click Done.

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.

1. Go to the build result.
2. Click Labels at the top of the screen (above the 'Summary' tab).
3. Click Add. The 'Enter labels to add to this build' textbox will display.
4. Type the relevant label (or multiple labels, separated by commas).
5. Click Close.

1. Go to the build result.
2. Click Labels 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.

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.

1. From within the 'Build Result' screen, click Comments. A list of existing comments about this build result will be displayed.
2. Type your comment into the Add Comment box, then click Save.

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.

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 Administration in the top navigation bar.
3. Click Agents in the left navigation column. The 'Agents' screen will display.
4. Click Enable Remote Agent Support.
5. Click Install Remote Agent. The 'Installing a Remote Agent' screen will display.
6. Click DOWNLOAD Remote Agent JAR 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:
   • Configuring an Agent-specific Executable Capability
   • Configuring an Agent-specific JDK Capability
   • Configuring an Agent-specific Custom Capability

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

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

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.

1. Click Administration in the top navigation bar.
2. Click Configuration in the left navigation column under the 'Elastic Bamboo' sub-header. The 'Elastic Bamboo Configuration' screen will display.
3. Click Enable to enable Elastic Bamboo for your Bamboo installation. The 'Elastic Bamboo Configuration' screen will display.
4. Enter your details for AWS Access Key ID and AWS Secret Access Key (what are these?)
5. Click Save.

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.

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 Administration in the top navigation bar.
2. Click Instances in the left navigation column. The 'Manage Elastic Instances' screen will display.
3. Click Start New Elastic Instances. 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 Default from the the Elastic Image Configuration Name list.
     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 Submit. 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.

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.

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.

1. Click Authors in the top navigation bar. The 'User and Author Statistics' screen will display.
2. Click Statistics. The 'Report Parameters' screen will display.
3. Select the parameters for your report, as follows:
   • Report — choose from the available report types. Available reports include:
     • 'Build Activity per Author' Report
     • 'Number of Build Failures per Author' Report
     • 'Number of Builds Broken per Author' Report
     • 'Number of Builds Fixed per Author' Report
     • 'Percentage of Successful Builds per Author' Report
     You can configure custom reports by installing the appropriate plugins.
   • Authors — choose the author(s) on whom you want to report. You can use the <Ctrl> key to select multiple author.
   • Group By — choose whether your report's horizontal axis should show days, months or weeks. You can also specify Auto (generally defaults to 'month').
4. Click Submit to generate your report.

1. Click Reports in the top navigation bar.
2. Select the parameters for your report, as follows:
   • Report — choose from the available report types. Available reports include:
     • 'Build Activity' Report
     • 'Build Duration' Report
     • 'Clover Code Coverage' Report
     • 'Clover Lines of Code' Report
     • 'Number of Build Failures' Report
     • 'Number of Tests' Report
     • 'Percentage of Successful Builds' Report
     • 'Time to Fix' Report
     You can configure custom reports by installing the appropriate plugins.
   • Build plans — choose the plan(s) on which you want to report. You can use the <Ctrl> key to select multiple plans.
   • Group By — choose whether your report's horizontal axis should show days, months or weeks. You can also specify Auto (generally defaults to 'month').
   • Date Filter — date range to report on.
3. Click Submit to generate your report.