Go to file
Mitchell Hashimoto 629f3eee21 core: cache makes proper path with slashes after "." [GH-716] 2013-12-19 18:25:01 -08:00
builder builder/virtualbox: fix compilation 2013-12-19 08:49:50 -08:00
command command/fix: update help 2013-12-19 14:56:12 -08:00
common common: process user variables in non-string config decodes [GH-598] 2013-12-16 17:57:07 -08:00
communicator/ssh communicator/ssh: fix build 2013-12-10 18:14:02 -08:00
packer core: cache makes proper path with slashes after "." [GH-716] 2013-12-19 18:25:01 -08:00
plugin plugin/builder-googlecompute: compile 2013-12-12 21:53:04 -08:00
post-processor post-processor/vagrant: do overrides 2013-12-19 14:44:15 -08:00
provisioner Merge pull request #726 from rocketnova/master 2013-12-18 08:40:13 -08:00
scripts Verify go version when building packer. 2013-12-16 18:52:37 +05:30
test test: high-level CLI tests that catch basic errors 2013-12-18 08:40:35 -08:00
website post-processor/vagrant: do overrides 2013-12-19 14:44:15 -08:00
.gitignore test: google compute engine acceptance tests 2013-12-14 11:27:50 -08:00
.travis.yml Don't test 1.1 on Travis anymore 2013-12-11 13:39:43 -08:00
CHANGELOG.md core: cache makes proper path with slashes after "." [GH-716] 2013-12-19 18:25:01 -08:00
CONTRIBUTING.md The minimum go version to build packer is 1.2, not 1.1. 2013-12-16 18:50:57 +05:30
LICENSE LICENSE: MPL2 2013-06-24 14:29:15 -07:00
Makefile update makefile to latest 2013-11-18 15:37:14 -08:00
README.md The minimum go version to build packer is 1.2, not 1.1. 2013-12-16 18:50:57 +05:30
config.go builder/googlecompute: enable the googlecompute builder 2013-12-12 21:53:03 -08:00
configfile.go Don't depend on os/user anymore, which requires cgo 2013-06-17 22:10:11 -07:00
configfile_unix.go Don't depend on os/user anymore, which requires cgo 2013-06-17 22:10:11 -07:00
configfile_windows.go Don't depend on os/user anymore, which requires cgo 2013-06-17 22:10:11 -07:00
packer.go packer: no colored output if machine-readable [GH-684] 2013-12-16 14:10:28 -08:00
packer_test.go Fix packer test 2013-08-12 09:19:24 -07:00
panic.go add issues URL in crash detect output 2013-08-13 23:59:59 -04:00
signal.go packer/plugin: confirm cleanup at first signal received 2013-08-24 12:55:25 +02:00
stdin.go ctrl-c closes stdin for plugins so that they are unblocked 2013-07-25 23:27:13 -07:00

README.md

Packer

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 creating AMIs (EC2), VMware images, and VirtualBox images. Support for more 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. Be sure to replace any credentials with your own.

{
  "builders": [{
    "type": "amazon-ebs",
    "access_key": "YOUR KEY HERE",
    "secret_key": "YOUR SECRET KEY HERE",
    "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, you'll first need Go installed (version 1.2+ is required). Make sure you have Go properly installed, including setting up your GOPATH.

For some additional dependencies, Go needs Mercurial and Bazaar to be installed. Packer itself doesn't require these, but a dependency of a dependency does.

You'll also need gox to compile packer. You can install that with:

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

Next, clone this repository into $GOPATH/src/github.com/mitchellh/packer and then just type make. In a few moments, you'll have a working packer executable:

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

You can run tests by typing make test.

This will run tests for Packer core along with all the core builders and commands and such that come with Packer.

If you make any changes to the code, run make format in order to automatically format the code according to Go standards.

When new dependencies are added to packer you can use make updatedeps to get the latest and subsequently use make to compile and generate the packer binary.