Go to file
Mark Jaquith 373f093a98 Note that Mercurial (hg) is a dependency for developing on Packer. 2013-06-30 22:46:22 -04:00
builder Incorporate code review feedback. 2013-06-30 11:10:26 -04:00
command command/build: include the build name in the err/success output 2013-06-27 22:26:48 -04:00
communicator/ssh fmt 2013-06-23 20:43:50 -07:00
packer Up version for development 2013-06-29 14:16:26 -07:00
plugin Remove the "compress" post-processor for now 2013-06-27 08:32:15 -07:00
post-processor/vagrant post-processor/vagrant: use proper provider type for VMware boxes 2013-06-29 13:52:39 -07:00
provisioner/shell Merge branch 'shell-env-vars' 2013-06-28 08:20:12 -04:00
scripts Fix building on Ubuntu 2013-06-30 13:15:19 +01:00
website Fix a small typo 2013-06-30 21:22:32 +01:00
.gitignore .gitignore the /src directory 2013-06-29 22:16:31 -04:00
CHANGELOG.md v0.1.2 2013-06-29 14:03:39 -07:00
LICENSE LICENSE: MPL2 2013-06-24 14:29:15 -07:00
Makefile Fix building on Ubuntu 2013-06-30 13:15:19 +01:00
README.md Note that Mercurial (hg) is a dependency for developing on Packer. 2013-06-30 22:46:22 -04:00
TODO.md Update TODO 2013-06-20 11:53:27 -07:00
config.go post-processor/vagrant: Only tar files 2013-06-27 14:06:14 -07: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 Make sure the cache dir is absolute 2013-06-20 12:37:17 -07:00
signal.go Signal handling, force quit after two interrupts 2013-06-03 22:40:05 -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 {{.CreateTime}}"
  }]
}

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.

Additionally, to build Packer, you will need Mercurial installed.

Next, clone this repository 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.