README

Packer

Build Status Discuss PkgGoDev GoReportCard codecov

HashiCorp Packer logo

Packer is a tool for building identical machine images for multiple platforms from a single source configuration.

Packer is lightweight, runs on every major operating system, and is highly performant, creating machine images for multiple platforms in parallel. Packer comes out of the box with support for many platforms, the full list of which can be found at https://www.packer.io/docs/builders.

Support for other platforms can be added via plugins.

The images that Packer creates can easily be turned into Vagrant boxes.

Quick Start

Note: There is a great introduction and getting started guide for those with a bit more patience. Otherwise, the quick start below will get you up and running quickly, at the sacrifice of not explaining some key points.

First, download a pre-built Packer binary for your operating system or compile Packer yourself.

After Packer is installed, create your first template, which tells Packer what platforms to build images for and how you want to build them. In our case, we'll create a simple AMI that has Redis pre-installed.

Save this file as quick-start.pkr.hcl. Export your AWS credentials as the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.

variable "access_key" {
  type    = string
  default = "${env("AWS_ACCESS_KEY_ID")}"
}

variable "secret_key" {
  type    = string
  default = "${env("AWS_SECRET_ACCESS_KEY")}"
}

locals { timestamp = regex_replace(timestamp(), "[- TZ:]", "") }

source "amazon-ebs" "quick-start" {
  access_key    = "${var.access_key}"
  ami_name      = "packer-example ${local.timestamp}"
  instance_type = "t2.micro"
  region        = "us-east-1"
  secret_key    = "${var.secret_key}"
  source_ami    = "ami-af22d9b9"
  ssh_username  = "ubuntu"
}

build {
  sources = ["source.amazon-ebs.quick-start"]
}

Next, tell Packer to build the image:

$ packer build quick-start.pkr.hcl
...

Packer will build an AMI according to the "quick-start" template. The AMI will be available in your AWS account. To delete the AMI, you must manually delete it using the AWS console. Packer builds your images, it does not manage their lifecycle. Where they go, how they're run, etc., is up to you.

Documentation

Comprehensive documentation is viewable on the Packer website at https://www.packer.io/docs.

Contributing to Packer

See CONTRIBUTING.md for best practices and instructions on setting up your development environment to work on Packer.

Unmaintained Plugins

As contributors' circumstances change, development on a community maintained plugin can slow. When this happens, the Packer team may mark a plugin as unmaintained, to clearly signal the plugin's status to users.

What does unmaintained mean?

  1. The code repository and all commit history will still be available.
  2. Documentation will remain on the Packer website.
  3. Issues and pull requests are monitored as a best effort.
  4. No active development will be performed by the Packer team.

If anyone form them community is interested in maintaining a community supported plugin, please feel free to submit contributions via a pull- request for review; reviews are generally prioritized over feature work when possible. For a list of open plugin issues and pending feature requests see the Packer Issue Tracker.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
builder
alicloud/ecs
The alicloud contains a packersdk.Builder implementation that builds ecs images for alicloud.
The alicloud contains a packersdk.Builder implementation that builds ecs images for alicloud.
azure/chroot
Package chroot is able to create an Azure managed image without requiring the launch of a new virtual machine for every build.
Package chroot is able to create an Azure managed image without requiring the launch of a new virtual machine for every build.
azure/pkcs12
Package pkcs12 implements some of PKCS#12.
Package pkcs12 implements some of PKCS#12.
azure/pkcs12/rc2
Package rc2 implements the RC2 cipher https://www.ietf.org/rfc/rfc2268.txt http://people.csail.mit.edu/rivest/pubs/KRRR98.pdf This code is licensed under the MIT license.
Package rc2 implements the RC2 cipher https://www.ietf.org/rfc/rfc2268.txt http://people.csail.mit.edu/rivest/pubs/KRRR98.pdf This code is licensed under the MIT license.
googlecompute
The googlecompute package contains a packersdk.Builder implementation that builds images for Google Compute Engine.
The googlecompute package contains a packersdk.Builder implementation that builds images for Google Compute Engine.
linode
The linode package contains a packersdk.Builder implementation that builds Linode images.
The linode package contains a packersdk.Builder implementation that builds Linode images.
lxc
lxd
oracle/oci
Package oci contains a packersdk.Builder implementation that builds Oracle Bare Metal Cloud Services (OCI) images.
Package oci contains a packersdk.Builder implementation that builds Oracle Bare Metal Cloud Services (OCI) images.
osc/bsu
Package bsu contains a packersdk.Builder implementation that builds OMIs for Outscale OAPI.
Package bsu contains a packersdk.Builder implementation that builds OMIs for Outscale OAPI.
osc/bsusurrogate
Package bsusurrogate contains a packersdk.Builder implementation that builds a new EBS-backed OMI using an ephemeral instance.
Package bsusurrogate contains a packersdk.Builder implementation that builds a new EBS-backed OMI using an ephemeral instance.
osc/bsuvolume
The ebsvolume package contains a packersdk.Builder implementation that builds EBS volumes for Outscale using an ephemeral instance,
The ebsvolume package contains a packersdk.Builder implementation that builds EBS volumes for Outscale using an ephemeral instance,
osc/chroot
Package chroot is able to create an Outscale OMI without requiring the launch of a new instance for every build.
Package chroot is able to create an Outscale OMI without requiring the launch of a new instance for every build.
ucloud/uhost
The ucloud-uhost contains a packersdk.Builder implementation that builds uhost images for UCloud UHost instance.
The ucloud-uhost contains a packersdk.Builder implementation that builds uhost images for UCloud UHost instance.
vmware/common
These functions are compatible with WS 9 and 10 on *NIX These functions are compatible with WS 9 and 10 on *NIX
These functions are compatible with WS 9 and 10 on *NIX These functions are compatible with WS 9 and 10 on *NIX
cmd
mapstructure-to-hcl2
mapstructure-to-hcl2 fills the gaps between hcl2 and mapstructure for Packer By generating a struct that the HCL2 ecosystem understands making use of mapstructure tags.
mapstructure-to-hcl2 fills the gaps between hcl2 and mapstructure for Packer By generating a struct that the HCL2 ecosystem understands making use of mapstructure tags.
packer-plugins-check
packer-plugin-check is a command used by plugins to validate compatibility and basic configuration to work with Packer.
packer-plugin-check is a command used by plugins to validate compatibility and basic configuration to work with Packer.
snippet-extractor
snippet-extract --begin=#_BEGIN_WRAP_TAG_ --end=#_END_WRAP_TAG_ -output_dir=./docs/ [./file|./directory/]...
snippet-extract --begin=#_BEGIN_WRAP_TAG_ --end=#_END_WRAP_TAG_ -output_dir=./docs/ [./file|./directory/]...
Package hcl2template defines code to parse hcl2 template files.
Package hcl2template defines code to parse hcl2 template files.
addrs
Package addrs contains types that represent "addresses", which are references to specific objects within a Packer configuration.
Package addrs contains types that represent "addresses", which are references to specific objects within a Packer configuration.
repl
Package repl provides the structs and functions necessary to run REPL for HCL2.
Package repl provides the structs and functions necessary to run REPL for HCL2.
helper
wrappedreadline
STOLEN SHAMELESSLY FROM THE TERRAFORM REPO BECAUSE VENDORING OUT WRAPPEDREADLINE AND WRAPPEDSTREAMS FELT LIKE TOO MUCH WORK.
STOLEN SHAMELESSLY FROM THE TERRAFORM REPO BECAUSE VENDORING OUT WRAPPEDREADLINE AND WRAPPEDSTREAMS FELT LIKE TOO MUCH WORK.
wrappedstreams
STOLEN SHAMELESSLY FROM THE TERRAFORM REPO BECAUSE VENDORING OUT WRAPPEDREADLINE AND WRAPPEDSTREAMS FELT LIKE TOO MUCH WORK.
STOLEN SHAMELESSLY FROM THE TERRAFORM REPO BECAUSE VENDORING OUT WRAPPEDREADLINE AND WRAPPEDSTREAMS FELT LIKE TOO MUCH WORK.
plugin-getter
Package plugingetter defines means to download and install plugins.
Package plugingetter defines means to download and install plugins.
post-processor
vagrant
vagrant implements the packersdk.PostProcessor interface and adds a post-processor that turns artifacts of known builders into Vagrant boxes.
vagrant implements the packersdk.PostProcessor interface and adds a post-processor that turns artifacts of known builders into Vagrant boxes.
vagrant-cloud
vagrant_cloud implements the packersdk.PostProcessor interface and adds a post-processor that uploads artifacts from the vagrant post-processor and vagrant builder to Vagrant Cloud (vagrantcloud.com) or manages self hosted boxes on the Vagrant Cloud
vagrant_cloud implements the packersdk.PostProcessor interface and adds a post-processor that uploads artifacts from the vagrant post-processor and vagrant builder to Vagrant Cloud (vagrantcloud.com) or manages self hosted boxes on the Vagrant Cloud
provisioner
chef-client
This package implements a provisioner for Packer that uses Chef to provision the remote machine, specifically with chef-client (that is, with a Chef server).
This package implements a provisioner for Packer that uses Chef to provision the remote machine, specifically with chef-client (that is, with a Chef server).
chef-solo
This package implements a provisioner for Packer that uses Chef to provision the remote machine, specifically with chef-solo (that is, without a Chef server).
This package implements a provisioner for Packer that uses Chef to provision the remote machine, specifically with chef-solo (that is, without a Chef server).
powershell
This package implements a provisioner for Packer that executes powershell scripts within the remote machine.
This package implements a provisioner for Packer that executes powershell scripts within the remote machine.
puppet-masterless
Package puppetmasterless implements a provisioner for Packer that executes Puppet on the remote machine, configured to apply a local manifest versus connecting to a Puppet master.
Package puppetmasterless implements a provisioner for Packer that executes Puppet on the remote machine, configured to apply a local manifest versus connecting to a Puppet master.
puppet-server
Package puppetserver implements a provisioner for Packer that executes Puppet on the remote machine connecting to a Puppet master.
Package puppetserver implements a provisioner for Packer that executes Puppet on the remote machine connecting to a Puppet master.
salt-masterless
This package implements a provisioner for Packer that executes a saltstack state within the remote machine
This package implements a provisioner for Packer that executes a saltstack state within the remote machine
shell
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
windows-shell
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
Generate Plugins is a small program that updates the lists of plugins in command/plugin.go so they will be compiled into the main packer binary.
Generate Plugins is a small program that updates the lists of plugins in command/plugin.go so they will be compiled into the main packer binary.