crucible

Table of Contents

1. Description
2. Setup - The basics of getting started with crucible
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Description

This module installs, configures, and manages Atlassian Crucible / Fisheye.

Setup

What crucible affects

• Atlassian Crucible / Fisheye
• Java installation

Beginning with crucible

Basic install using default settings.

class { ::crucible }

Usage

All interactions with the crucible module can be performed through the main crucible class.

Minimal installation using default settings:

class { ::crucible }

Install Crucible 3.10.2 and change the install location and service user:

class { ::crucible
  version      => '3.10.2'
  install_dir  => '/usr/local/crucible'
  service_user => 'fisheye'
}

Install Crucible, don't manage the service, and don't install java:

class { ::crucible
  service_manage => false
  install_java   => false
}

Reference

Public Classes

• crucible: Main class, includes all other classes.

Private Classes

• crucible::install: Handles the packages.
• crucible::config: Handles the configuration file.
• crucible::service: Handles the service.

Module Parameters

version

Which version of Crucible to install (default: 4.0.3)

service_manage

Should puppet manage the init service? (default: true)

service_ensure

State the service should be (default: running, valid options: running, stopped)

service_enable

Should the service be enabled on boot? (default: true)

service_name

Name of the service (default: crucible)

install_java

Should the module install Java? (default: true)

install_dir

Where should crucible be installed? (default: '/opt/crucible')

home_dir

Where should the service user's home directory be (default: '/home/${service_user}')

fisheye_inst

Where should crucible's data be stored? (default: '/opt/crucible-data')

service_user

What user should the service run under? (default: crucible)

install_unzip

Should the module install unzip? (default: true)

install_wget

Should the module install wget? (default: true)

download_url

Specify alternate download URL (default: 'https://www.atlassian.com/software/crucible/downloads/binary')

Limitations

OSes Supported:

• RHEL/CentOS 6
• Ubuntu 12.04, 14.04

Dependencies:

• puppetlabs-stdlib >= 3.0.0
• puppetlabs-java >= 1.2.0
• puppetlabs-apt >= 1.4.0 (Only required for Ubuntu)

This module has only been tested on CentOS6, Ubuntu 12.04, and Ubuntu 14.04 using OpenJRE8 on Puppet Enterprise 2015.3

Development

Please feel free to ask (or submit PRs) for feature requests, improvements, etc!

##2017-12-16 - Release 0.3.1 ###Summary

• Make the service user's home directory customizable. (PR #14)

##2017-02-04 - Release 0.3.0 ###Summary

• FISHEYE_INST should not be a literal path (Issue #9)
• What License is governing this Module? (Issue #11)
• Making the download URL customisable to allow using an alternate download URL. (PR #12)

Upgrading to 0.3.0

• FISHEYE_INST (the location where the fisheye/crucible data is stored) default location has been moved from /opt/FISHEYE_INST to /opt/crucible-data. If you're upgrading from a version <= 0.2.1 you should do one of the following:

  1. Explicitly set your FISHEYE_INST to the old data directory:

  class { ::crucible
   fisheye_inst => '/opt/FISHEYE_INST'
  }
  

  1. Execute the new version of the johnlawerance/crucible puppet module and after it runs copy the contents of your old $FISHEYE_INST data directory to the newly laid down /opt/crucible-data.

##2016-10-18 - Release 0.2.1 ###Summary

• Fixed the version regex validation (Issue #7)

##2016-04-17 - Release 0.2.0 ###Summary

• Adding Ubuntu 12.04 and 14.04 support

##2016-03-29 - Release 0.1.2 ###Summary

• Adding support for separate fisheye data dir. This will allow easier upgrades and a better separation of application and data.

##2016-02-27 - Release 0.1.1 ###Summary

• Fixed puppet-lint errors
• Fixed metadata java/stdlib dependency info
• Fixed install_java param not actually being used

##2016-02-26 - Release 0.1.0 ###Summary

• Initial Release