Go to file
Tyler Tidman 90fde9fc46 More cleanup in communicator and builder docs
Tested and verified using "make website".
Fix up the vmware, vbox and qemu builder and communicator docs.
Sort more things in alphabetical order.
Use backtick delimiters for values.
Wrap long lines to 80 characters.
Show actual default value for boot_wait.
Copy vrdp_bind_address info from vbox iso to vbox ovf builder.
Show defaults for vmx_remove_ethernet_interfaces.
Show default port values for ssh in vbox ovf builder.
Remove executable bit on openstack builder doc.
Show default for skip_compaction in vmware vmx builder.
Add a bunch of missing periods.
Remove a few redundant commas.
2018-04-21 20:50:40 -04:00
.github move contributing doc out of root 2018-04-02 10:52:27 -07:00
builder Merge pull request #6039 from stack72/triton-insecure-skip-tls-verify 2018-04-20 13:44:28 -07:00
command update atlas deprecation language 2018-03-19 10:50:29 -07:00
common fix bug with empty boot command. 2018-04-21 11:40:47 -07:00
communicator remove attempt to discover whether destination is a directory from upload function in various communicators 2018-04-10 08:13:06 -07:00
contrib forces az cli to output in JSON where required 2018-04-16 08:01:31 +10:00
examples add expect_disconnect otherwise the build fails 2018-04-18 12:05:27 -07:00
fix s/boot_command/bootcommand/ 2018-04-19 14:26:31 -07:00
helper Include arch and os 2018-04-05 14:28:50 -04: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 #3891 from nouney/f-generated-files 2018-04-05 16:08:38 -07:00
scripts Better override support for PS build script 2018-03-05 01:58:30 -08: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 Maximize scancode throughput. 2018-04-19 14:26:29 -07:00
version version 1.2.3 dev 2018-03-26 14:23:07 -07:00
website More cleanup in communicator and builder docs 2018-04-21 20:50:40 -04:00
.gitattributes On windows a lot of git clients will convert LF to CRLF. This would be a problem where file contents are compared exactly 2016-12-12 22:44:50 +00:00
.gitignore Merge pull request #5206 from sandersaares/hyperv-second-temp-dir 2017-10-09 10:08:00 -07:00
.travis.yml test on go 1.9.x branch, remove 1.7.x from tests 2018-02-16 12:00:33 -08:00
CHANGELOG.md update changelog 2018-04-20 12:23:27 -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 s/boot_command/bootcommand/ 2018-04-19 14:26:31 -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 s/boot_command/bootcommand/ 2018-04-19 14:26:31 -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.