Vox Pupuli R10K

Introduction

This container is designed for deploying Puppet code using r10k. It includes the r10k gem along with all necessary dependencies pre-installed, ensuring a seamless deployment process.

Usage

To run r10k, simply execute the container. The r10k binary is set as the default entrypoint. The container operates as the puppet user with a UID/GID of 999. You can use a shared volume with a Puppet server and mount it at /etc/puppetlabs/code/environments.

podman run -it --rm -v code_dir:/etc/puppetlabs/code/environments:Z ghcr.io/voxpupuli/r10k:latest deploy environment -mv

services:
  r10k:
    image: ghcr.io/voxpupuli/r10k:5.0.0-latest
    environment:
      - PUPPET_CONTROL_REPO=https://github.com/my-org/control-repo.git
    volumes:
      - puppetserver-code-dir:/etc/puppetlabs/code/environments:Z
    entrypoint: ["/docker-entrypoint.sh"]
    command: ["deploy", "environment", "-mv"]

Environment Variables

Name	Description
PUPPET_CONTROL_REPO	The control repo url to get the Puppetfile from. Defaults to https://github.com/voxpupuli/controlrepo.git

Build

Build Arguments

Name	Description
RUBYGEM_R10K	The r10k version to install
RUBYGEM_PUPPET	The puppet version to install
PUPPET_CONTROL_REPO	The control repo url to get the Puppetfile from. Defaults to https://github.com/voxpupuli/controlrepo.git
UID	The user id to use for the puppet user. Defaults to 999
GID	The group to use for the puppet user. Defaults to ping

Version Schema

The version schema has the following layout:

<r10k.major>.<r10k.minor>.<r10k.patch>-v<container.major>.<container.minor>.<container.patch>
<r10k.major>.<r10k.minor>.<r10k.patch>-latest
latest

Example usage:

docker pull ghcr.io/voxpupuli/r10k:4.1.0-v1.2.3
docker pull ghcr.io/voxpupuli/r10k:4.1.0-latest
docker pull ghcr.io/voxpupuli/r10k:latest

Name	Description
r10k.major	Describes the contained major r10k version
r10k.minor	Describes the contained minor r10k version
r10k.patch	Describes the contained patch r10k version
container.major	Describes breaking changes without backward compatibility
container.minor	Describes new features or refactoring with backward compatibility
container.patch	Describes if minor changes or bugfixes have been implemented

How to release?

see RELEASE.md

How to contribute?

see CONTRIBUTING.md