Go to file
Wilken Rivera 9adeb989c6
Merge pull request #10442 from hashicorp/d-broken-link-check
Add GitHub action to check for broken markdown links
2021-01-06 16:30:38 -05:00
.circleci Use docker mirror 2020-10-29 11:05:41 -07:00
.github Add GHA to check for broken links on pull-request 2021-01-06 16:26:57 -05:00
builder Fix broken links detected by link checker 2021-01-06 16:27:12 -05:00
cmd remove sdk 2020-12-17 13:29:25 -08:00
command remove sdk 2020-12-17 13:29:25 -08:00
contrib docs tweaks 2020-10-14 12:58:04 -07:00
examples Extract plugin-specific examples to plugin directories (#10228) 2020-11-09 12:17:41 +01:00
fix fix fixer deprecated options conflict 2020-10-23 14:00:12 -07:00
hcl2template remove sdk 2020-12-17 13:29:25 -08: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 remove sdk 2020-12-17 13:29:25 -08:00
post-processor fix test fixture path 2020-12-17 14:41:36 -08:00
provisioner remove sdk 2020-12-17 13:29:25 -08:00
scripts remove sdk 2020-12-17 13:29:25 -08:00
test Fix line ending issues for test files (#10096) 2020-10-14 11:03:43 +02:00
vendor update vendoring 2020-12-17 15:12:16 -08:00
version remove sdk 2020-12-17 13:29:25 -08:00
website Add regenerated docs from packer-plugin-sdk 2021-01-06 16:27:12 -05:00
.codecov.yml add step_add_floppy unit tests 2020-09-22 16:23:11 +02:00
.gitattributes Update .gitattributes 2020-10-02 11:06:02 +02:00
.gitignore Added support for IAM credential in the token field and YC_TOKEN env 2020-10-23 11:47:28 +03:00
.golangci.yml Add golangci-lint to project (#8686) 2020-02-14 11:42:29 -05:00
.hashibot.hcl update hashibot config not to comment when locking super old and stale issues 2020-04-03 11:37:34 -07:00
CHANGELOG.md Putting source back into Dev Mode 2020-12-16 21:34:25 +00:00
CODEOWNERS update scaleway code owners (#9852) 2020-08-31 14:41:45 +02: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 fix makefile 2020-12-11 13:37:03 -08:00
README.md Fix a broken link in the README (#10259) 2020-11-16 10:51:55 -05: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 Add packer fmt command (#10225) 2020-11-11 11:49:39 -05:00
config.go remove sdk 2020-12-17 13:29:25 -08:00
config_test.go remove sdk 2020-12-17 13:29:25 -08:00
formatted.pkr.hcl command/fmt: Ensure all variable files ending in `.pkrvars.hcl` get formatted (#10377) 2020-12-14 10:29:58 -05:00
go.mod update vendoring 2020-12-17 15:12:16 -08:00
go.sum go.mod updates 2020-12-17 14:55:14 -08: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 remove sdk 2020-12-17 13:29:25 -08:00
main_test.go move packer to hashicorp 2017-04-04 13:39:01 -07:00
mlc_config.json Fix broken links detected by link checker 2021-01-06 16:27:12 -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 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.

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.