pupperware

Run a container-based deployment of Puppet Infrastructure.

To get started, you will need an installation of Docker Compose on the host on which you will run your Puppet Infrastructure.

Running Puppet Infrastructure in Kubernetes is also a very viable option. To get started with that, you will need a running K8s cluster with Helm deployed.

We've been developing our own Helm chart which can get you up & running fast. You can find it here. It's hosted as a Helm chart here and published in the fantastic Helm Hub and Artifact Hub. The latter will allow you to make use of it by just adding the repo in your configured Helm repos.

Generally, containers included here follow Dockerfile best practices.

Required versions

• Docker Compose - must support

  version: '3'

  of the compose file format, which requires Docker Engine

  1.13.0+

  . Full compatibility matrix
  • Linux is tested with docker-compose

    1.28.6

  • Windows requires a minimum of Windows 10, Build 2004 and WSL2 as described in README-windows.md, but is no longer tested
  • OSX is tested with

    docker-compose version 1.28.5, build c4eb3a1f

• Docker Engine support is only tested on versions newer than

  17.09.0-ce

  • Linux is tested with (client and server)

    20.10.5-ce

  • OSX is tested during development with

    Docker Engine - Community

    edition
    • Client

      20.10.5

      using API version

      1.41

      (

      Git commit:        55c4c88

      )
    • Server

      20.10.5

      using API version

      1.41 (minimum version 1.12)

      (

      Git commit:       363e9a8

      )

Provisioning

Once you have Docker Compose installed, you can start the stack on Linux or OSX with:

    export ADDITIONAL_COMPOSE_SERVICES_PATH=${PWD}/gem/lib/pupperware/compose-services
    export COMPOSE_FILE=${ADDITIONAL_COMPOSE_SERVICES_PATH}/postgres.yml:${ADDITIONAL_COMPOSE_SERVICES_PATH}/puppetdb.yml:${ADDITIONAL_COMPOSE_SERVICES_PATH}/puppet.yml
    DNS_ALT_NAMES=host.example.com docker-compose up -d

With the environment variables exported, the stack can be torn down with:

    docker-compose down --volumes

The value of

DNS_ALT_NAMES

puppet

DNS_ALT_NAMES

DNS_ALT_NAMES

When you first start the Puppet Infrastructure, the stack will create a number of Docker volumes to store the persistent data that should survive the restart of your infrastructure. The actual location on disk of these volumes may be examined with the

docker inspect

• puppetserver-code

  : the Puppet code directory.

• puppetserver-config

  : Puppet configuration files, including

  puppet/ssl/

  containing certificates for your infrastructure. This volume is populated with default configuration files if they are not present when the stack starts up.

• puppetdb-ssl

  : certificates in use by the PuppetDB instance in the stack.

• puppetdb-postgres

  : the data files for the PostgreSQL instance used by PuppetDB

• puppetserver-data

  : persistent data for Puppet Server

Container Versions

By default, the puppetserver and puppetdb containers will use the

latest

PUPPETSERVER_IMAGE

PUPPETDB_IMAGE

.env

Pupperware on Windows with WSL2 (Unsupported)

Complete instructions for provisiong a server with WSL2 support are in README-windows.md

Creating the stack from PowerShell is nearly identical to other platforms, aside from how environment variables are declared:

PS> $ENV:DNS_ALT_NAMES = 'host.example.com'
PS> $ENV:ADDITIONAL_COMPOSE_SERVICES_PATH="${PWD}/gem/lib/pupperware/compose-services"
PS> $ENV:COMPOSE_FILE="${ENV:ADDITIONAL_COMPOSE_SERVICES_PATH}\postgres.yml;${ENV:ADDITIONAL_COMPOSE_SERVICES_PATH}\puppetdb.yml;${ENV:ADDITIONAL_COMPOSE_SERVICES_PATH}\puppet.yml"

PS> docker-compose up
Creating network "pupperware_default" with the default driver
Creating volume "pupperware_puppetserver-code" with default driver
Creating volume "pupperware_puppetserver-config" with default driver
Creating volume "pupperware_puppetserver-data" with default driver
Creating volume "pupperware_puppetdb-ssl" with default driver
Creating volume "pupperware_puppetdb-postgres" with default driver
Creating pupperware_postgres_1 ...
Creating pupperware_puppet_1   ...
Creating pupperware_puppet_1   ... done
Creating pupperware_postgres_1 ... done
Creating pupperware_puppetdb_1 ...
Creating pupperware_puppetdb_1 ... done
...

To delete the stack:

PS> docker-compose down
Removing network pupperware_default
...

Managing the stack

The script

bin/puppet

bin\puppet.ps1

puppet

./bin/puppet config print autosign --section
master

true

puppet x y z ...

./bin/puppet x y z ...

There is also a similar script providing easy access to

puppetserver

ca

Changing postgresql password

The postgresql instance uses password authentication for communication with the puppetdb instance. If you need to change the postgresql password, you'll need to do the following: * update the password in postgresql:

docker-compose exec postgres /bin/bash -c "psql -U \$POSTGRES_USER -c \"ALTER USER \$POSTGRES_USER PASSWORD '$dbpassword'\";"

PUPPETDB_PASSWORD

POSTGRES_PASSWORD

docker-compose.yml

docker-compose up --detach --build

Running tests

Running tests locally

This repo contains some simple tests that can be run with RSpec. To run these tests you need to have Ruby, Docker, and Docker Compose installed on the machine where you're running the tests. The tests depend on the 'rspec' and 'json' rubygems. The tests are known to run on at least ruby 1.9.3-p551 and as new as ruby 2.4.3p205.

NOTE These tests will start and stop the cluster running from the current checkout of Pupperware, so be careful where you run them from.

To run the tests: 1.

bundle install --with test

bundle exec rspec spec

Containers

The containers used in pupperware are generated based on dockerfiles in the repos for puppetserver and puppetdb. Published containers can be found on dockerhub.

Analytics Data Collection

The Puppet owned containers run in the pupperware stack collect usage data. You can opt out of providing this data.

What data is collected?

• Version of the puppetserver container.
• Version of the puppetdb container.
• Anonymized IP address is used by Google Analytics for Geolocation data, but the IP address is not collected.

Why does pupperware collect data?

We collect data to help us understand how the containers are used and make decisions about upcoming changes.

How can I opt out of pupperware container data collection?

Create a

.env

PUPPERWARE_ANALYTICS_ENABLED=false

This file is in the

.gitignore

License

See LICENSE file.

Issue Tracking

Please report any issues as GitHub issues in this repo.

Contact us!

If you have questions or comments about pupperware, feel free to send a message to the puppet-users mailing list or reach out in the #puppet channel in the puppet community slack.