Go to file
Mitchell Hashimoto d999d1c5dd Merge pull request #205 from sit/preserve-cache-suffix
Preserve suffix of files put in the cache.
2013-07-20 16:40:31 -07:00
builder Merge pull request #205 from sit/preserve-cache-suffix 2013-07-20 16:40:31 -07:00
command command/fix: properly replace the escaped </> 2013-07-14 17:10:50 +09:00
communicator/ssh communicator/ssh: style 2013-07-19 14:16:39 -04:00
packer packer/cache: Preserve any extension found on keys 2013-07-20 00:19:05 -04:00
plugin builder/amazon/ebs: rename to amazon/ebs in order to support others 2013-07-15 15:02:18 +09:00
post-processor/vagrant post-processor/vagrant: properly close file handles [GH-100] 2013-07-07 17:44:13 -07:00
provisioner Log an upload error closer to when it occurs 2013-07-17 18:17:46 -07:00
scripts scripts: Use XC_ARCH/XC_OS to limit what arch/os combo is built 2013-07-16 14:36:54 -07:00
website website: sleep in getting started 2013-07-20 12:35:51 -07:00
.gitignore .gitignore the /src directory 2013-06-29 22:16:31 -04:00
CHANGELOG.md Update changelog 2013-07-20 16:37:48 -07:00
CONTRIBUTING.md Add instructions for how to get Go set up to contribute. 2013-07-12 14:40:03 -04:00
LICENSE LICENSE: MPL2 2013-06-24 14:29:15 -07:00
Makefile Add a clean target to the Makefile 2013-07-18 10:40:23 -04:00
README.md README: Clarify repository placement relative to GOPATH 2013-07-04 23:59:52 -04:00
TODO.md Update TODO 2013-06-20 11:53:27 -07:00
config.go command/fix: boilerplate for the fix command 2013-07-14 16:22:18 +09: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 Clean up some of the log path detection code 2013-07-14 11:00:44 +09: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.

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.