Go to file
Megan Marsh 50b0dd6381
Merge pull request #6861 from hashicorp/qemu_example
removed guarantee of a working template from qemu docs
2018-10-16 10:19:50 -07:00
.github Grammar: anyway 2018-10-10 14:40:08 -04:00
builder builder/googlecompute: validate startup_script_file exists 2018-10-15 16:09:33 -07:00
command Try to make help more consistent 2018-10-10 21:34:35 -04:00
common provide useful powershell error 2018-10-09 12:13:07 -07:00
communicator make trailing slash still work 2018-07-12 09:08:36 -07:00
contrib Try to make help more consistent 2018-10-10 21:34:35 -04:00
examples Add ansible connection plugin examples 2018-07-10 17:10:53 -04: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 fix more race conditions 2018-10-15 16:31:59 +02:00
plugin/example delete unneeded plugin file 2017-09-28 10:52:54 -07:00
post-processor fix recurring bug #3878, make destination ESXi host selectable in config, more informative error output 2018-09-10 08:40:03 +03:00
provisioner fix powershell tests to use new command 2018-10-12 09:54:27 -07:00
scripts use xargs to check for formatting 2018-05-01 20:39:48 -07:00
template implement vault template function for kv engine; add docs 2018-08-28 13:58:56 -07:00
test Add options to LXC builder for influencing for how containers are built and started 2017-10-30 21:48:43 -04:00
vendor amazon: Update aws-sdk-go to v1.15.54 2018-10-15 11:48:51 +02:00
version now dev for 1.3.2 2018-09-14 12:25:55 -07:00
website Merge pull request #6861 from hashicorp/qemu_example 2018-10-16 10:19:50 -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 remove 1.10.x from travis matrix 2018-08-24 16:11:54 -07:00
CHANGELOG.md Update changelog once again for 1.3.1 2018-09-14 11:19:15 -07:00
CODEOWNERS add scaleway codeowners 2018-02-12 11:18:50 -08:00
LICENSE LICENSE: MPL2 2013-06-24 14:29:15 -07:00
Makefile exclude git files (including git hooks) from the executable check 2018-09-06 10:23:58 -07:00
README.md Remove `go get` from Quick Start as this isn't required to use Packer 2018-06-17 03:05:30 +01:00
Vagrantfile First cut at vagrant post-processor for docker 2018-07-06 17:11:24 -05:00
appveyor.yml Revert "install golang 1.11 on appveyor machines" 2018-10-04 15:20:21 +03: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.