Go to file
DanHam 82c8710af5
Use fmt.Errorf over errors.New as we only require basic error reporting
2018-05-15 12:25:06 +01:00
.github move contributing doc out of root 2018-04-02 10:52:27 -07:00
builder Use fmt.Errorf over errors.New as we only require basic error reporting 2018-05-15 12:25:06 +01:00
command Merge branch 'master' into f-autocomplete 2018-04-26 11:18:37 -07:00
common Merge pull request #6101 from adarobin/azurecompatible 2018-05-10 17:02:44 -07:00
communicator Remove redundant error message. 2018-05-08 03:25:39 -07:00
contrib forces az cli to output in JSON where required 2018-04-16 08:01:31 +10:00
examples Updates to review comments 2018-05-11 10:00:31 -07:00
fix s/boot_command/bootcommand/ 2018-04-19 14:26:31 -07:00
helper use build name to ensure that winrm password and other shared state is not overwritten if two builders need the password in the same packer run. 2018-04-16 13:41:17 -07:00
packer spelling: warnings 2018-03-14 03:29:50 +00:00
plugin/example delete unneeded plugin file 2017-09-28 10:52:54 -07:00
post-processor s/boot_command/bootcommand/ 2018-04-19 14:26:31 -07:00
provisioner Merge pull request #6215 from tb3088/delay-extraArgs-4462_clean 2018-05-08 15:03:55 -07:00
scripts Revert "Merge pull request #4494 from tb3088/EOL-handling" 2018-05-01 13:09:55 -07:00
template Add new `packer_version` function. 2017-11-21 22:04:33 +01: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 fix azure vendors. 2018-05-07 15:17:45 -07:00
version update to 1.2.4-dev 2018-04-25 14:32:44 -07:00
website Document use of T2 Unlimited for enabled Amazon builders 2018-05-15 12:25:06 +01:00
.gitattributes Revert "fix line-endings" 2018-04-30 13:59:46 -04:00
.gitignore ignore Eclipse project files 2018-04-07 05:25:40 -04:00
.travis.yml Merge branch 'master' into f-autocomplete 2018-04-26 11:18:37 -07:00
CHANGELOG.md update changelog 2018-05-08 15:32:56 -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 Revert "Merge pull request #4494 from tb3088/EOL-handling" 2018-05-01 13:09:55 -07:00
README.md update github link to point to hashicorp 2018-04-02 20:09:32 -07:00
Vagrantfile [vagrant] Remove redundant configuration block. 2018-01-18 04:34:14 -05:00
appveyor.yml fix appveyor 2017-06-06 11:52:21 -07:00
checkpoint.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
commands.go Re-factor version command to use version.FormattedVersion() function. 2017-12-03 23:07:16 +01:00
config.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
log.go Fix debug logging 2016-10-07 21:10:20 +02:00
main.go Merge branch 'master' into f-autocomplete 2018-04-26 11:18:37 -07: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

Download and install packages and dependencies

go get github.com/hashicorp/packer

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.