r10k Configuration Module

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 r10k
   • What r10k affects
   • Setup requirements
   • Beginning with r10k
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

This module was built to install and configure r10k. It has a base class to configure r10k to synchronize dynamic environments. It also has a series of lateral scripts and tools that assist in general workflow, that will be seperated into their own modules into the future.

Module Description

This module is meant to manage the installation and configuration of r10k using multiple installation methods on multiple platforms.

Setup

Please refer to the official r10k docs for specific configuration patterns.

Prefix Example

Instead of passing a single remote, you can pass a puppet hash as the sources parameter. This allows you to configure r10k with prefix support. This often used when multiple teams use seperate repos, or if hiera and puppet are distributed across two repos.

class { 'r10k':
  sources => {
    'webteam' => {
      'remote'  => 'ssh://git@github.com/webteam/somerepo.git',
      'basedir' => "${::settings::confdir}/environments",
      'prefix'  => true,
    },
    'secteam' => {
      'remote'  => 'ssh://git@github.com/secteam/someotherrepo.git',
      'basedir' => '/some/other/basedir',
      'prefix'  => true,
    },
  },
}

What r10k affects

• Installation of the r10k gem
• Installation of git
• Installation of ruby when not using an existing ruby stack i.e. when using puppet_gem
• Management of the r10k.yaml in /etc
• Installation and configuration of a sinatra app when using the webhook.

Version chart

Gem installation is pinned to a default version in this module, the following chart shows the gem installation tested with the respective module version. You can override this by passing the version parameter.

Module Version	r10k Version
v4.0.0+
v3.0.x	1.5.1
v2.8.2	1.5.1
v2.7.x	1.5.1
v2.6.5	1.4.1
v2.5.4	1.4.0
v2.4.4	1.3.5
v2.3.1	1.3.4
v2.3.0	1.3.2
v2.2.8	1.3.1
v2.2.x	1.1.0

Setup Requirements

r10k connects via ssh and does so silently in the background, this typically requires ssh keys to be deployed in advance of configuring r10k. This includes the known host ( public ) key of the respective git server, and the user running r10k's private key used to authenticate git/ssh during background runs.

Here is an example of deploying the ssh keys needed for r10k to connect to a repo called puppet/control on a gitlab server. This is helpful when you need to automatically deploy new masters

#https://docs.puppetlabs.com/references/latest/type.html#sshkey
sshkey { 'your.internal.gitlab.server.com':
  ensure => present,
  type   => 'ssh-rsa',
  target => '/root/.ssh/known_hosts',
  key    => '...+dffsfHQ==',
}

# Resource git_webhook is provided by https://forge.puppet.com/abrader/gms
git_deploy_key { 'add_deploy_key_to_puppet_control':
  ensure       => present,
  name         => $::fqdn,
  path         => '/root/.ssh/id_dsa.pub',
  token        => hiera('gitlab_api_token'),
  project_name => 'puppet/control',
  server_url   => 'http://your.internal.gitlab.server.com',
  provider     => 'gitlab',
}

A simple example of creating an ssh private key would use an exec to call yes y | ssh-keygen -t dsa -C "r10k" -f /root/.ssh/id_dsa -q -N ''. The example above shows using git_deploy_key which would deploy that key to the remote git server via its api. This is often required in the programtic creation of compile masters.

Given r10k will likely be downloading your modules, often on the first server it's run on, you will have to puppet apply this module to bootstrap this configuration and allow for ongoing management from there.

Beginning with r10k

The simplest example of using it would be to declare a single remote that would be written to r10k.yaml.

class { 'r10k':
  remote => 'git@github.com:someuser/puppet.git',
}

This will configure /etc/r10k.yaml and install the r10k gem after installing ruby using the puppetlabs/ruby module.

It also supports installation via multiple providers, such as installation in the puppet_enterprise ruby stack in versions less than 3.8

Installing into the Puppet Enterprise ruby stack in PE 2015.x

class { 'r10k':
  remote   => 'git@github.com:someuser/puppet.git',
  provider => 'puppet_gem',
}

Note: It is recommended you migrate to using the pe_r10k module which is basically a clone of this modules features and file tickets for anything missing.

Usage

Installing using a proxy server

Mcollective Support

An mcollective agent is included in this module which can be used to do on demand synchronization. This mcollective application and agent can be installed on all masters using the following class Note: You must have mcollective already configured for this tool to work, Puppet Enterprise users will automatically have mcollective configured. This class does not restart the mcollective or pe-mcollective server on the nodes to which it is applied, so you may need to restart mcollective for it to see the newly installed r10k agent.

include r10k::mcollective

Using mco you can then trigger mcollective to call r10k using

mco r10k synchronize

You can sync an individual environment using:

mco r10k deploy <environment>

Note: This implies -p

You can sync an individual module using:

mco r10k deploy_module <module>

If you are required to run r10k as a specific user, you can do so by passing the user parameter:

mco r10k synchronize user=r10k

To obtain the output of running the shell command, run the agent like this:

mco rpc r10k synchronize -v

An example post-receive hook is included in the files directory. This hook can automatically cause code to synchronize on your servers at time of push in git. More modern git systems use webhooks, for those see below.

###Install mcollective support for post receive hooks Install the mco command from the puppet enterprise installation directory i.e.

cd ~/puppet-enterprise-3.0.1-el-6-x86_64/packages/el-6-x86_64
sudo rpm -i pe-mcollective-client-2.2.4-2.pe.el6.noarch.rpm

Copy the peadmin mcollective configuration and private keys from the certificate authority (puppet master)

/var/lib/peadmin/.mcollective
/var/lib/peadmin/.mcollective.d/mcollective-public.pem
/var/lib/peadmin/.mcollective.d/peadmin-cacert.pem
/var/lib/peadmin/.mcollective.d/peadmin-cert.pem
/var/lib/peadmin/.mcollective.d/peadmin-private.pem
/var/lib/peadmin/.mcollective.d/peadmin-public.pem

Ensure you update the paths in ~/.mcollective when copying to new users whose name is not peadmin. Ideally mcollective will be used with more then just the peadmin user's certificate in the future. That said, if your git user does not have a home directory, you can rename .mcollective as /etc/client.cfg and copy the certs to somewhere that is readable by the respective user.

/home/gitolite/.mcollective
/home/gitolite/.mcollective.d/mcollective-public.pem
/home/gitolite/.mcollective.d/peadmin-cacert.pem
/home/gitolite/.mcollective.d/peadmin-cert.pem
/home/gitolite/.mcollective.d/peadmin-private.pem
/home/gitolite/.mcollective.d/peadmin-public.pem

Note: PE2 only requires the .mcollective file as the default auth was psk

Removing the mcollective agent

class { 'r10k::mcollective':
  ensure => false,
}

This will remove the mcollective agent/application and ddl files from disk. This likely would be if you are migrating to Code manager in Puppet Enterprise.

Webhook Support

For version control systems that use web driven post-receive processes you can use the example webhook included in this module. When the webhook receives the post-receive event, it will synchronize environments on your puppet masters. The webhook uses mcollective for multi-master synchronization and the peadmin user from Puppet Enterprise by default. These settings are all configurable for your specific use case, as shown below in these configuration examples.

Webhook Github Enterprise - Non Authenticated

This is an example of using the webhook without authentication. The git_webhook type will use the api token to add the webhook to the "control" repo that contains your puppetfile. This is typically useful when you want to automate the addition of the webhook to the repo.

# Required unless you disable mcollective
include r10k::mcollective
# Internal webhooks often don't need authentication and ssl
# Change the url below if this is changed
class {'r10k::webhook::config':
  enable_ssl     => false,
  protected      => false,
}

class {'r10k::webhook':
  require => Class['r10k::webhook::config'],
}

# Add webhook to control repository ( the repo where the Puppetfile lives )
#
# Resource git_webhook is provided by https://forge.puppet.com/abrader/gms
git_webhook { 'web_post_receive_webhook' :
  ensure       => present,
  webhook_url  => 'http://master.of.masters:8088/payload',
  token        =>  hiera('github_api_token'),
  project_name => 'organization/control',
  server_url   => 'https://your.github.enterprise.com',
  provider     => 'github',
}


# Add webhook to module repo if we are tracking branch in Puppetfile i.e.
# mod 'module_name',
#  :git    => 'http://github.com/organization/puppet-module_name',
#  :branch => 'master'
# The module name is determined from the repo name , i.e. <puppet-><module_name>
# All characters with left and including any hyphen are removed i.e. <puppet->
#
# Resource git_webhook is provided by https://forge.puppet.com/abrader/gms
git_webhook { 'web_post_receive_webhook_for_module' :
  ensure       => present,
  webhook_url  => 'http://master.of.masters:8088/module',
  token        =>  hiera('github_api_token'),
  project_name => 'organization/puppet-module_name',
  server_url   => 'https://your.github.enterprise.com',
  provider     => 'github',
}

Webhook Github Example - Authenticated

This is an example of using the webhook with authentication. The git_webhook type will use the api token to add the webhook to the "control" repo that contains your puppetfile. This is typically useful when you want to automate the addition of the webhook to the repo.

# Required unless you disable mcollective
include r10k::mcollective

# External webhooks often need authentication and ssl and authentication
# Change the url below if this is changed

class {'r10k::webhook::config':
  enable_ssl => true,
  protected  => true,
  notify     => Service['webhook'],
}

class {'r10k::webhook':
  require => Class['r10k::webhook::config'],
}

# Add webhook to control repository ( the repo where the Puppetfile lives )
#
# Resource git_webhook is provided by https://forge.puppet.com/abrader/gms
git_webhook { 'web_post_receive_webhook' :
  ensure             => present,
  webhook_url        => 'https://puppet:puppet@hole.in.firewall:8088/payload',
  token              =>  hiera('github_api_token'),
  project_name       => 'organization/control',
  server_url         => 'https://api.github.com',
  disable_ssl_verify => true,
  provider           => 'github',
}

# Add webhook to module repo if we are tracking branch in Puppetfile i.e.
# mod 'module_name',
#  :git    => 'http://github.com/organization/puppet-module_name',
#  :branch => 'master'
# The module name is determined from the repo name , i.e. <puppet-><module_name>
# All characters with left and including any hyphen are removed i.e. <puppet->
#
# Resource git_webhook is provided by https://forge.puppet.com/abrader/gms
git_webhook { 'web_post_receive_webhook_for_module' :
  ensure       => present,
  webhook_url  => 'https://puppet:puppet@hole.in.firewall:8088/module',
  token        =>  hiera('github_api_token'),
  project_name => 'organization/puppet-module_name',
  server_url   => 'https://api.github.com',
  disable_ssl_verify => true,
  provider     => 'github',
}

GitHub Secret Support

GitHub webhooks allow the use of a secret value that gets hashed against the payload to pass a signature in the request X-Hub-Signature header. To support the secret with the webhook do the following type of configuration.

class { 'r10k::webhook::config':
  protected     => false,
  github_secret => 'THISISTHEGITHUBWEBHOOKSECRET',
}

class { 'r10k::webhook':
  require => Class['r10k::webhook::config'],
}

Webhook - remove webhook init script and config file.

For use when moving to Code Manager, or other solutions, and the webhook should be removed.

class {'r10k::webhook::config':
  ensure => false,
}

class {'r10k::webhook':
  ensure => false,
}

Running without mcollective

If you have only a single master, you may want to have the webhook run r10k directly rather then as peadmin via mcollective. This requires you to run as the user that can perform r10k commands which is typically root. The peadmin certificate no longer is managed or required.

# Instead of running via mco, run r10k directly
class {'r10k::webhook::config':
  use_mcollective => false,
}

# The hook needs to run as root when not running using mcollective
# It will issue r10k deploy environment <branch_from_gitlab_payload> -p
# When git pushes happen.
class {'r10k::webhook':
  use_mcollective => false,
  user            => 'root',
  group           => '0',
  require         => Class['r10k::webhook::config'],
}

Webhook Prefix Example

The following is an example of declaring the webhook when r10k prefixing are enabled.

prefix_command.rb

This script is fed the github/gitlab payload in via stdin. This script is meant to return the prefix as its output. This is needed as the payload does not contain the r10k prefix. The simplest way to determine the prefix is to use the remote url in the payload and find the respective key in r10k.yaml. An example prefix command is located in this repo here. Note that you may need to modify this script depending on your remote configuration to use one of the various remote styles.

file {'/usr/local/bin/prefix_command.rb':
  ensure => file,
  mode   => '0755',
  owner  => 'root',
  group  => '0',
  source => 'puppet:///modules/r10k/prefix_command.rb',
}

# Required unless you disable mcollective
include r10k::mcollective

class {'r10k::webhook::config':
  prefix         => true,
  prefix_command => '/usr/local/bin/prefix_command.rb',
  require        => File['/usr/local/bin/prefix_command.rb'],
}

class {'r10k::webhook':
  require => Class['r10k::webhook::config'],
}
# Deploy this webhook to your local gitlab server for the puppet/control repo.
#
# Resource git_webhook is provided by https://forge.puppet.com/abrader/gms
git_webhook { 'web_post_receive_webhook' :
  ensure       => present,
  webhook_url  => 'https://puppet:puppet@master.of.masters:8088/payload',
  token        =>  hiera('gitlab_api_token'),
  project_name => 'puppet/control',
  server_url   => 'http://your.internal.gitlab.com',
  provider     => 'gitlab',
}

Webhook FOSS support with MCollective

Currently the webhook relies on existing certificates for its ssl configuration. See this following ticket for more information. Until then, its possible to re-use you existing FOSS mcollective certificates.

Here is an working example on Ubuntu 14.04.2 LTS

class { 'r10k::webhook::config':
  public_key_path  => '/etc/mcollective/server_public.pem',  # Mandatory for FOSS
  private_key_path => '/etc/mcollective/server_private.pem', # Mandatory for FOSS
}

class { 'r10k::webhook':
  user    => 'puppet',                                       # Mandatory for FOSS
  group   => 'puppet',                                       # Mandatory for FOSS
}

Webhook FOSS support without MCollective

Some instances may require the user/group root/root (Linux) or root/wheel (BSD). Verify that the specified user has the permissions to run r10k commands.

class { 'r10k::webhook::config':
  use_mcollective  => false,
  public_key_path  => '/etc/mcollective/server_public.pem',  # Mandatory even when use_mcollective is false
  private_key_path => '/etc/mcollective/server_private.pem', # Mandatory even when use_mcollective is false
}

class { 'r10k::webhook':
  user    => 'root',                                       # Mandatory for FOSS
  group   => 'root',                                       # Mandatory for FOSS
}

Webhook sinatra gem installation

By default, the r10k::webhook::package class uses the puppet_gem provider to install the latest ruby 2.1 compatible version of sinatra ('~> 1.0'). If you are overriding r10k::webhook::package::provider, you will also need to override r10k::webhook::package::sinatra_version.

Webhook Slack notifications

You can enable Slack notifications for the webhook. You will need a Slack webhook URL and the slack-notifier gem installed.

To get the Slack webhook URL you need to:

1. Go to https://slack.com/apps/A0F7XDUAZ-incoming-webhooks.
2. Choose your team, press Configure.
3. In configurations press Add configuration.
4. Choose channel, press Add Incoming WebHooks integration.

Then configure the webhook to add your Slack Webhook URL.

class { 'r10k::webhook::config':
  . . .
  slack_webhook   => 'http://slack.webhook/webhook', # mandatory for usage
  slack_channel   => '#channel', # defaults to #default
  slack_username  => 'r10k', # the username to use
  slack_proxy_url => 'http://proxy.example.com:3128' # Optional.  Defaults to undef.
}

Webhook Default Branch

The default branch of the controlrepo is commonly called production. This value can be overriden if you use another default branch name, such as master.

class { 'r10k::webhook::config':
  default_branch => 'master',    # Optional. Defaults to 'production'
}

Triggering the webhook from curl

To aid in debugging, or to give you some hints as to how to trigger the webhook by unsupported systems, here's a curl command to trigger the webhook to deploy the 'production' environment:

curl -d '
  {
    "repository": {"name": "foo", "owner": {"login": "foo"}}, 
    "ref": "production"
  }' http://puppet-master.example:8088/payload

Troubleshooting

If you're not sure whether your webhook setup works:

• Try to make a GET request to the heartbeat endpoint (e.g. http://puppet-master.example:8088/heartbeat).  You should see a short JSON answer similar to {"status":"success","message":"running"}.
• Watch the webhook logfile at /var/log/webhook/access.log, and send requests (e.g. using curl). Example output if successful:

$ tail -f /var/log/webhook/access.log
...
[2015-05-03 13:01:45] DEBUG Rack::Handler::WEBrick is mounted on /.
[2015-05-03 13:01:45] INFO  WEBrick::HTTPServer#start: pid=7185 port=8088
[2015-05-03 13:02:46] DEBUG accept: 192.30.252.46:39379
[2015-05-03 13:02:46] DEBUG Rack::Handler::WEBrick is invoked.
[2015-05-03 13:02:46] INFO  authenticated: puppet
[2015-05-03 13:02:46] INFO  message: triggered: r10k deploy environment test_webhook -pv ...
...

Docker

If you are building your image with the puppet, you need to prevent the webhook process from starting as a daemon.

The following is an example of declaring the webhook without a background mode

class { 'r10k::webhook':
  . . .
  background  => false  
}

Ignore deploying some environments

If you need to configure webhook to not trigger r10k when changes pushed in some branch or repository, you can list them in r10k::webhook::config::ignore_environments parameter as array. There is an ability to specify it as a regular expression by enclosing it in forward slashes.

Here is an example where the test branch in dev repository and all branches in all repositories that includes the word 'feature' in names will be skipped:

class { 'r10k::webhook::config':
  . . .
  prefix               => ':repo',
  ignore_environments  => ['dev_test', '/.*feature.*/']
}

Passing extra arguments to mco command

You can pass some additional arguments to mco command like --no-progress or --timeout 60 or any others by specifying them in the r10k::webhook::config::mco_arguments parameter as string:

class { 'r10k::webhook::config':
  . . .
  mco_arguments  => '--no-progress'
}

Reference

####Class: r10k This is the main public class to be declared , handingly installation and configuration declarations

Parameters within r10k:

remote

A string to be passed in as the source with a hardcode prefix of puppet

sources

A hash of all sources, this gets read out into the file as yaml. Must not be declared with remote

cachedir

A single string setting the r10k.yaml configuration value of the same name

configfile

A path to the configuration file to manage. Be aware Puppet Enterprise 4.0 and higher may conflict if you manage /etc/puppetlabs/puppet/r10k.yaml

version

A value passed to the package resource for managing the gem version

modulepath

Deprecated: for older configfile environments configuration of modulepath in puppet.conf

manage_modulepath

Deprecated: declare a resource for managing modulepath in Puppet.conf

manage_ruby_dependency

When using system ruby , options on how to declare

r10k_basedir

This module requires the puppetlabs-ruby module. In the event that your environment already includes the module with some customization, you can use the manage_ruby_dependency parameter to adjust how this module expresses that requirement. The supported values are include,declare, or ignore. The values' behavior is outlined below:

• declare default This will explicitly declare the ruby module. Additional declarations of the ruby module will result in an inability to compile a catalog.

• include This will simply include the ruby module. When combined with class ordering, this will permit the user to manage the instantiation of the ruby module elsewhere, potentially with non-standard parameter values.

• ignore This will assume that ruby is handled via some other mechanism than a puppet module named ruby. It is left to the user to insure the requirement be met.

package_name

The name of the package to be installed via the provider

provider

The supported installation modes for this module

• portage
• yum
• bundle
• puppet_gem
• gem
• zypper

gentoo_keywords

See r10k::install::portage class for more information

install_options

Options to pass to the provider declaration

mcollective

Install mcollective application and agents. This does NOT configure mcollective automatically

manage_configfile_symlink

Manage a symlink to the configuration file, for systems installed in weird file system configurations

git_settings

This is the git: key in r10k, it accepts a hash that can be used to configure rugged support.

    $git_settings = {
      'provider'    => 'rugged',
      'private_key' => '/root/.ssh/id_rsa',
    }

    class {'r10k':
      remote       => 'git@github.com:acidprime/puppet.git',
      git_settings => $git_settings,
    }

forge_settings

This is the forge: key in r10k, it accepts a hash that contains settings for downloading modules from the Puppet Forge.

    $forge_settings = {
      'proxy'   => 'https://proxy.example.com:3128',
      'baseurl' => 'https://forgeapi.puppetlabs.com',
    }

    class {'r10k':
      remote         => 'git@github.com:acidprime/puppet.git',
      forge_settings => $forge_settings,
    }

deploy_settings

This is the deploy: key in r10k, it accepts a hash that contains setting that control how r10k code deployments behave. Documentation for the settings can be found here.

    $deploy_settings = {
      'purge_levels' => ['puppetfile'],
    }

    class {'r10k':
      remote          => 'git@github.com:voxpupuli/puppet.git',
      deploy_settings => $deploy_settings,
    }

configfile_symlink

boolean if to manage symlink

include_prerun_command

Deprecated: Add prerun_command to puppet.conf to run r10k when the agent on the master runs. Suggest instead declaring r10k::postrun_command as that will run after the agent runs which prevents r10k from stopping configuration management of masters from occuring as it does with prerun_commands

include_postrun_command

r10k::include_postrun_command: true

The concept here is that this is declared on the puppet master(s) that have been configured with r10k. This will cause r10k to synchronize after each puppet run. Any errors synchronizing will be logged to the standard puppet run.

Limitations

The 4.1.x release deprecates support for:

• Puppet 3
• Ruby 1.9.3

These items are are planned for removal in v5.0.0.

##Support

Please log tickets and issues at our Projects site

##Development

###Contributing

Modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Read the complete module contribution guide

###Running tests

This project contains tests for rspec-puppet to verify functionality. For in-depth information please see their respective documentation.

Quickstart:

    gem install bundler
    bundle install --without system_tests
    bundle exec rake spec
    bundle exec rake lint

Check the .travis.yml for supported Operating System Versions

Puppetconf beer fund for all those that submit pull requests:

Change log

All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not impact the functionality of the module.

v6.1.0 (2017-06-24)

Full Changelog

Closed issues:

• Clean up the log output when deleting a branch #374

Merged pull requests:

• Quote the exact JSON response for heartbeat #379 (bittner)
• Deleted branch #376 (rnelson0)
• Add Troubleshooting section (logfile, heartbeat) to README #375 (bittner)
• Fix github license detection #372 (alexjfisher)

v6.0.0 (2017-05-10)

Full Changelog

Implemented enhancements:

• Add slack_proxy_url parameter #368 (alexjfisher)

Closed issues:

• Support using webhook slack notifier through a proxy #367
• webhook gems aren't installable #365
• cachedir setting is not idempotent #351
• webhook fails to auto-start on Systemd based systems #339

Merged pull requests:

• Release 6.0.0 #371 (dhollinger)
• BREAKING: Fix webhook installation by pinning sinatra gem #366 (alexjfisher)
• Webhook: ability to pass extra arguments to mco #363 (nike38rus)
• use stdlib puppet facts for configuration #352 (vchepkov)
• Added /heartbeat url endpoint to webhook #272 (thebaron)

v5.0.2 (2017-04-07)

Full Changelog

Closed issues:

• Webhook not compatible with Puppet 4.10.0 #359

Merged pull requests:

• Release 5.0.2 #361 (dhollinger)
• Add check to fix the ruby path on puppet 4.10.0 #360 (dhollinger)
• Webhook: ignore deploying some environments #355 (nike38rus)

v5.0.1 (2017-04-06)

Full Changelog

Closed issues:

• Migrate r10k module to Vox Pupuli #290

Merged pull requests:

• Release 5.0.1 #358 (bastelfreak)
• puppet-lint: fix arrow_on_right_operand_line #357 (bastelfreak)
• Create sanitize_input helper method for strings sent to run_command method. #356 (xraystyle)
• Use styleguide compliant syntax for sshkey example. #353 (kallies)
• Fix webhook slack_username parameter handling #350 (alexbrett)
• Webhook Background mode #349 (luckyraul)

v5.0.0 (2017-03-07)

Full Changelog

Closed issues:

• r10k.yaml placement is incorrect #342

Merged pull requests:

• Release 5.0.0 #347 (rnelson0)
• r10k.yaml contents indentation is incorrect #345 (Kotty666)
• Update yaml location for >PE3 #343 (rnelson0)
• replace all validate functions with datatypes #341 (bastelfreak)
• Cleanup webhook use case notes; specifically PE/FOSS split. #338 (rnelson0)
• Remove support for Puppet 3 and Ruby \<2.0.0 #321 (rnelson0)
• Ensure webhook run folder exists on redhat systemd environments #283 (luisfdez)

v4.2.0 (2017-02-12)

Full Changelog

Closed issues:

• Add support for changing deploy settings #332
• Document breaking changes in CHANGELOG #306
• Status 42, OK, but it doesn't completely work #261
• (enhancement) pre-commit hook only validates what's on disk #234

Merged pull requests:

• Added new 'deploy_settings' information #334 (triforce)
• Add support for changing the 'deploy' settings in the r10k.yaml configuration file #333 (triforce)
• Added Slack webhook #331 (jamtur01)
• mcollective plugin dir has changed for foss puppet 4 #330 (attachmentgenie)
• Better document soft dependency abrader/gms #327 (rnelson0)

v4.1.0 (2017-01-06)

Full Changelog

Closed issues:

• Conflict between r10k subclasses and pe_r10k due to require r10k in subclasses #323
• Re-visit hard-coded version - 1.5.1 #284
• (maint) Remove ruby 1.8.7 support from the module #231

Merged pull requests:

• Release 4.1.0 #325 (rnelson0)
• (GH323) Better parameterization of root user/group from #279 #324 (rnelson0)
• Fix rubocop failures from #268 #322 (rnelson0)
• Bump minimum version dependencies (for Puppet 4) #318 (juniorsysadmin)
• Bump puppet minimum version_requirement to 3.8.7 #315 (juniorsysadmin)
• [284] Replace hard-coded version 1.5.1 with installed #308 (rnelson0)
• use puppet/make instead of deprecated croddy/make #307 (croddy)
• Lockfile to mitigate r10k race condition. #268 (binford2k)

v4.0.2 (2016-11-20)

Full Changelog

Merged pull requests:

• Release 4.0.2 #305 (rnelson0)

v4.0.1 (2016-11-20)

Full Changelog

Merged pull requests:

• Changelog for 4.0.1 #304 (rnelson0)
• Release 4.0.1 #303 (rnelson0)

v4.0.0 (2016-11-20)

Full Changelog

Closed issues:

• 'require git' appears to be unnecessary #286
• Webhook cannot do new puppet module install #280
• mcollective agent unable to find r10k binary #275
• MCollective r10k only syncs git based modules #273
• images in README.md broken #263

Merged pull requests:

• Reformat release header for 4.0.0 #302 (rnelson0)
• Rename CHANGELOG.md #301 (rnelson0)
• Release candidate for v4.0.0 #299 (rnelson0)
• Fixes Puppet 4 path for webhook #295 (andrewwippler)
• Update config_version.sh #291 (seanscottking)
• Fix testing #288 (ghoneycutt)
• Duplicate certpath key #287 (seanscottking)
• unbreak on OS where root group != 'root' #279 (buzzdeee)
• Add support for custom permissions and ownership of webhooks.yaml #278 (elconas)
• add curl example to readme #274 (jessereynolds)
• fix mcollective image #264 (mmckinst)
• Add GitHub signature #262 (ayohrling)

v3.2.0 (2015-12-16)

Full Changelog

Implemented enhancements:

• (feature) Add forge_settings param from pe_r10k #244

Closed issues:

• Agent activation fails on mcollective 2.8.6 (open source puppet 4.2) #254
• Mcollective plugins_dir is incorrect for FOSS Puppet 4 #245

Merged pull requests:

• Support for TFS/Visual Studio Git #259 (jpadams)
• Add option to lowercase environment names #256 (binford2k)
• adding server_software option to obscure the server software in use #253 (uphillian)
• postrun array requires spaces between elements #252 (mpeter)
• Grab the correct field for repo username #251 (binford2k)
• Handle tagged release events #250 (binford2k)
• configure forge settings with config class #249 (juame)
• Align webhook prefix command behavior with r10k behavior #248 (stepanstipl)
• Log when r10k not found in PATH #247 (joshbeard)
• update plugins_dir for FOSS puppet #246 (velocity303)
• create the /etc/puppetlabs/r10k directory #242 (mmckinst)
• Add single request concurrency option in r10k webhook #240 (pdaukintis)

v3.1.1 (2015-08-12)

Full Changelog

Implemented enhancements:

• (Feature) Webhook: Add timestamp to mco_output.log #215

Fixed bugs:

• stderr of the which command shows during Puppet runs on agent nodes #241

v3.1.0 (2015-08-10)

Full Changelog

Merged pull requests:

• Fix typo #238 (mcanevet)
• Automatically calculate some prefixes #236 (binford2k)
• Add the ability to respond only to certain events #235 (binford2k)
• Let rb scripts resolve what ruby to use themselves #233 (attachmentgenie)

v2.8.4 (2015-08-03)

Full Changelog

Merged pull requests:

• Making r10k webhook 2015.x compatible #229 (WhatsARanjit)

v3.0.0 (2015-07-31)

Full Changelog

Implemented enhancements:

• [Feature] Support BitBucket Pull-merge in Webhook (or other git services with non-standard webhooks) #192
• Added support for BitBucket merge hooks #193 (ayohrling)

Closed issues:

• r10k and Webhook install using system ruby on CentOS 6 using Puppet 4.2.0 from "Puppet Collection 1" repo. #220
• Feature Request: add a r10k postrun hook for directory environment cache invalidation #211
• Feature Request: custom fact location of r10k binary #210
• webhook.yaml recreated on every puppet run #209
• Permissions for environments created by the webhook are incorrect #191
• move r10k.yaml to /etc/puppetlabs/r10k/r10k.yaml #190
• Webhook issues for init service without hasstatus=> false #188
• puppetconf_path is incorrect for puppet4 #187
• use of ::pe_version fails puppet run when strict_variables is enabled on foss puppet #160

Merged pull requests:

• Mco plugin directory is corrected #230 (WhatsARanjit)
• OpenBSD 5.8 switches default ruby version to 2.2, therefore #228 (buzzdeee)
• Added support for BitBucket push webhooks. #227 (dharmabruce)
• Moved r10k file and basedir #226 (WhatsARanjit)
• Provider for 2015.x uses puppet_gem instead of pe_gem #225 (WhatsARanjit)
• Puppet 4 Changes #224 (acidprime)
• Add a custom fact 'r10k_path' #222 (poikilotherm)

v2.8.3 (2015-07-17)

Full Changelog

Implemented enhancements:

• [Bug] Webhook does not support Ping event from GitHub #89

Fixed bugs:

• \[Bug\] Webhook does not support Ping event from GitHub #89

Closed issues:

• hiera_eyaml on pe 3.7+ is broken. #216
• webhook::package inclusion in r10k::webhook class #213
• systemd issues on RHEL7 #208
• systemd doesn't detect webhook as running #207

Merged pull requests:

• (METHOD-401) Fix Webhook Service on EL7 #218 (jveski)
• Changes in r10k::webhook class #214 (pdaukintis)
• Add EnvironmentFile line as optional #206 (brandonweeks)

v2.8.2 (2015-06-26)

Full Changelog

v2.8.1 (2015-06-24)

Full Changelog

Implemented enhancements:

• [Deprecation] Remove purgedirs support #84 (trlinkin)

Closed issues:

• NoMethodError when GitHub send webhook 'ping' #200
• EnvironmentFile removed from webhook unit file #197
• Webhook returns status 200 even if deploy fails #195
• webhook script should write a pidfile #171
• Change git_ssl_verify parameter name #165

Merged pull requests:

• R10k/issues/200 #201 (brandonweeks)
• Return http 500 instead of http 200 on error #199 (brandonweeks)
• Restore EnvironmentFile line as optional #198 (brandonweeks)
• 188 - Webhook segfault on status #194 (ayohrling)
• add puppet_gem provider #186 (mmckinst)
• Added webhook_group parameter lost in 0da328831ecd49c2671017e16d614dbdc1842b7c #185 (vchepkov)
• Change the way the webhook logs the r10k deploy command #184 (tampakrap)
• Include the r10k::webhook::config class in r10k::webhook #183 (tampakrap)
• improve the webhook systemd unit file #182 (tampakrap)
• Updates in the webhook config #181 (tampakrap)
• Conditionally install the webhook packages #180 (tampakrap)
• Add SUSE support in the webhook init file #179 (tampakrap)
• Remove the hardcoded hasstatus => false from the webhook service #178 (tampakrap)
• Move the $webhook::{user,group} definition to params.pp #177 (tampakrap)
• Use the webhook's systemd service file for openSUSE >= 12.1 and SLE12 #176 (tampakrap)
• webhook: include mcollective optionally #175 (tampakrap)
• Fix for #165 #174 (petems)
• Actually run as non-root, --user is for matching not chuid. #173 (robbat2)
• Gentoo & Pidfile/Init fixes #172 (robbat2)
• Fix non-ssl, abilliy to customize templates, and run with less privileges (but call r10k/mco via sudo) #170 (robbat2)
• Update stash_mco.rb #169 (brdude)
• Fix a few typos. #167 (gabe-sky)
• Add support for OpenBSD, some noteworthy points to mention: #163 (buzzdeee)
• add logic to prevent issue with pe_version on foss puppet with strict_variables enabled #161 (smithtrevor)

v2.8.0 (2015-05-12)

Full Changelog

Closed issues:

• Webhook does not install properly in PE 3.7 #164

Merged pull requests:

• Systemd #168 (trlinkin)

v2.7.4 (2015-05-08)

Full Changelog

Closed issues:

• Webhook: Invalid yaml and unstartable service with FOSS #162

Merged pull requests:

• (162) Revert to original webhook.yaml.erb contents #166 (rnelson0)
• Update r10k gem version for v2.7.x module version #159 (aharden)

v2.7.3 (2015-04-22)

Full Changelog

Implemented enhancements:

• prefix support #42

v2.7.2 (2015-04-21)

Full Changelog

Closed issues:

• Gem install has the space problem regressed. #155

v2.7.1 (2015-04-20)

Full Changelog

Implemented enhancements:

• /var/log/webhook permissions not managed properly #144

Fixed bugs:

• Sinatra gem required for PE webhook? #154
• /var/log/webhook permissions not managed properly #144

Merged pull requests:

• Support of Puppet FOSS for Webhook #150 (acidprime)

v2.7.0 (2015-04-08)

Full Changelog

Implemented enhancements:

• [enhancement] mcollective agent as non-root #135

Fixed bugs:

• Module upgrade does not upgrade r10k gem #126
• Option to NOT install the r10k package #74

Merged pull requests:

• 3.x #148 (acidprime)

v2.6.5 (2015-03-18)

Full Changelog

Fixed bugs:

• web hook does not work for non-mco install #139

Closed issues:

• Add Gitlab support (or add Gitlab documentation) #145

Merged pull requests:

• fix for /var/run being mounted on tmpfs in ubuntu 14.04 #147 (spidersddd)
• Add commas in README example #143 (cmurphy)
• support for 'user' argument to su to another user when executing git and R10K #142 (GeoffWilliams)

v2.6.4 (2015-02-26)

Full Changelog

Fixed bugs:

• puppet enterprise 3.7.0 webhook (no mcollective) ordering problem #138
• pre_commit ruby script fails puppet-lint if you are in the wrong working directory #130
• webhook does not normalize branch name #115

v2.6.3 (2015-02-24)

Full Changelog

Closed issues:

• prerun_command setting has no dependencies #36

Merged pull requests:

• Ensure webhook dependencies are met before running the service #134 (elyscape)

v2.6.2 (2015-02-19)

Full Changelog

Fixed bugs:

• webhook module tries to start up before the mcollective cert is installed #132

Merged pull requests:

• issue #132 making peadmin-cert.pem execute before webhook init script #133 (harrytford)
• Support puppet-lint v1 #131 (ghoneycutt)
• Travis-ci to use faster container based systems #129 (ghoneycutt)
• Support Puppet v3.7.x #128 (ghoneycutt)

v2.6.1 (2015-02-13)

Full Changelog

Merged pull requests:

• Add r10k_deploy_arguments for non-MCO deploys #125 (glarizza)

v2.6.0 (2015-02-11)

Full Changelog

Merged pull requests:

• Use 0.0.0.0 as default webhook bind address #124 (elyscape)
• Added bind_address option to webhook.yaml #123 (WhatsARanjit)
• Use zypper as default provider for openSUSE #122 (tampakrap)
• added metadata.json file for puppet versions 3.6 and older #121 (vchepkov)
• Update webhook.pp - adjusted peadmin-cert.pem #120 (aharden)

v2.5.4 (2015-02-03)

Full Changelog

Closed issues:

• mco doesn't deploy modules when using forge functionality of Puppetfile #65

v2.5.3 (2015-01-29)

Full Changelog

Closed issues:

• Dependency disappeared from forge. #116
• Ubuntu 14.04 webhook init fails #105
• r10k::webhook::config provides support for changing config file path, but the webhook script has this hardcoded #90

Merged pull requests:

• Remove +x permissions from peadmin-cert.pem #119 (elyscape)
• 105 updated webhook.ini.erb for ubuntu support #118 (MarsuperMammal)

v2.5.2 (2015-01-16)

Full Changelog

Closed issues:

• invalid_branches configuration #85
• Feature Request: Updated doc to use hieradata for sources #80

Merged pull requests:

• depend on croddy/make instead of mhuffnagle/make #117 (croddy)
• support strict_variables = true #114 (jlambert121)

v2.5.1 (2014-12-17)

Full Changelog

v2.5.0 (2014-12-17)

Full Changelog

Closed issues:

• PE 3.7.0 breaks webhook, peadmin cert name changed #110
• r10k 1.4.0 has been released #106
• Missing dependency on webhook after upgrade to PE 3.7.0 #104
• webhook should support r10k deploy module foo end point #101

Merged pull requests:

• Spelling #111 (skibum55)

v2.4.4 (2014-12-15)

Full Changelog

Closed issues:

• Webhook sends incorrect command to r10k if branch name contains / #108
• Documentation issues #99

Merged pull requests:

• Handle branch names containing slashes #109 (elyscape)
• prevent potential leakage of Default {} resources #107 (igalic)
• Documentation fixes #103 (elyscape)

v2.4.3 (2014-11-22)

Full Changelog

Closed issues:

• Versions and the Puppet Forge #100

v2.4.2 (2014-11-21)

Full Changelog

v2.4.1 (2014-11-21)

Full Changelog

v2.4.0 (2014-11-21)

Full Changelog

Closed issues:

• r10k 1.3.5 has been released #98

v2.3.4 (2014-11-20)

Full Changelog

Closed issues:

• Webhook service does not start at boot #94
• Webhook service is not refreshed when config file changes #93

Merged pull requests:

• Refresh webhook service when config file changes #91 (elyscape)

v2.3.3 (2014-11-20)

Full Changelog

Closed issues:

• Add release tag for 2.3.1 #92

Merged pull requests:

• Check for variations of $is_pe #97 (xaque208)

v2.3.2 (2014-11-20)

Full Changelog

Merged pull requests:

• Replaced references to type() function with is_string() for Puppet 3.7.x... #96 (xaque208)

v2.3.1 (2014-11-11)

Full Changelog

Closed issues:

• pe\_gem install of the r10k gem is wonked #87
• mco r10k sync leave environment in a broken state #77
• Please cut new release #76
• Remove technology stack dependencies from installation process #66
• License #53
• Dependency on puppetlabs-ruby constrains use #49

Merged pull requests:

• Change install_options to undef #88 (binford2k)
• Fix tests for manage_ruby_dependency => 'include' #86 (gsarjeant)
• Allow for non-linux #83 (xaque208)
• Update CHANGELOG #82 (ghoneycutt)
• bumped version 1.3.4 #81 (kennyg)

v2.3.0 (2014-09-15)

Full Changelog

Closed issues:

• Invalid path to r10k.ddl #72
• trouble with remote ssl posts from stash to the webhook #62

Merged pull requests:

• Stash webhook helper #78 (adamcrews)
• Allow prefixing to be optional #75 (trlinkin)
• Fixes #72 #73 (robruma)
• provide a knob to flexibly manage the ruby requirement #67 (wolfspyre)

v2.2.8 (2014-08-28)

Full Changelog

Closed issues:

• r10k::include_prerun_command doesn't apply changes during the current run #69
• breaking master when I apply r10k config #64
• update params.pp to the latest r10k? #60
• Missing dependency on service mcollective #39
• Deploy single environment with Puppetfile #21

Merged pull requests:

• Fix minor lint issues #71 (adamcrews)
• change webhook exec to execute the command built previously #70 (k-f)
• Adding support for application/x-www-form-urlencoded content type webhooks #68 (robruma)
• Fix default postrun_command #63 (joshbeard)

v2.2.7 (2014-07-16)

Full Changelog

v2.2.6 (2014-07-16)

Full Changelog

v2.2.5 (2014-07-16)

Full Changelog

Closed issues:

• Deploy single environment and prerun_command #52

Merged pull requests:

• Fixup the webhook script #59 (adamcrews)
• Fix quoting to pass linting #57 (adamcrews)

v2.2.4 (2014-07-07)

Full Changelog

v2.2.3 (2014-07-07)

Full Changelog

v2.2.2 (2014-07-07)

Full Changelog

Closed issues:

• r10k::webhook Service resource pattern is too loose #54
• install fails on PE 3.2.2 due to Puppet Module Tool Bug #43

Merged pull requests:

• Removed symlinked r10k fixture/modules directory. #56 (dreilly1982)

v2.2.1 (2014-06-04)

Full Changelog

v2.1.2 (2014-06-04)

Full Changelog

Merged pull requests:

• Stop quoting all configuration options so that prefix is not always on #51 (ghoneycutt)

v2.1.1 (2014-06-03)

Full Changelog

v2.1.0 (2014-06-03)

Full Changelog

Closed issues:

• rubygems-update makes r10k non idempotent on fresh install #37
• r10k.yaml is rebuilt (md5sum differs) every Puppet run on ruby 1.8.7 #25

Merged pull requests:

• Attempted fix for issue#25 #44 (tfhartmann)

v2.0.0 (2014-06-03)

Full Changelog

Closed issues:

• does this module support Puppetfile? #40
• $r10k::params::sources doesn't exist #19

Merged pull requests:

• Support Puppet v3.6.0 #50 (ghoneycutt)
• ensure webhook initscript is ordered correctly #48 (dhgwilliam)
• Add class for postrun_command #47 (joshbeard)
• never update gem with rubygems-update #45 (pall-valmundsson)
• Add ability to specify a symlink for r10k.yaml #41 (ghoneycutt)

v1.0.2 (2014-02-19)

Full Changelog

v1.0.1 (2014-02-11)

Full Changelog

Merged pull requests:

• don't ignore basedir parameter #35 (welterde)
• update travis config, minor lint fixes #34 (jlambert121)

v1.0.0 (2014-02-09)

Full Changelog

Closed issues:

• r10k does not run sometimes #31
• Exit status 42. Is that a git not found in path error? #12

Merged pull requests:

• Update config tests #33 (xaque208)
• Update config.pp #32 (xaque208)
• add ability to include mcollective agent through main class #30 (jlambert121)
• update travis config, minor lint fixes #29 (jlambert121)
• fixes for open-source puppet edition #28 (attilabogar)
• The gem is called 'bundler' #27 (glarizza)
• Bump to 0.0.10 #26 (glarizza)
• Ability to pass package_name #24 (tampakrap)
• new URL for the make module #23 (tampakrap)
• require git only when installing via gem or bundler #22 (tampakrap)
• Add tests for Gentoo #18 (tampakrap)

v0.0.9 (2013-10-21)

Full Changelog

Closed issues:

• Ruby class is not singleton #17
• Could not find declared class ::ruby at /etc/puppet/modules/r10k/manifests/install/gem.pp:10 #16
• Deprecation warning #11
• Require Git #10

v0.0.8 (2013-10-15)

Full Changelog

Closed issues:

• Cannot install on PE3.0 #2

Merged pull requests:

• refresh mco if we install the r10k app #15 (nvalentine-puppetlabs)
• Refactor install.pp and add Gentoo Portage support #14 (tampakrap)
• Set prerun_command with inifile instead of augeas #13 (tampakrap)
• Update config.pp #9 (bxm)
• Install using bundle option added for bleeding edge features not in gem ... #8 (diginc)

v0.0.7 (2013-09-10)

Full Changelog

Merged pull requests:

• Move environemnt logic from config.pp to params.pp #7 (reidmv)
• Clean up install class #6 (reidmv)

v0.0.5 (2013-08-24)

Full Changelog

Merged pull requests:

• Manage puppet.conf's $modulepath #4 (glarizza)
• fixing comment typo #3 (fiddyspence)

v0.0.4 (2013-07-25)

Full Changelog

v0.0.3 (2013-07-25)

Full Changelog

Merged pull requests:

• Update R10k for PE #1 (glarizza)

v0.0.2 (2013-07-11)

Full Changelog

v0.0.1 (2013-06-12)

* This Change Log was automatically generated by github_changelog_generator