Go to file
Megan Marsh 5555987e4d clean up changelog entries 2021-04-27 11:55:45 -07:00
.circleci remove codecov from repo (#10955) 2021-04-21 13:22:34 -04:00
.github website: check for unlinked content, rm split-out vagrant content (#10958) 2021-04-23 17:04:20 +02:00
acctest add plugin acceptance test using amazon plugin 2021-04-07 16:21:15 +02:00
builder azure builder: add support for shared image gallery storage account type 2021-04-23 16:57:24 -07:00
cmd Use packer-sdc in packer + remove mapstructure-to-hcl2 & struct-markdown (#10913) 2021-04-16 11:52:03 +02:00
command add test to repro #10975 2021-04-26 17:31:22 +02:00
contrib docs tweaks 2020-10-14 12:58:04 -07:00
datasource Vendor amazon plugin (#10800) 2021-03-25 13:37:48 +01:00
examples Add http_content func to serve variables from HTTP @ preseed (#10801) 2021-03-23 12:31:13 +01:00
fix fix fixer deprecated options conflict 2020-10-23 14:00:12 -07:00
hcl2template Update types.build.provisioners.go 2021-04-26 17:37:24 +02:00
helper move provisioner acceptance tests into sdk alongside builder acceptance tests. Reorganize slightly to make sure no import cycles of doom get formed 2020-12-03 14:22:18 -08:00
packer Use packer-sdc in packer + remove mapstructure-to-hcl2 & struct-markdown (#10913) 2021-04-16 11:52:03 +02:00
post-processor Breakout yandex (#10970) 2021-04-22 17:03:14 +02:00
provisioner Extract converge provisioner 2021-04-21 14:19:34 -04:00
scripts Add release build for darwin/arm64 (#10804) 2021-03-25 13:34:21 +01:00
test Extract ansible plugins (#10912) 2021-04-16 10:31:09 -04:00
version Putting source back into Dev Mode 2021-04-05 23:32:25 +00:00
website website: add huaweicloud remote plugin 2021-04-26 20:24:50 +08:00
.gitattributes HCL2: add templatefile function (#10776) 2021-03-23 12:02:05 +01:00
.gitignore Remove the vendor dir (#10916) 2021-04-21 10:52:55 +02:00
.golangci.yml Remove the vendor dir (#10916) 2021-04-21 10:52:55 +02:00
.hashibot.hcl Update link in issue migrator config (#10791) 2021-03-19 09:48:58 -04:00
CHANGELOG.md clean up changelog entries 2021-04-27 11:55:45 -07:00
CODEOWNERS remove outdatedlinode codeowners (#10957) 2021-04-21 15:38:35 -04:00
Dockerfile Use docker mirror 2020-10-29 11:05:41 -07:00
LICENSE LICENSE: MPL2 2013-06-24 14:29:15 -07:00
Makefile Remove the vendor dir (#10916) 2021-04-21 10:52:55 +02:00
README.md remove codecov from repo (#10955) 2021-04-21 13:22:34 -04:00
Vagrantfile vagrantfile: add support for docker provider 2018-10-31 16:58:06 +03:00
background_check.go surface notimplemented errs too 2019-09-19 08:57:50 -07:00
background_check_openbsd.go copypasta 2019-09-18 10:54:35 -07:00
checkpoint.go remove sdk 2020-12-17 13:29:25 -08:00
commands.go HCL2 Parse packer.required_plugins block + packer init (#10304) 2021-02-02 18:05:04 +01:00
config.go HCL2 Parse packer.required_plugins block + packer init (#10304) 2021-02-02 18:05:04 +01:00
config_test.go HCL2 Parse packer.required_plugins block + packer init (#10304) 2021-02-02 18:05:04 +01:00
go.mod Breakout yandex (#10970) 2021-04-22 17:03:14 +02:00
go.sum Breakout yandex (#10970) 2021-04-22 17:03:14 +02:00
log.go log errors in scanner and manually close logging pipe if we hit an error in the scanner 2019-11-11 09:20:39 -08:00
main.go add massive warning about error logging to WrappedMain 2021-04-05 15:03:39 -07:00
main_test.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
mlc_config.json Fix markdown link checker issues (#10575) 2021-02-05 16:46:53 -05:00
panic.go Add telemetry reporting through checkpoint 2017-06-15 13:21:11 -07:00
tty.go allow building packer on solaris by removing progress bar and tty imports 2019-05-07 15:58:49 +02:00
tty_solaris.go remove sdk 2020-12-17 13:29:25 -08:00

README.md

Packer

Build Status Discuss PkgGoDev GoReportCard

HashiCorp Packer logo

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.

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

variable "access_key" {
  type    = string
  default = "${env("AWS_ACCESS_KEY_ID")}"
}

variable "secret_key" {
  type    = string
  default = "${env("AWS_SECRET_ACCESS_KEY")}"
}

locals { timestamp = regex_replace(timestamp(), "[- TZ:]", "") }

source "amazon-ebs" "quick-start" {
  access_key    = "${var.access_key}"
  ami_name      = "packer-example ${local.timestamp}"
  instance_type = "t2.micro"
  region        = "us-east-1"
  secret_key    = "${var.secret_key}"
  source_ami    = "ami-af22d9b9"
  ssh_username  = "ubuntu"
}

build {
  sources = ["source.amazon-ebs.quick-start"]
}

Next, tell Packer to build the image:

$ packer build quick-start.pkr.hcl
...

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 at https://www.packer.io/docs.

Contributing to Packer

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

Unmaintained Plugins

As contributors' circumstances change, development on a community maintained plugin can slow. When this happens, the Packer team may mark a plugin as unmaintained, to clearly signal the plugin's status to users.

What does unmaintained mean?

  1. The code repository and all commit history will still be available.
  2. Documentation will remain on the Packer website.
  3. Issues and pull requests are monitored as a best effort.
  4. No active development will be performed by the Packer team.

If anyone form them community is interested in maintaining a community supported plugin, please feel free to submit contributions via a pull- request for review; reviews are generally prioritized over feature work when possible. For a list of open plugin issues and pending feature requests see the Packer Issue Tracker.