Go to file
Tyler Tidman 7f1f91d2a3 Install go binary and make sure it's in the path for vagrant 2016-01-16 19:42:28 -05:00
builder Merge pull request #2898 from markpeek/http-refactor 2016-01-14 17:10:17 -08:00
command Change log to Ui.Warn and restore the removed functionality for now 2016-01-14 17:18:02 -08:00
common Refactor http server config into common 2015-11-01 14:45:47 -08:00
communicator Implement WinRM-over-HTTPS 2016-01-12 21:28:20 -05:00
contrib/zsh-completion zsh completion 2015-04-04 13:51:59 +03:00
fix Enable headless mode by default on Parallels Desktop 11 2015-08-24 15:09:29 +02:00
helper Implement WinRM-over-HTTPS 2016-01-12 21:28:20 -05:00
packer Use alternate temp directories for docker 2015-10-20 11:34:14 -07:00
plugin Added an artifice post-processor which allows you to override artifacts in a post-processor chain 2015-08-07 18:21:23 -07:00
post-processor docker-import: allow artifice artifacts 2015-11-02 11:21:15 +00:00
provisioner Merge pull request #2653 from evertrue/evertrue/eherot/add_data_bag_secret_to_chef_client 2016-01-13 13:59:48 -08:00
scripts Remove old scripts 2016-01-13 21:52:33 -05:00
template Fix #2742: Include template line numbers on error 2015-10-25 12:28:06 -07:00
test remove bats test fixture 2015-06-12 10:41:44 -05:00
website Remove errant trailing slash from blog URL 2016-01-15 13:41:29 -08:00
.gitignore Ignore logs from packer tests 2015-10-14 16:31:43 -07:00
.travis.yml Go 1.5 should pass, since we do release builds with this now 2015-12-09 20:15:37 -08:00
CHANGELOG.md Add ESXi delete loop bugfix to changelog 2016-01-14 17:14:17 -08:00
CONTRIBUTING.md Fix go version in docs 2015-07-15 13:54:41 +03:00
LICENSE LICENSE: MPL2 2013-06-24 14:29:15 -07:00
Makefile Update makefile to tee test logs to a file so it's easier to review them after the run complete 2015-10-14 16:32:21 -07:00
README.md README.md quick-start builder example made more secure 2015-12-15 22:33:19 +00:00
Vagrantfile Install go binary and make sure it's in the path for vagrant 2016-01-16 19:42:28 -05:00
appveyor.yml Added go vet and git rev-parse head to appveyor so we can see what we're actually building / testing 2015-08-06 12:24:13 -07:00
checkpoint.go Move ConfigFile() and ConfigDir() from package main to packer 2015-10-16 17:32:36 -07:00
commands.go Implemented internal plugins 2015-10-21 16:57:38 -07:00
config.go Switch osext package from mitchellh -> kardianos #2842 2015-11-04 12:36:00 -08:00
log.go command: move more to this package, remove old packages 2014-10-27 20:31:02 -07:00
main.go Merge pull request #2846 from markpeek/packer-tmp 2015-10-26 17:09:22 -07:00
main_test.go Fatal -> Fatalf since we have a format string 2015-10-21 16:57:38 -07:00
panic.go Rename some files, style 2014-10-27 20:42:41 -07:00
signal.go add interrupt handling for SIGTERM [GH-1858] 2015-06-08 21:28:36 -07:00
stdin.go ctrl-c closes stdin for plugins so that they are unblocked 2013-07-25 23:27:13 -07:00
version.go up version for dev 2015-08-26 21:24:47 -07:00

README.md

Packer

Build Status Windows Build Status

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 the following platforms:

  • Amazon EC2 (AMI). Both EBS-backed and instance-store AMIs
  • DigitalOcean
  • Docker
  • Google Compute Engine
  • OpenStack
  • Parallels
  • QEMU. Both KVM and Xen images.
  • VirtualBox
  • VMware

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.json. Export your AWS credentials as the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.

{
  "variables": {
    "access_key": "{{env `AWS_ACCESS_KEY_ID`}}",
    "secret_key": "{{env `AWS_SECRET_ACCESS_KEY`}}"
  },
  "builders": [{
    "type": "amazon-ebs",
    "access_key": "{{user `access_key`}}",
    "secret_key": "{{user `access_key`}}",
    "region": "us-east-1",
    "source_ami": "ami-de0d9eb7",
    "instance_type": "t1.micro",
    "ssh_username": "ubuntu",
    "ami_name": "packer-example {{timestamp}}"
  }]
}

Next, tell Packer to build the image:

$ packer build quick-start.json
...

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

Full, comprehensive documentation is viewable on the Packer website:

http://www.packer.io/docs

Developing Packer

If you wish to work on Packer itself or any of its built-in providers, you'll first need Go installed (version 1.4+ is required). Make sure Go is properly installed, including setting up a GOPATH.

Next, install the following software packages, which are needed for some dependencies:

Then, install Gox, which is used as a compilation tool on top of Go:

$ go get -u github.com/mitchellh/gox

Next, clone this repository into $GOPATH/src/github.com/mitchellh/packer. Install the necessary dependencies by running make updatedeps and then just type make. This will compile some more dependencies and then run the tests. If this exits with exit status 0, then everything is working!

$ make updatedeps
...
$ make
...

To compile a development version of Packer and the built-in plugins, run make dev. This will put Packer binaries in the bin folder:

$ make dev
...
$ bin/packer
...

If you're developing a specific package, you can run tests for just that package by specifying the TEST variable. For example below, only packer package tests will be run.

$ make test TEST=./packer
...

Acceptance Tests

Packer has comprehensive acceptance tests covering the builders of Packer.

If you're working on a feature of a builder or a new builder and want verify it is functioning (and also hasn't broken anything else), we recommend running the acceptance tests.

Warning: The acceptance tests create/destroy/modify real resources, which may incur real costs in some cases. In the presence of a bug, it is technically possible that broken backends could leave dangling data behind. Therefore, please run the acceptance tests at your own risk. At the very least, we recommend running them in their own private account for whatever builder you're testing.

To run the acceptance tests, invoke make testacc:

$ make testacc TEST=./builder/amazon/ebs
...

The TEST variable is required, and you should specify the folder where the backend is. The TESTARGS variable is recommended to filter down to a specific resource to test, since testing all of them at once can sometimes take a very long time.

Acceptance tests typically require other environment variables to be set for things such as access keys. The test itself should error early and tell you what to set, so it is not documented here.