bamboo_rest

Manage Bamboo resources through a REST interface

Module Stats

29,958 downloads

9,792 latest version

5.0 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Feb 12th 2018

This version is compatible with:

Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
Puppet >= 3.5

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'atlassian-bamboo_rest', '1.3.1'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add atlassian-bamboo_rest

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install atlassian-bamboo_rest --version 1.3.1

Tags: rest, bamboo, atlassian

Documentation

atlassian/bamboo_rest — version 1.3.1 Feb 12th 2018

Puppet Module to Manage Atlassian Bamboo

Overview
Module Description
Requirements
Usage
Reference
Limitations
Development

Overview

Puppet module to manage Bamboo via REST endpoints (JIRA issue tracker).

Important Note:

The REST APIs used by this Puppet module are not officially supported by Atlassian. They might change in the future
All the dark features used by this Puppet module are not officially supported by Atlassian.

Module Description

This module contains types and provides to manage Bamboo administrative configurations, thus it provides the possibility to manage Bamboo automatically.

It includes types to manage:

Bamboo general administration configurations. http://bambooUrl/admin/configure!default.action
Build monitoring. http://bambooUrl/admin/buildHangingDetection!read.action
Enable/disable audit log. http://bambooUrl/admin/viewGlobalAuditLog.action
Default concurrent build. http://bambooUrl/admin/viewConcurrentBuildConfig.action
Security Settings. https://bambooUrl/admin/viewSecurity.action
Global Variables. https://bambooUrl/admin/admin/configureGlobalVariables!default.action
Bamboo agents. https://bambooUrl/admin/agent/configureAgents!default.action
Build Expiry. https://bambooUrl/admin/buildExpiry!read.action
UPM settings. https://bambooUrl/plugins/latest/settings
User Repositories. https://bambooUrl/admin/userRepositories.action
Groups and permissions. https://bambooUrl/admin/viewGlobalPermissions.action
Role permissions. https://bambooUrl/admin/viewGlobalPermissions.action
Quarantine Configuration. https://bambooUrl/admin/editQuarantineSettings.action
Bamboo Elastic Configuration. http://bambooUrl/admin/elastic/viewElasticConfig.action
Artifact Handlers. https://bambooUrl/admin/configureArtifactHandlers.action
Shared Credential. https://bambooUrl/admin/credentials/configureSharedCredentials.action
Mail Server. https://bambooUrl/admin/viewMailServer.action
IM Server. https://bambooUrl/admin/instantmessagingserver/viewInstantMessagingServer.action
Remote Agent Support. https://bambooUrl/admin/agent/configureAgents!default.action
Dark Features Support. https://bambooUrl/rest/admin/latest/darkFeatures

Requirements

The module doesn't have any dependencies on other Puppet modules. But it is using Ruby libraries that may not be contained in the default installation. Currently, the following libraries are expected to be installed; the module won't install or manage them in any way (see the Gemfile for more information):

json
mime-types
openssl

Depending on the version of Ruby you're using, some of them are shipped by default (e.g. json) whereas others need to be installed via Puppet or in a bootstrap process like

package { 'openssl':
  ensure   => installed,
  provider => gem,
}

Obviously it would be a great improvement if the module itself could provide a manifest to install and manage its dependencies. Any contributions are welcome!

Limitation: At the moment the module doesn't handle the provision-from-scratch use-case very well and will cause a couple of warnings during the resource discovery phase as the Ruby gems may not be available. As long as the gems are installed before the Puppet resources are used, everything should be fine.

Usage

The REST endpoints used by this module are currently protected behind a dark feature switch. To enable them, please add -Datlassian.darkfeature.bamboo.experimental.rest.admin.enabled=true to your Bamboo start script and restart Bamboo. To verify they are enabled, try https://bambooUrl/rest/admin/latest/config/general to see if it gives a 200.

Since this module manages Bamboo via REST endpoints, a configuration file which contains Bamboo login information is required. The file bamboo_rest.conf should exist in Puppet config directory, e.g. /etc/puppet.

bamboo_base_url: http://localhost:6990/bamboo

# The Puppet module supports changing Bamboo user repositories type. E.g. when provisioning Bamboo from scratch, use the
# built-in admin/admin credentials to log in and change user repositories to Crowd or customised LDAP configuration. If you
# want to use it (the bamboo_user_repositories type), you need to provide two sets of credentials, the local credentials and
# Crowd ones. The Puppet module will automatically detect which credentials to use by reading Bamboo configuration. Thus you
# should also configure the Bamboo home directory.

# Bamboo local credential used when invoking REST endpoints
admin_username: admin
admin_password: admin

# Crowd credentials used when invoking REST endpoints
crowd_admin_username: admin
crowd_admin_password: admin

# Bamboo home directory
bamboo_home_dir: /data/bamboo-data/

# timeout in seconds for reading response from Bamboo
# connection_timeout: 20
# timeout in seconds for opening connection to Bamboo
# connection_open_timeout: 20

# retry times when checking Bamboo health status
# health_check_retries: 3
# timeout in seconds when reanding health status from Bamboo
# health_check_timeout: 20

Note: Most Bamboo administrative REST endpoints require System Admin or Restricted Admin permission, so the credentials should at least be a Restricted Admin.

Note: The namevar of the Puppet resource must be 'current' (as shown in all the examples below) unless used by the resource (as is the case for global variables, agents, groups and permissions, role permissions). Other types will not work.

Bamboo General Configuration

bamboo_administration_general_configuration { 'current':
  instance_name             => 'bamboo',
  base_url                  => 'http://example.com',
  broker_url                => 'tcp://0.0.0.0:54663?wireFormat.maxInactivityDuration=300000',
  broker_client_url         => 'failover:(tcp://example.com:54663?wireFormat.maxInactivityDuration=300000)?initialReconnectDelay=15000&maxReconnectAttempts=10',
  dashboard_page_size       => 50,
  branch_detection_interval => 300,
  gravatar_enabled          => true
  gravatar_server_url       => 'https://secure.gravatar.com/avatar/',
  gzip_compression_enabled  => false
}

Note:

Restricted admin required
After changing broker_url or broker_client_url, Bamboo needs to restart to pick up the change. However, this type does not force a restart.
Partial update is supported, you can only specify a subset of the properties above

Audit Log

bamboo_audit_log { 'current':
  audit_log_enabled => true
}

Note:

Restricted admin required

Build Concurrency

bamboo_build_concurrency{ 'current':
  build_concurrency_enabled         => true,
  default_concurrency_builds_number => 10
}

Note:

Restricted admin required
build_concurrency_enabled is mandatory. If default_concurrency_builds_number is not specified and build concurrency is enabled, Bamboo will use whatever is previously stored.

Expiry

bamboo_build_expiry { 'current':
  builds_to_keep           => 4,
  period                   => 'days',
  cron_expression          => '0 0 0 ? * *',
  deployments_to_keep      => 2,
  duration                 => 4,
  expire_artifacts         => false,
  expire_logs              => true,
  expire_results           => false,
  labels_to_exclude        => '',
  maximum_ignored_log_size => -1,
}

Note:

cron_expression is in the Quartz Chrontrigger format (not the normal unix format)
cron_expression is not validated in this module, nor via Bamboo when updating via REST. An invalid cron will be accepted, but will not work (and the Bamboo UI will state 'invalid cron expression')
duration or builds_to_keep must be non-zero
period can be 'days', 'weeks' or 'months'

Build Monitoring

bamboo_build_monitoring { 'current':
  build_monitoring_enabled            => true,
  build_time_multiplier_default       => 2.5,
  log_quiet_minutes_time_default      => 10,
  build_queue_minutes_timeout_default => 60
}

Note:

Restricted admin required
build_monitoring_enabled is required. If it is enabled and other attributes not specified, Bamboo will use whatever is previously stored.

Security Settings

bamboo_security_settings { 'current':
  read_only_external_user_management                  => true,
  sign_up_enabled                                     => true,
  sign_up_enabled_captcha                             => false,
  display_contact_details_enabled                     => true,
  restricted_administrator_role_enabled               => true,
  brute_force_protection_enabled                      => true,
  brute_force_protection_login_attempts               => 3,
  xsrf_protection_enabled                             => true,
  xsrf_protection_disabled_for_http_get               => true,
  resolve_artifacts_content_type_by_extension_enabled => false,
}

Note:

System Admin required

Global Variables

bamboo_global_variable{ 'foo':
  ensure => 'present',
  value  => 'bar',
}

Note:

Restricted admin required

Agents

bamboo_agent{ 'local':        # Supported agent types: local, remote and elastic.
  enabled => false,
}

Note:

Restricted admin required.
If enabled is set to false in manifest, Puppet will make sure the type of agents are all disabled.
If one type of agent does not have any instance and enabled is set to true, Puppet will think it is currently disabled and will try to enable agents of that type. Though no actual http request will be sent.
If there is any agent of one type is enabled, Puppet will think that type of agents are enabled, and do nothing if enabled is set to true in manifest.
If agents of one type are all disabled, Puppet will think this type of agents are disabled, and enable all if enabled is set to true.

UPM Settings

bamboo_upm_settings { 'current':
  auto_update_enabled            => false,
  email_notification_enabled     => false,
  marketplace_connection_enabled => true,
  private_listings_enabled       => true,
  request_addon_enabled          => false,
}

Note:

Restricted admin required
auto_update_enabled: Add-on updates selected by Atlassian will be automatically downloaded and installed.
email_notification_enabled: Disabling this will prevent users and administrators from receiving add-on notifications via email.
marketplace_connection_enabled: Enables connection to marketplace. Warning: Disabling the connection prevents you from finding new add-ons or receiving free updates to your installed add-ons.
private_listings_enabled: Enables private listings to install and license add-ons that aren't publicly available.
request_addon_enabled: You'll receive a notification whenever an end-user requests an add-on. View these requests by selecting the Most requested filter.

Groups and permissions

bamboo_group { 'bamboo_admin':
  permissions => ['ACCESS', 'CREATE_PLAN', 'CREATE_REPOSITORY', 'RESTRICTED_ADMIN', 'ADMIN'],
}

Note:

System Admin required
It will create the group if it does not exists and make sure it has the right permissions.
Supported permission: ACCESS, CREATE_PLAN, CREATE_REPOSITORY, RESTRICTED_ADMIN, ADMIN.

Role permissions

bamboo_role_permissions { 'ROLE_USER':
  permissions => ['ACCESS'],
}

Note:

System Admin required
It only support 2 roles, ROLE_USER for logged in users and ROLE_ANONYMOUS for anonymous users
ROLE_USER cannot have more than ACCESS, CREATE_PLAN and CREATE_REPOSITORY permissions, ROLE_ANONYMOUS cannot have more than ACCESS permission.

User Repositories

bamboo_user_repositories { 'current':
  type                   => 'Crowd',
  server_url             => 'https://crowd.atlassian.com/crowd',
  application_name       => 'bamboo-app',
  application_password   => 'hunter2',
  cache_refresh_interval => 60,
  require                => Bamboo_group['crowd-bamboo-admin'],
}

Note:

System Admin required
type: allowed values: Local, Crowd and Custom.
server_url: Crowd or Jira url. Only needed when type is Crowd
application_name: Bamboo authenticates with JIRA or Crowd using this name.
application_password: Bamboo authenticates with JIRA or Crowd using this password.
cache_refresh_interval: Time (in minutes) between updating the list of users and groups.
Make sure at least one group in crowd has system admin permission.

Quarantine Configuration

bamboo_quarantine { 'current':
  quarantine_tests_enabled => true
}

Note:

Restricted admin required

Elastic Configuration

bamboo_elastic_configuration { 'current':
    enabled => true,
    access_key                          => 'VALID_AWS_ACCESS_KEY',
    secret_key                          => 'VALID_AWS_SECRET',
    region                              => 'US_WEST_1',
    private_key_file                    => '/var/pkey.file',
    certificate_file                    => '/var/certificate.file',
    upload_aws_identifier               => true,
    max_elastic_instances               => 5,
    allocate_public_ip_to_vpc_instances => true,
    im_type                             => 'Custom',
    im_idle_shutdown_delay_minutes      => 10,
    im_allowed_non_bamboo_instances     => 7,
    im_max_num_to_start                 => 30,
    im_queued_build_threshold           => 10,
    im_elastic_queued_build_threshold   => 5,
    im_average_queue_time               => 200,
    termination_enabled                 => true,
    termination_shutdown_delay          => 300
}

Note:

System Admin required
access_key and secret_key must be valid aws credentials
region must be a valid aws regions supported by Bamboo. Acceptable values are:
- US_EAST_1
- US_WEST_1
- US_WEST_2
- EU_WEST_1
- EU_CENTRAL_1
- ASIA_PACIFIC_SE_1
- ASIA_PACIFIC_SE_2
- ASIA_PACIFIC_NE_1
- SOUTH_AMERICA_1
- US_GOV_W1
- CN_NORTH_1
private_key_file and certificate_file are locations of the respective files on the Bamboo server. They must be readable by Bamboo
im_type can be Disabled, Custom, Passive, Aggressive or Default
if im_type is not Custom, no other im_xxxx properties can be set
im_elastic_queued_build_threshold can not be greater than im_queued_build_threshold
termination_shutdown_delay can only be set if termination_enabled is true

Artifact Handlers

bamboo_artifact_handler { 'agent_local':
  artifact_storage_location    => 'opt',
  non_shared_artifacts_enabled => false,
  shared_artifacts_enabled     => false,
  provider                     => agent_local,
}

bamboo_artifact_handler { 'bamboo_remote':
  non_shared_artifacts_enabled => false,
  shared_artifacts_enabled     => false,
  provider                     => bamboo_remote,
}

bamboo_artifact_handler { 's3':
  access_key_id                => 'abc',
  bucket_name                  => 'my bucket',
  region                       => 'us-east-1',
  bucket_path                  => 'bamboo-artifacts',
  max_artifact_file_count      => '100',
  non_shared_artifacts_enabled => true,
  secret_access_key            => 'abcd',
  shared_artifacts_enabled     => 'false',
  provider                     => s3,
}

bamboo_artifact_handler { 'server_local':
  non_shared_artifacts_enabled => false,
  shared_artifacts_enabled     => true,
  provider                     => server_local,
}

Note:

Restricted admin required
To manage artifact handlers, Bamboo must enable the artifact handlers dark feature. Please add -Dbamboo.darkfeature.artifacthandlers=true to your Bamboo start script and restart Bamboo
Artifact handlers can be extended by plugins, only 4 types are supported: agent_local, server_local, bamboo_remote and s3
Different types of artifact handlers have their own provider. It's recommended to add provider type in your manifest.

Shared Credentials

bamboo_shared_credential { 'bamboosshcredential':
  ensure         => 'present',
  ssh_key        => 'addbcd',
  ssh_passphrase => 'brrarr',
}

Note:

Restricted admin required
Different types of shared credentials can be provided via Bamboo plugins. We currently only support ssh shared credential
Bamboo does not enforce uniqueness of shared credential name, If there are duplicated names, the Puppet type might not work properly.

Mail Server

bamboo_mail_server { 'current':
  from                            => 'bamboo',
  from_address                    => 'bamboo@atlassian.a.c',
  subject_prefix                  => '[sbac]',
  email_settings                  => 'SMTP',
  smtp_server                     => 'mail_server',
  smtp_port                       => 25,
  smtp_username                   => 'foo',
  smtp_password                   => 'bar',
  tls_enabled                     => false,
  precedence_bulk_header_excluded => true,
}

Note:

System Admin required
Because of the way that Bamboo Mail Server REST endpoint works, puppet resource bamboo_mail_server will fail if mail server hasn't been configured before.

Remote IM Server

bamboo_im_server { 'current':
  ensure        => 'present',
  host          => 'mail.atlassian.com',
  port          => 2222,
  resource_name => 'bamboo',
  username      => 'foo',
  password      => 'bar',
  tls_enabled   => true,
}

Note:

Restricted admin required
Since Bamboo allows only one IM server configured, we only allow resource title to be 'current'

Remote Agent Support

bamboo_remote_agent_support { 'current':
  remote_agents_supported => false,
}

Note:

Restricted admin required

Dark Feature Support

bamboo_dark_feature { 'bamboo.final.stages':
  ensure => present,
}

Note:

Restricted admin required
Only dynamic dark features are supported (not the ones needed to be specified as Java sysprops)

Reference

Limitations

This modules relies on Bamboo REST endpoints which are only availabie since 5.9.0. It won't work with previous Bamboo versions.

The module has been tested with various Ruby and Puppet versions.

Supported Ruby versions:

Ruby 1.8.7
Ruby 1.9.3
Ruby 2.0.0
Ruby 2.4.2

Supported Puppet Versions:

Puppet 3.5
Puppet 3.6
Puppet 3.7
Puppet 4.6
Puppet 5.3

It won't work with Puppet 3.4 because of PUP-1470.

For password values in Bamboo, a salted hash is returned by Bamboo REST endpoints. The relative Puppet type hashes the value in manifest and compares the hash values. For a Bamboo global variable, the Puppet type first checks if the variable name contains the keyword 'password' or 'secret' (case insensitive). If so, it uses the hash mechanism. Otherwise, it just compares the raw values. When updating password values, they are not hashed. You should rely on an HTTPS connection to protect your sensitive data.

Development

This project is still new and might not work properly (both Puppet module and Bamboo REST endpoints). If you see any problem, please open an issue. Pull requests are welcome!

Release Notes

We are still adding more REST endpoints to Bamboo as well as developing new types/providers, please only use released version of the module. Development version might require REST endpoints have not been released in Bamboo.

Types in this module release

bamboo_global_variable

Properties
value	Value of the variable

Providers
ruby	Puppet provider to manage bamboo global variables

bamboo_audit_log

Puppet Type for Bamboo Audit Log management

Parameters
name	name of the configuration. E.g., current
provider

Properties
audit_log_enabled	Whether audit log is enabled

Providers
ruby	Puppet provider to enable/disable bamboo audit log

bamboo_role_permissions

Puppet type to manage role permissions in bamboo. Only support 2 roles: ROLE_USER and ROLE_ANONYMOUS

Parameters
name	name of the role, e.g. ROLE_USER, ROLE_ANONYMOUS
provider

Properties
permissions	list of permissions of this role

Providers
ruby	Puppet provider to manage role permissions in bamboo

bamboo_build_expiry

Puppet type for build expiry settings

Parameters
name	Name of the configuration (i.e. current).
provider

Properties
builds_to_keep	How many builds will be kept
cron_expression	Cron expression: Bamboo will check for expired data using the global and plan override expiry configurations at intervals based on this cron expression
deployments_to_keep	How many deployments will be kept
duration	Duration before expiry
expire_artifacts	This will determine whether build artifacts expire
expire_logs	This will determine whether build logs expire
expire_results	This will determine whether build results expire
labels_to_exclude	Labels to be excluded. Builds with these labels will be kept
maximum_ignored_log_size	Maximum ignored log size
period	Period of the duration specified. Must be "days", "weeks", or "months"

Providers
ruby	Puppet provider to manage build expiry

bamboo_build_concurrency

Puppet type for bamboo build concurrency

Parameters
name	Name of the configuration (i.e. concurrent).
provider

Properties
build_concurrency_enabled	Whether build concurrency is enabled
default_concurrent_builds_number	Default concurrent build number

Providers
ruby	Puppet provider to manage bamboo build concurrency configuration

bamboo_mail_server

Puppet type to manage mail server settings in bamboo

Parameters
name	name of the puppet resource, can only be "current"
provider

Properties
email_settings	Email provider type, e.g. SMTP or JNDI
from	Sender of the email
from_address	From address of the email
jndi_location	JNDI name of your SMTP server configuration in your application server
precedence_bulk_header_excluded	Whether to prevent the Precedence: Bulk header on bamboo notification emails
smtp_password	Password used to connect to SMTP server
smtp_port	SMTP server port
smtp_server	The email server used to send out the build results. For example "mail.myserver.com".
smtp_username	Username used to connect to SMPT server
subject_prefix	This is the tag added to the start of the subject line to identify Bamboo-generated email. e.g. [Bamboo].
tls_enabled	Whether Transport Layer Security (TLS) is enabled

Providers
ruby

bamboo_elastic_configuration

Puppet type for bamboo elastic configuration

Parameters
name	Name of the configuration (i.e. current).
provider

Properties
access_key	AWS access key
allocate_public_ip_to_vpc_instances	Allocate puplic ips to VPC instances
certificate_file	Certificate File
enabled	Whether elastic agents are enabled
im_allowed_non_bamboo_instances	Instance Management: Number of Non-Bamboo instances allowed
im_average_queue_time	Instance Management: Average Queue Time
im_elastic_queued_build_threshold	Instance Management: Elastic Queued Build Threshold
im_idle_shutdown_delay_minutes	Instance Management: idle shutdown delay (in minutes)
im_max_num_to_start	Instance Management: Max number of instances to start at once
im_queued_build_threshold	Instance Management: Queued Build Threshold
im_type	Instance Management: Type / Strategy
max_elastic_instances	Maximum number of elastic instances
private_key_file	AWS Private Key File
region	AWS region
secret_key	AWS secret key
termination_enabled	Termination Enabled
termination_shutdown_delay	Termination Shutdown Delay
upload_aws_identifier	Upload AWS identifier

Providers
ruby	Puppet provider to manage Bamboo elastic configuration

bamboo_artifact_handler

Puppet type for server local artifact handler

Parameters
name	name of the artifact handler resource, e.g. current
provider

Properties
access_key_id	Access key id
artifact_storage_location	Artifact storage location on bamboo agents. Only available for agent local artifact handlers
bucket_name	Bucket name
bucket_path	Parent path in bucke
max_artifact_file_count	Maximum number of files per artifact
non_shared_artifacts_enabled	whether this handler is enabled for non shared artifacts
region	Region of the s3 bucket
secret_access_key	Secret access key id
shared_artifacts_enabled	whether this artifact handler is enabled for shared artifacts

Providers
agent_local	Puppet provider for type agent local artifact handler
bamboo_remote	Puppet provider for type bamboo remote artifact handler
s3	Puppet provider for type bamboo remote artifact handler
server_local	Puppet provider for type server local artifact handler

bamboo_shared_credential

Puppet type to manage bamboo shared credentials

Parameters
ensure
name	Name of the shared credential
provider

Properties
ssh_key	Ssh of ssh shared credential
ssh_passphrase	Ssh passphrase of ssh key

Providers
ssh

bamboo_dark_feature

Puppet type to manage Bamboo dynamic dark features

Parameters
ensure
name	name of the resource, which maps to the dark feature name (e.g. "bamboo.final.stages")
provider

Providers
ruby	Puppet provider to manage Bamboo dynamic dark features

bamboo_agent

This type provides ability to enable/disable bamboo agents by types. E.g. you can enable/disable all remote/elastic/local agents.

Parameters
name	Specify the type of bamboo agents. Support 3 types of agents: remote, local and elastic.
provider

Properties
enabled	Specify whether the type of agents should be enabled or not

Providers
ruby	Puppet type to enable/disable bamboo agents by type

bamboo_build_monitoring

Puppet type for bamboo build monitoring

Parameters
name	Name of the configuration (i.e. monitoring).
provider

Properties
build_monitoring_enabled	Whether build monitoring is enabled
build_queue_minutes_timeout_default	Default timeout for build queues
build_time_multiplier_default	Default multiplier for build times
log_quiet_minutes_time_default	Default timeout for logs

Providers
ruby	Puppet provider to manage bamboo build monitoring configuration

bamboo_im_server

Puppet type to manage bamboo im server configuration

Parameters
ensure
name	name of the resource, must be current because there can be only one im server configured in bamboo
provider

Properties
host	Host name of IM server
password	password for the IM Server
port	Port of IM server
resource_name	Name of resource used to distinguish connections if multiple clients connect to the same Jabber account
tls_enabled	Whether a TLS/SSL connection is required to the IM Server
username	Username for the IM server

Providers
ruby

bamboo_administration_general_configuration

Puppet type for bamboo admin general configuration

Parameters
name	Name of the configuration (i.e. current).
provider

Properties
base_url	This is the base URL of this installation of Bamboo. All links created (for emails etc) will be prefixed by This URL.
branch_detection_interval	How often to check for new plan branches (seconds)
broker_client_url	Broker client url
broker_url	Broker url
dashboard_page_size	Number of plans to initially show on the dashboard
gravatar_enabled	Gravatar support allows Bamboo to use user email addresses to retrieve profile pictures from Gravatar or a Gravatar enabled service. Allowed value: true/false
gravatar_server_url	URL of the external Gravatar server
gzip_compression_enabled	This is useful if Bamboo is being run over slow networks. There is a slight performance penalty, and may not work for non-english languages.
instance_name	Instance name of bamboo server

Providers
ruby	Puppet provider to update bamboo admin general configuration

bamboo_remote_agent_support

Puppet Type for Bamboo Remote Agent Support

Parameters
name	name of the configuration. E.g., current
provider

Properties
remote_agents_supported	Whether remote agents are supported

Providers
ruby	Puppet provider to enable/disable bamboo remote agent support

bamboo_group

Puppet type to manage groups in bamboo. Only supported property is group permissions atm.

Parameters
ensure
name	Name fo the group, can only include letters in lower case, digits, -, _, . and @
provider

Properties
permissions	Permissions of a bamboo group. Should be an array of permissions, valid permissions include ACCESS, SOX_COMPLIANCE, CREATE_PLAN, CREATE_REPOSITORY, RESTRICTED_ADMIN and ADMIN

Providers
ruby	Puppet provider for bamboo groups

bamboo_security_settings

Puppet type for security settings

Parameters
name	Name of the configuration (i.e. current).
provider

Properties
brute_force_protection_enabled	Forces the user to enter a captcha code if they meet the maximum amount of failed login attempts
brute_force_protection_login_attempts	Number of login attempts before captcha is shown
display_contact_details_enabled	This will allow Bamboo user's contact details to be visible. Disabling this option will hide the email address, IM address, and the group the user is in.
read_only_external_user_management	Enable this option if you are connecting Bamboo to an external user management system and do not have update rights there.
resolve_artifacts_content_type_by_extension_enabled	Bamboo will serve your html artifacts as html, and let your browser browse to them. This is helpful but creates an XSS vulnerability that could be exploited by malicious users
restricted_administrator_role_enabled	This will enable the restricted administrator role
sign_up_enabled	This will allow users to sign up for an account to Bamboo.
sign_up_enabled_captcha	Forces the user to enter a captcha code on signup
sox_compliance_mode_enabled	This will enable the SOX compliant user role
xsrf_protection_disable_for_http_get	This option is provided for compatibility reasons and will be removed in future releases. It practically disables XSRF protection and should not be used.
xsrf_protection_enabled	Prevents attackers from impersonating you and accessing Bamboo

Providers
ruby	Puppet provider to manage security settings

bamboo_quarantine

Puppet Type for Bamboo Quarantine Configuration

Parameters
name	name of the configuration. E.g., current
provider

Properties
quarantine_tests_enabled	Whether quarantine tests are enabled

Providers
ruby	Puppet provider to enable/disable bamboo quarantine tests

bamboo_upm_settings

Puppet type for upm settings

Parameters
mame	Name of the configuration (i.e. current).
provider

Properties
auto_update_enabled	Add-on updates selected by Atlassian will be automatically downloaded and installed.
email_notification_enabled	Disabling this will prevent users and administrators from receiving add-on notifications via email.
marketplace_connection_enabled	Enables connection to marketplace. Warning: Disabling the connection prevents you from finding new add-ons or receiving free updates to your installed add-ons.
private_listings_enabled	Enable private listings to install and license add-ons that aren't publicly available.
request_addon_enabled	You'll receive a notification whenever an end-user requests an add-on. View these requests by selecting the Most requested filter.

Providers
ruby	Puppet provider to manage UPM settings

bamboo_user_repositories

Puppet type for bamboo user repositories

Parameters
name	Name of the configuration (i.e. concurrent).
provider

Properties
application_name	Bamboo authenticates with JIRA or Crowd using this name. (only used if type is Crowd)
application_password	Bamboo authenticates with JIRA or Crowd using this password. (only used if type is Crowd)
cache_refresh_interval	Time (in minutes) between updating the list of users and groups. (only used if type is Crowd)
server_url	The server url of the Crowd/Jira server. For example, http//jira.example.com:8080/ or http://example.org:8095/crowd (Only used if type is Crowd).
type	Type of user repository, can be Crowd, Custom, Local

Providers
ruby	Puppet provider to manage bamboo user repositories

##2018-02-11 - Release 1.3.1

Added support for dynamic dark features.

##2018-02-01 - Release 1.3.0

Now assume Puppet 5.3 (instead of 3.7.3) unless overridden by PUPPET_VERSION environment variable
Dependency updates (mainly for rspec) with corresponding updates to syntax of tests
Fix typos in README.md

##2017-11-16 - Release 1.2.4

Fixes for IM and mail server resources
Fix exception output for get_config
Change Bamboo provider content type from 'json' to 'application/json'

##2017-11-14 - Release 1.2.0

Remove reliance on rest_client gem + confines for it

##2017-08-04 - Release 1.1.2

Treat variables with 'secret' in the name as password variables, as Bamboo does starting from version 5.15.

##2017-02-25 - Release 1.1.1

'region' s3 artifact handler parameter actually only works with upcoming 5.16.0 of Bamboo, it was not included in the admin rest endpoints in previous versions.

##2017-01-31 - Release 1.1.0

'region' parameter added to s3 artifact handler configuration - issue #3

##2016-09-13 - Release 1.0.10

Fix bamboo_mail_server provider again

##2016-09-12 - Release 1.0.9

bamboo_mail_server is broken

##2016-09-07 - Release 1.0.8

Puppet4 - bamboo_mail_server exception handling improved to deal with 404, instead of bubbling up an exception causing puppet4 apply to fail.

##2016-08-29 - Release 1.0.7

Puppet4 - remove the require of rest_client post confine.

##2016-08-29 - Release 1.0.6

Puppet4 - confine rest-client gem so that it is no longer required on master.

##2016-06-24 - Release 1.0.5

Updates documentation about support

##2016-04-11 - Release 1.0.4

Adds support to enable Bamboo SOX Compliance mode. It requires Bamboo 5.11.0-m369 or later.

##2016-04-06 - Release 1.0.3

Adds support for CREATE_REPOSITORY permission. It requires Bamboo 5.11.0-m346 or later.

##2016-03-31 - Release 1.0.2

Adds support for SOX_COMPLIANCE permission. It requires Bamboo 5.11.0-m274 or later.

##2016-02-11 - Release 1.0.1

Fix issue:

Agent Local artifact handler provider does not work with a new bamboo 5.10 instance

##2016-01-25 - Release 1.0.0

1st GA version after Bamboo 5.10.0 is released, nothing new than 0.0.7

##2015-12-30 - Release 0.0.7

In this release the puppet provider forces some resources can only have title current, otherwise puppet run will fail. Bamboo only has one entry for some REST resources, e.g. mail server, elastic configuration and user repositories, so the provider uses title current when fetching them. If those resources are defined with title other than current in your manifest, puppet will apply the resource every time.

The enforced types include:

bamboo_administration_general_configuration
bamboo_audit_log
bamboo_build_concurrency
bamboo_build_expiry
bamboo_build_monitoring
bamboo_elastic_configuration
bamboo_im_server
bamboo_mail_server
bamboo_quarantine
bamboo_remote_agent_support
bamboo_security_settings
bamboo_user_repositories

##2015-11-02 - Release 0.0.6

This release contains 1 bugfix. It requires Bamboo 5.10.0-m52 or later.

issue-1

##2015-10-30 - Release 0.0.5

This release provides 1 new puppet types to manage bamboo. It requires Bamboo 5.10.0-m52 or later.

bamboo_im_server

##2015-10-07 - Release 0.0.4

This release provides 4 new puppet types to manage bamboo. It requires Bamboo 5.10.0-m33 or later.

bamboo_artifact_handler
bamboo_elastic_configuration
bamboo_mail_server
bamboo_shared_credential

##2015-09-22 - Release 0.0.3

This release provides 7 puppet types to manage bamboo. It requires Bamboo 5.10.0-m27 or later.

bamboo_global_variable
bamboo_agent
bamboo_upm_settings
bamboo_group
bamboo_role_permissions
bamboo_user_repositories
bamboo_quarantine

##2015-06-04 - Release 0.0.2

This release provides 6 puppet types to manage bamboo. It requires Bamboo 5.9.0 or later.

bamboo_administration_general_configuration
bamboo_audit_log
bamboo_build_concurrency
bamboo_build_monitoring
bamboo_global_variable
bamboo_security_settings

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

bamboo_rest

Support the Puppet Community by contributing to this module

Version information

This version is compatible with:

Start using this module

Documentation

Puppet Module to Manage Atlassian Bamboo

Table of Contents

Overview

Module Description

Requirements

Usage

Bamboo General Configuration

Audit Log

Build Concurrency

Expiry

Build Monitoring

Security Settings

Global Variables

Agents

UPM Settings

Groups and permissions

Role permissions

User Repositories

Quarantine Configuration

Elastic Configuration

Artifact Handlers

Shared Credentials

Mail Server

Remote IM Server

Remote Agent Support

Dark Feature Support

Reference

Limitations

Development

Release Notes

Types in this module release

bamboo_global_variable

bamboo_audit_log

bamboo_role_permissions

bamboo_build_expiry

bamboo_build_concurrency

bamboo_mail_server

bamboo_elastic_configuration

bamboo_artifact_handler

bamboo_shared_credential

bamboo_dark_feature

bamboo_agent

bamboo_build_monitoring

bamboo_im_server

bamboo_administration_general_configuration

bamboo_remote_agent_support

bamboo_group

bamboo_security_settings

bamboo_quarantine

bamboo_upm_settings

bamboo_user_repositories