Skip to content
This repository has been archived by the owner on Oct 2, 2023. It is now read-only.

Latest commit

 

History

History
96 lines (64 loc) · 3.1 KB

bamboo.md

File metadata and controls

96 lines (64 loc) · 3.1 KB
Raw
title tags keywords summary sidebar permalink
Bamboo Collector
hygieia_sidebar
bamboo.html

Configure the Bamboo Collector to display and monitor information (related to build status) on the Hygieia Dashboard, from Bamboo. Hygieia uses Spring Boot to package the collector as an executable JAR file with dependencies.

Setup Instructions

Fork and Clone the Collector

Fork and clone the Bamboo Collector from the GitHub repo.

To configure the Bamboo Collector, execute the following steps:

  • Step 1: Change Directory

Change the current working directory to the hygieia-build-bamboo-collector directory.

For example, in the Windows command prompt, run the following command:

cd C:\Users\[username]\hygieia-build-bamboo-collector
  • Step 2: Run Maven Build

Run the maven build to package the collector into an executable JAR file:

mvn install

The output file [collector name].jar is generated in the hygieia-build-bamboo-collector\target folder.

  • Step 3: Set Parameters in Application Properties File

Set the configurable parameters in the application.properties file to connect to the Dashboard MongoDB database instance, including properties required by the Bamboo Collector.

To configure parameters for the Bamboo Collector, refer to the sample application.properties file.

For information about sourcing the application properties file, refer to the Spring Boot Documentation.

  • Step 4: Deploy the Executable File

To deploy the [collector name].jar file, change directory to hygieia-build-bamboo-collector\target, and then execute the following from the command prompt:

java -jar [collector name].jar --spring.config.name=bamboo --spring.config.location=[path to application.properties file]

Sample Application Properties File

		# Database Name
		dbname=dashboarddb

		# Database HostName - default is localhost
		dbhost=localhost

		# Database Port - default is 27017
		dbport=9999

		# MongoDB replicaset
		dbreplicaset=[false if you are not using MongoDB replicaset]
		dbhostport=[host1:port1,host2:port2,host3:port3]

		# Database Username - default is blank
		dbusername=dashboarduser

		# Database Password - default is blank
		dbpassword=dbpassword

		# Collector schedule (required)
		bamboo.cron=0 0/5 * * * *

		# Jenkins server (required) - Can provide multiple
		bamboo.servers[0]=http://bamboo.company.com

		# If using username/token for API authentication
		# (required for Cloudbees Jenkins Ops Center) see sample
		bamboo.servers[1]=http://username:token@bamboo.company.com

		# Another option: If using same username/password Jenkins auth,
		# set username/apiKey to use HTTP Basic Auth (blank=no auth)
		bamboo.username=
		bamboo.apiKey=

		# Determines if build console log is collected - defaults to false
		# (Bamboo for some reason has not exposed it as an API)
		bamboo.saveLog=false