Go to file
Amrita Dutta 8c326dbab7 Formatting changes 2018-11-07 18:08:15 +00:00
.github Miscellaneous doc improvements 2018-10-18 19:09:49 -04:00
builder Formatting changes 2018-11-07 18:08:15 +00:00
command Merge pull request #6871 from LKaemmerling/master 2018-10-18 11:13:16 -07:00
common fix variable casing convention 2018-10-22 14:34:50 -07:00
communicator this needs to be _below_ the call to ToPath 2018-10-19 14:24:56 -07:00
contrib Try to make help more consistent 2018-10-10 21:34:35 -04:00
examples add options for system disk properties 2018-10-30 21:09:59 +08:00
fix bug fix and add test 2018-09-06 12:19:31 -07:00
helper new option allowing user to clean up the ephemeral ssh key from the authorized_keys file 2018-09-14 11:06:38 -07:00
packer WIP 2018-10-26 16:59:20 -07:00
plugin/example delete unneeded plugin file 2017-09-28 10:52:54 -07:00
post-processor Use switch for readability 2018-10-30 10:06:31 -07:00
provisioner removed space 2018-10-24 15:49:49 +02:00
scripts use xargs to check for formatting 2018-05-01 20:39:48 -07:00
template make template/parse_test.go invisible to windows 2018-10-16 19:02:10 +02:00
test Miscellaneous doc improvements 2018-10-18 19:09:49 -04:00
vendor Update oracle SDK 2018-10-26 16:59:22 -07:00
version prepare for next version 2018-10-29 16:02:42 +01:00
website Merge pull request #6918 from hashicorp/oracle_classic_volumes 2018-10-31 16:03:40 -07:00
.gitattributes too many files for shell during Make, convert .go and .sh to EOL=lf 2018-04-07 05:22:39 -04:00
.gitignore switch to netlify deployment 2018-09-19 12:17:28 -07:00
.travis.yml travis-ci: allow failures on windows 2018-10-17 13:44:27 +02:00
CHANGELOG.md set release version to today 2018-10-29 17:10:17 +01:00
CODEOWNERS Update Scaleway code owners 2018-10-26 14:44:40 +02:00
LICENSE LICENSE: MPL2 2013-06-24 14:29:15 -07:00
Makefile Makefile: make find work on windows using `-executable` instead of `-perm +111` 2018-10-16 16:23:07 +02:00
README.md Miscellaneous doc improvements 2018-10-18 19:09:49 -04:00
Vagrantfile First cut at vagrant post-processor for docker 2018-07-06 17:11:24 -05:00
appveyor.yml revert appveyor skips as windows builds are pretty unstable 2018-10-17 13:38:53 +02:00
checkpoint.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
commands.go Complete Atlas deprecation. 2018-08-02 20:23:28 -07:00
config.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
log.go Use Sprint() instead of Sprintf() in log dedupe 2018-10-09 22:43:54 -04:00
main.go document wrapConfig a little 2018-09-24 16:24:43 +02:00
main_test.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
panic.go Add telemetry reporting through checkpoint 2017-06-15 13:21:11 -07:00
stdin.go Gracefully clean up on SIGTERM 2017-09-08 11:42:32 -07:00

README.md

Packer

Build Status Windows Build Status GoDoc GoReportCard

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 many platforms, the full list of which can be found at https://www.packer.io/docs/builders/index.html.

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. Export your AWS credentials as the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.

{
  "variables": {
    "access_key": "{{env `AWS_ACCESS_KEY_ID`}}",
    "secret_key": "{{env `AWS_SECRET_ACCESS_KEY`}}"
  },
  "builders": [{
    "type": "amazon-ebs",
    "access_key": "{{user `access_key`}}",
    "secret_key": "{{user `secret_key`}}",
    "region": "us-east-1",
    "source_ami": "ami-af22d9b9",
    "instance_type": "t2.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

Comprehensive documentation is viewable on the Packer website:

https://www.packer.io/docs

Developing Packer

See CONTRIBUTING.md for best practices and instructions on setting up your development environment to work on Packer.