Packer is a tool for creating identical machine images for multiple platforms from a single source configuration.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Megan Marsh e8b3a0e3bf
make virtualbox, hyperv, openstack, and parallels builders respect winrm_host by correctly passing communicator config Host() func to commhost instead of just SSHHost
5 years ago
.circleci pin packer to golang 1.16 (#10702) 5 years ago
.github pin packer to golang 1.16 (#10702) 5 years ago
builder make virtualbox, hyperv, openstack, and parallels builders respect winrm_host by correctly passing communicator config Host() func to commhost instead of just SSHHost 5 years ago
cmd Multi plugin naming (#10608) 5 years ago
command Add maps for statically vendored components 5 years ago
contrib docs tweaks 5 years ago
datasource Aws Secrets Manager data sources (#10505) 5 years ago
examples Extract plugin-specific examples to plugin directories (#10228) 5 years ago
fix fix fixer deprecated options conflict 5 years ago
hcl2template addrs: remove Plugin.ForDisplay func, the String one does the job 5 years ago
helper move provisioner acceptance tests into sdk alongside builder acceptance tests. Reorganize slightly to make sure no import cycles of doom get formed 5 years ago
packer remove this logline -- it is spammy and seems like a leftover dev debug line (#10665) 5 years ago
post-processor Remove "exoscale-import" post-processor 5 years ago
provisioner Merge pull request #10695 from hashicorp/docker_vendoring 5 years ago
scripts (2) Implement datasources (#10440) 5 years ago
test Fix line ending issues for test files (#10096) 5 years ago
vendor Vendor exoscale-import plugin 5 years ago
version Putting source back into Dev Mode 5 years ago
website actually use the partials created in code generation inside the digitalocean docs page (#10742) 5 years ago
.codecov.yml add step_add_floppy unit tests 5 years ago
.gitattributes Update .gitattributes 5 years ago
.gitignore Added support for IAM credential in the token field and YC_TOKEN env 5 years ago
.golangci.yml Add golangci-lint to project (#8686) 6 years ago
.hashibot.hcl update hashibot config not to comment when locking super old and stale issues 6 years ago
CHANGELOG.md update changelog 5 years ago
CODEOWNERS Remove "exoscale-import" post-processor 5 years ago
Dockerfile Use docker mirror 5 years ago
LICENSE LICENSE: MPL2 13 years ago
Makefile fix makefile 5 years ago
README.md readme: add white bg to packer logo in reamde.md (#10712) 5 years ago
Vagrantfile vagrantfile: add support for docker provider 7 years ago
background_check.go surface notimplemented errs too 7 years ago
background_check_openbsd.go copypasta 7 years ago
checkpoint.go remove sdk 5 years ago
commands.go HCL2 Parse packer.required_plugins block + packer init (#10304) 5 years ago
config.go HCL2 Parse packer.required_plugins block + packer init (#10304) 5 years ago
config_test.go HCL2 Parse packer.required_plugins block + packer init (#10304) 5 years ago
formatted.pkr.hcl HCL2 Parse packer.required_plugins block + packer init (#10304) 5 years ago
go.mod Vendor exoscale-import plugin 5 years ago
go.sum Vendor exoscale-import plugin 5 years ago
log.go log errors in scanner and manually close logging pipe if we hit an error in the scanner 6 years ago
main.go Add maps for statically vendored components 5 years ago
main_test.go move packer to hashicorp 9 years ago
mlc_config.json Fix markdown link checker issues (#10575) 5 years ago
panic.go Add telemetry reporting through checkpoint 9 years ago
tty.go allow building packer on solaris by removing progress bar and tty imports 7 years ago
tty_solaris.go remove sdk 5 years ago

README.md

Packer

Build Status Discuss PkgGoDev GoReportCard codecov

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.