Forge Home

r10k

A module to configure r10k

7,085 downloads

115 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.2.0 (latest)
  • 1.1.0
  • 1.0.4
  • 1.0.3
  • 1.0.1
  • 1.0.0
released Jan 8th 2024
This version is compatible with:
  • Puppet Enterprise 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 >=4.0.0 < 9.0.0
  • , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'cirrax-r10k', '1.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add cirrax-r10k
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install cirrax-r10k --version 1.2.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: puppet, r10k

Documentation

cirrax/r10k — version 1.2.0 Jan 8th 2024

r10k puppet module

Build Status Puppet Forge Puppet Forge Puppet Forge Puppet Forge

Table of Contents

  1. Overview
  2. Usage
  3. Reference
  4. Contribuiting

Overview

This module is used to configure r10k.

Usage

To use r10k you invoke the main r10k class on your puppet server.

class{'r10k':}

If you want to use the gitolite hook to automatically update the puppet environments on new commits, invoke the r10k::gitolite_hooks class on the git server and make the authorize the gitolite ssh key to run the r10k scripts.

class{'r10k::gitolite_hooks':}

Reference

Find documentation about possible parameters on top of each manifest or have a look at REFERENCE.md.

classes

r10k

The main class to use on the puppet server

r10k::authorized_key

Define an authorized key on the server

r10k::user

This class creates an r10k user with ssh keys etc.

r10k::gitolite_hooks

Class to install hooks on a gitolite server to trigger r10k updates.

Adaptions to other git servers are very welcome.

r10k::ssh_key

Generate an SSH authentication key for r10k to fetch git repositories.

defined types

none

Remarks

if you install r10k with the gem provider (default for RedHat family) you need to ensure that you have ruby-devel (or ruby-dev) package installed.

Contributing

Please report bugs and feature request using GitHub issue tracker.

For pull requests, it is very much appreciated to check your Puppet manifest with puppet-lint and the available spec tests in order to follow the recommended Puppet style guidelines from the Puppet Labs style guide.

Authors

This module is mainly written by Cirrax GmbH.

See the list of contributors for a list of all contributors.