Go to file
Mitchell Hashimoto 704648896e Merge pull request #1425 from dysinger/1424-amazon-instance-s3-region-not-url
builder/amazon-instance: Use Region not S3Endpoint (see Issue 1424)
2014-09-01 21:31:36 -07:00
builder Merge pull request #1425 from dysinger/1424-amazon-instance-s3-region-not-url 2014-09-01 21:31:36 -07:00
command command/build: -parallel=false to disable parallelization [GH-924] 2014-03-12 21:34:43 -07:00
common common: add test for empty val 2014-05-06 18:52:02 -07:00
communicator/ssh communicator/ssh: remove background connection checker 2014-04-28 15:25:59 -07:00
packer up version for dev 2014-07-20 13:17:58 -07:00
plugin post-processor/vagrant-cloud: initial commit 2014-06-16 15:53:37 -04:00
post-processor fix panic when vagrant cloud response fails 2014-08-12 18:11:27 +02:00
provisioner Cleaned up Go formatting with gofmt. 2014-07-17 15:33:09 -04:00
scripts Updating check for version when on devel. 2014-08-19 21:26:01 -04:00
test test: high-level CLI tests that catch basic errors 2013-12-18 08:40:35 -08:00
website Merge pull request #1428 from NickPresta/patch-1 2014-09-01 21:26:19 -07:00
.gitignore builder/virtualbox: move to iso/ folder 2013-12-21 14:25:22 -08:00
.travis.yml Remove race tests from travis, too many false 2014-02-21 20:10:28 -08:00
CHANGELOG.md Update CHANGELOG 2014-09-01 21:24:21 -07:00
CONTRIBUTING.md Add gox installation instructions to Contributing 2014-06-26 13:55:47 +02:00
LICENSE LICENSE: MPL2 2013-06-24 14:29:15 -07:00
Makefile Install gox during build time 2014-07-19 22:02:49 +05:30
README.md Update README.md 2014-05-09 07:37:34 -07:00
config.go post-processor/vagrant-cloud: initial commit 2014-06-16 15:53:37 -04: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 core: Create cache directory only when needed [GH-367] 2014-04-26 20:33:12 -07: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 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. 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
...

If you need to cross-compile Packer for other platforms, take a look at scripts/dist.sh.

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.