Go to file
Matt Page 0fe61fa1e0 fix: Respect metadata supplied for GCE builders.
Previously, any per instance metadata supplied via the GCE builder
was ignored.

Test plan:

- make test
- Manual testing via:
-- Created a packer config that contained a GCE builder with custom
   metadata set.
-- Ran `packer build`.
-- Verified the instance had the correct metadata in the GCE console.
2014-10-06 14:18:34 -07:00
builder fix: Respect metadata supplied for GCE builders. 2014-10-06 14:18:34 -07:00
command command/build: -color [GH-1433] 2014-09-05 16:05:02 -07:00
common common: don't wait SSH on first try 2014-09-10 14:04:56 -07:00
communicator/ssh communicator/ssh: upload proper source [GH-1484] 2014-09-10 14:16:24 -07:00
packer v0.7.1 2014-09-10 16:09:43 -07:00
plugin Merge pull request #1081 from johnbellone/compress-post-processor 2014-09-08 10:26:50 -07:00
post-processor post-processor/compress: style 2014-09-08 10:28:16 -07:00
provisioner Merge branch '1064-fix-upload-file-permissions' of github.com:rasa/packer into rasa-1064-fix-upload-file-permissions 2014-09-08 13:20:46 -07:00
scripts scripts: ignore errors on gox for now 2014-09-11 11:51:44 -07:00
test test: high-level CLI tests that catch basic errors 2013-12-18 08:40:35 -08:00
website Update website to use latest middleman 2014-10-03 17:55:34 -07:00
.gitignore Add Vagrantfile for cross cmpiling 2014-09-04 11:35:27 -07:00
.travis.yml Don't notify IRC 2014-09-03 20:33:38 -07:00
CHANGELOG.md Updated CHANGELOG 2014-10-04 23:16:38 +02: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 Run two builds in parallel with go get. 2014-09-11 07:55:07 +02:00
README.md Update scripts to latest HashiCorp style 2014-09-02 15:13:55 -07:00
Vagrantfile post-processor/docker-push: can login [GH-1243] 2014-09-05 14:43:15 -07:00
checkpoint.go packer: check for latest version 2014-09-08 15:25:50 -07:00
config.go Mechanisms to disable checkpoint 2014-09-08 14:20:13 -07:00
config_unix.go website: update website to point to proper directory 2014-09-08 13:44:58 -07:00
config_windows.go website: update website to point to proper directory 2014-09-08 13:44:58 -07:00
packer.go Move checkpoint into its own file to make it easy 2014-09-08 14:17:27 -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 or any of its built-in providers, you'll first need Go installed (version 1.2+ is required). Make sure Go is properly installed, including setting up a GOPATH.

Next, install the following software packages, which are needed for some dependencies:

Then, install Gox, which is used as a compilation tool on top of Go:

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

Next, clone this repository into $GOPATH/src/github.com/mitchellh/packer. Install the necessary dependencies by running make updatedeps and then just type make. This will compile some more dependencies and then run the tests. If this exits with exit status 0, then everything is working!

$ make updatedeps
...
$ make
...

To compile a development version of Packer and the built-in plugins, run make dev. This will put Packer binaries in the bin folder:

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

If you're developing a specific package, you can run tests for just that package by specifying the TEST variable. For example below, only packer package tests will be run.

$ make test TEST=./packer
...