Go to file
Mitchell Hashimoto c1bd7468d5 builder/virtualbox: ctrl-c works during wait for boot 2013-11-12 16:19:38 +00:00
builder builder/virtualbox: ctrl-c works during wait for boot 2013-11-12 16:19:38 +00:00
command command/build: output warnings 2013-11-02 23:21:12 -05:00
common builder/vmware: make things more Go-like 2013-11-07 12:01:18 -08:00
communicator/ssh communicator/ssh: buffer file on disk to read length [GH-561] 2013-11-02 11:34:54 +01:00
packer Update changelog 2013-11-05 14:30:49 -08:00
plugin plugin/builder-docker 2013-11-08 16:57:13 -08:00
post-processor/vagrant post-processor/vagrant: support compression level for DO 2013-11-05 14:30:03 -08:00
provisioner provisioner/chef-solo: Say using Chef-solo 2013-11-09 18:47:20 -08:00
scripts Build script now installs binaries to $GOPATH/bin 2013-10-20 16:16:05 -07:00
website Fix spelling in Intro documentation 2013-11-11 21:41:53 -05:00
.gitignore Ignore Vagrant stuff 2013-11-08 16:41:42 -08:00
.travis.yml Make travis run data race tests 2013-08-21 11:06:01 -07:00
CHANGELOG.md builder/virtualbox: ctrl-c works during wait for boot 2013-11-12 16:19:38 +00:00
CONTRIBUTING.md contributing: clarify how to submit debug output with a new issue 2013-10-18 10:04:33 +02:00
LICENSE LICENSE: MPL2 2013-06-24 14:29:15 -07:00
Makefile use interactive shell to run build script. 2013-09-24 01:40:42 -07:00
README.md Update README.md to include updatedeps target 2013-11-07 18:48:01 +05:30
config.go main: Default config has docker 2013-11-08 16:57:34 -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 fixed #584 log golang version in debug output 2013-11-11 08:42:27 -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.1+ is required). Make sure you have Go properly installed, including setting up your GOPATH.

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

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.