go

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with go
   • Setup requirements
   • Beginning with go
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

The go module manages the life cycle of the continuous delivery platform Go provided by Thoughtworks. It aims for self containment and only focus on solving tasks surrounding the Go product with minimal external dependencies.

Module Description

Thoughtworks Go is a continuous delivery platform used for build, packaging and orchestrating application deployments. Go uses a server component for the administration, presentation and scheduling part, and an agent component responsible for carrying out the work. The Go module manages these concerns within separate named spaced classes.

Setup

Setup Requirements

Go depends on JDK to be installed in order to run. This dependency must be managed outside of the Go module. See: http://www.thoughtworks.com/products/docs/go/current/help/system_requirements.html

In addition, the Go module depends on functions and resource types provided by the puppetlabs-stdlib module and the puppetlabs-concat module.

Beginning with go

Server

class { '::go::server':
    manage_package_repo => true
}

Agent

class { '::go::agent':
    manage_package_repo => true
} ->
::go::agent::instance { 'agent1':
    path            => '/opt/go',
    go_server_host  => 'localhost',
    go_server_port  => 8153
}

Usage

The Go module exposes the following classes

• go::agent
• go::server

It also exposes these defined types:

• go::agent::instance
• go::server::local_account

The exposed classes are contained using the anchor pattern provided via puppetlabs-stdlib, thus you should be able to form reliable dependencies on these classes as expect all of its resources to be realized.

Reference

See the code

Limitations

Tested and used on Redhat and Ubuntu. See metadata.json for supported OS combinations.

Development

• Install development dependencies

$ bundle install

• Make changes
• Run tests

$ bundle exec rake validate
$ bundle exec rake spec

• Commit to feature branch and create pull request

Release 0.5.0

Summary

Allows uploading plugins from within the Go UI without restarting the server (class param go::server::enable_plugin_upload)

Release 0.4.1

Summary

Fix release for https://github.com/unibet/puppet-go/issues/8

Release 0.4.0

Summary

First version using the changelog

• Adds custom fact gocd_installed
• Prevents service restart during initial install as it can corrupt go server state files created on first startup, the RPM provided by Thoughtworks has a post install script that starts go-server and this is a hack to circumvent the issues with this.
• Adds healthcheck script and class go::server::wait_for_service to allow go server to be properly initialized before making cruise config changes
• Allows management of go server encryption cipher
• Uses augeas to configure autoregister key in go server cruise-config.xml rather than using sed
• Uses augeas to configure local password file auth and ldap auth in cruise-config.xml