Go to file
Megan Marsh 7646ecf8c6 fix tests 2020-10-23 15:35:37 -07:00
.circleci
.github
builder fix tests 2020-10-23 15:35:37 -07:00
cmd fix linting 2020-10-21 15:29:05 -07:00
command add build.name to hcl code (#10114) 2020-10-16 10:57:42 +02:00
common Merge pull request #10143 from hashicorp/do_9951 2020-10-22 15:06:04 -07:00
communicator
contrib docs tweaks 2020-10-14 12:58:04 -07:00
examples Add vmware vmx example 2020-10-21 15:55:54 +02:00
fix rework fixer deprecation code so we know what plugins they relate to 2020-10-21 15:28:59 -07:00
hcl2template Add HCL2 aws_secretsmanager function (#10124) 2020-10-20 16:21:40 +02:00
helper review comments, add plugin type for a few missing builders 2020-10-21 16:17:32 -07:00
packer
plugin/example
post-processor review comments, add plugin type for a few missing builders 2020-10-21 16:17:32 -07:00
provisioner rework fixer deprecation code so we know what plugins they relate to 2020-10-21 15:28:59 -07:00
scripts
template Add HCL2 aws_secretsmanager function (#10124) 2020-10-20 16:21:40 +02:00
test Fix line ending issues for test files (#10096) 2020-10-14 11:03:43 +02:00
vendor Merge pull request #10056 from marinsalinas/new_client 2020-10-16 15:28:54 -07:00
version
website Update docs to clarify how to use build vars in build template engines (#10141) 2020-10-22 09:42:45 +02:00
.codecov.yml
.gitattributes
.gitignore
.golangci.yml
.hashibot.hcl
CHANGELOG.md update changelog 2020-10-21 13:17:38 -07:00
CODEOWNERS
Dockerfile
LICENSE
Makefile
README.md
Vagrantfile
background_check.go
background_check_openbsd.go
checkpoint.go
commands.go
config.go Replace kardianos/osext.Executable with os.Executable (#10048) 2020-10-06 10:59:32 +02:00
config_test.go
go.mod review comments, add plugin type for a few missing builders 2020-10-21 16:17:32 -07:00
go.sum review comments, add plugin type for a few missing builders 2020-10-21 16:17:32 -07:00
log.go
main.go
main_test.go
panic.go
tty.go
tty_solaris.go

README.md

Packer

Build Status Windows Build Status PkgGoDev GoReportCard codecov

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.

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.