Puppet Bolt is available as a docker image. Container images are published to Docker Hub with tags corresponding to Bolt system package and Rubygem versions in addition to a latest tag which points at the newest version. This document covers some possible ways to use the container.
You can download the latest image from Docker Hub:
docker pull puppet/puppet-bolt
When running Bolt from the container, the localhost target is the container environment (not the Docker host environment). The following example shows running a command against the localhost target in the container.
$ docker run puppet/puppet-bolt command run 'cat /etc/os-release' -t localhost
Started on localhost...
Finished on localhost:
STDOUT:
NAME="Ubuntu"
VERSION="16.04.6 LTS (Xenial Xerus)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 16.04.6 LTS"
VERSION_ID="16.04"
HOME_URL="http://www.ubuntu.com/"
SUPPORT_URL="http://help.ubuntu.com/"
BUG_REPORT_URL="http://bugs.launchpad.net/ubuntu/"
VERSION_CODENAME=xenial
UBUNTU_CODENAME=xenial
Successful on 1 node: localhost
Ran on 1 node in 0.00 seconds
In order to pass connection information and custom module content we need to share data from the host with the container. The following sections describe some ways to accomplish sharing data with the puppet-bolt container.
In the case where no custom module content is required for the Bolt action you wish to execute with the container, and the only information you need is how to connect to targets you can pass inventory as an environment variable. The following inventory has all the information needed to connect to the example target.
---
nodes:
- name: pnz2rzpxfzp95hh.delivery.puppetlabs.net
alias: docker-example
config:
transport: ssh
ssh:
user: root
password: secret-password
host-key-check: false
Here is an example of running the built-in facts task against the target listed in inventory.
$ docker run --env "BOLT_INVENTORY=$(cat Boltdir/inventory.yaml)" puppet/puppet-bolt task run facts -t docker-example
Started on pnz2rzpxfzp95hh.delivery.puppetlabs.net...
Finished on pnz2rzpxfzp95hh.delivery.puppetlabs.net:
{
"os": {
"name": "CentOS",
"release": {
"full": "7.2",
"major": "7",
"minor": "2"
},
"family": "RedHat"
}
}
Successful on 1 node: pnz2rzpxfzp95hh.delivery.puppetlabs.net
Ran on 1 node in 0.55 seconds
This section describes making a Bolt project directory (Boltdir) available to the container. Here is the directory structure and relevant file content:
$ tree
.
└── Boltdir
├── bolt.yaml
├── inventory.yaml
├── keys
│ └── id_rsa-acceptance
└── site-modules
└── docker_task
└── tasks
└── init.sh
5 directories, 4 files
bolt.yaml
Bolt configuration file
---
log:
console:
level: notice
inventory.yaml
Store information about targets. Note the absolute path to the private key is the path in the container, not on the host.
---
nodes:
- name: pnz2rzpxfzp95hh.delivery.puppetlabs.net
alias: docker-example
config:
transport: ssh
ssh:
user: root
private-key: /Boltdir/keys/id_rsa-acceptance
host-key-check: false
init.sh
Here is a sample shell task that echoes a message parameter:
#!/bin/bash
echo "Message: ${PT_message}"
To execute the task with Docker and provide all the information from the Bolt project directory, mount the Boltdir on the host:
$ docker run --mount type=bind,source=/home/cas/working_dir/docker_bolt/Boltdir,destination=/Boltdir puppet/puppet-bolt task run docker_task message=hi -t docker-example
Started on pnz2rzpxfzp95hh.delivery.puppetlabs.net...
Finished on pnz2rzpxfzp95hh.delivery.puppetlabs.net:
Message: hi
{
}
Successful on 1 node: pnz2rzpxfzp95hh.delivery.puppetlabs.net
Ran on 1 node in 0.56 seconds
The --mount flag maps the Boltdir on the Docker host to /Boltdir in the container. The container is tagged as puppet-bolt and the rest of the invocation is all native to Bolt.
cas@cas-ThinkPad-T460p:~/working_dir/docker_bolt$ tree
.
└── Boltdir
├── bolt.yaml
├── Dockerfile
├── inventory.yaml
├── keys
│ └── id_rsa-acceptance
└── site-modules
└── docker_task
└── tasks
└── init.sh
5 directories, 5 files
You can also extend the puppet-bolt image and copy in data that will always be available for that image. To illustrate this, you can add a Dockerfile with the following content (with the directory structure defined above):
Dockerfile
FROM puppet/puppet-bolt
COPY . /Boltdir
This command builds a container image with our custom module content and tags it my-extended-puppet-bolt:
$ docker build . -t my-extended-puppet-bolt
Sending build context to Docker daemon 10.75kB
Step 1/2 : FROM puppet-bolt
---> 5d8d2c1166fc
Step 2/2 : COPY . /Boltdir
---> 03162d29a1ee
Successfully built 03162d29a1ee
Successfully tagged my-extended-puppet-bolt:latest
You can now run that container with the custom module content and connection information available inside the container:
$ docker run my-extended-puppet-bolt task run docker_task message=hi -t docker-example
Started on pnz2rzpxfzp95hh.delivery.puppetlabs.net...
Finished on pnz2rzpxfzp95hh.delivery.puppetlabs.net:
Message: hi
{
}
Successful on 1 node: pnz2rzpxfzp95hh.delivery.puppetlabs.net
Ran on 1 node in 0.56 seconds
docker pull puppet/puppet-bolt