packer-provisioner-inspec's Introduction

Packer InSpec Provisioner

packer-provisioner-inspec is a Packer plugin that tests machines during provisioning using InSpec.

Install

Build and install the plugin (you'll need git and go):

make install

Usage

Add the provisioner to your packer template:

{
  "variables": {
    "version":  "0.1",
    "box_name": "test-project"
  },
  "builders": [ ... ],
  "provisioners": [{
    "type": "inspec",
    "test_path": "inspec/example.rb"
  }]
}

The connection to the images being built is facilitated via a local SSH proxy that InSpec connects to.

Configuration Reference

required parameters

test_path - The relative path to the InSpec test file or profile to be utilized.

optional parameters

extra_arguments (array of strings) - An array of extra arguments to pass to the inspec command. By default, this is empty. These arguments will be passed through a shell and arguments should be quoted accordingly. Usage example: "extra_arguments": ["--sudo", "--no-distinct-exit"]
local_port (string) - The port on which inspec-provisioner should first attempt to listen for SSH connections. This value is a starting point. inspec-provisioner will attempt listen for SSH connections on the first available of ten ports, starting at local_port. When local_port is missing or empty, inspec-provisioner will listen on a system-chosen port.
sftp_command (string) - The command to run on the machine to handle the SFTP protocol that InSpec will use to transfer files. The command should read and write on stdin and stdout, respectively. Defaults to /usr/lib/sftp-server -e.
ssh_host_key_file - The SSH key that will be used to run the SSH server to which InSpec connects.
ssh_authorized_key_file - The SSH public key of the InSpec ssh_user.

Recommend Projects