packer

command module
Version: v1.7.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 27, 2021 License: MPL-2.0 Imports: 30 Imported by: 0

README

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")}"
  sensitive = true
}

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 from the 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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
builder
cmd
packer-plugins-check
packer-plugin-check is a command used by plugins to validate compatibility and basic configuration to work with Packer.
packer-plugin-check is a command used by plugins to validate compatibility and basic configuration to work with Packer.
datasource
Package hcl2template defines code to parse hcl2 template files.
Package hcl2template defines code to parse hcl2 template files.
addrs
Package addrs contains types that represent "addresses", which are references to specific objects within a Packer configuration.
Package addrs contains types that represent "addresses", which are references to specific objects within a Packer configuration.
repl
Package repl provides the structs and functions necessary to run REPL for HCL2.
Package repl provides the structs and functions necessary to run REPL for HCL2.
helper
wrappedreadline
STOLEN SHAMELESSLY FROM THE TERRAFORM REPO BECAUSE VENDORING OUT WRAPPEDREADLINE AND WRAPPEDSTREAMS FELT LIKE TOO MUCH WORK.
STOLEN SHAMELESSLY FROM THE TERRAFORM REPO BECAUSE VENDORING OUT WRAPPEDREADLINE AND WRAPPEDSTREAMS FELT LIKE TOO MUCH WORK.
wrappedstreams
STOLEN SHAMELESSLY FROM THE TERRAFORM REPO BECAUSE VENDORING OUT WRAPPEDREADLINE AND WRAPPEDSTREAMS FELT LIKE TOO MUCH WORK.
STOLEN SHAMELESSLY FROM THE TERRAFORM REPO BECAUSE VENDORING OUT WRAPPEDREADLINE AND WRAPPEDSTREAMS FELT LIKE TOO MUCH WORK.
plugin-getter
Package plugingetter defines means to download and install plugins.
Package plugingetter defines means to download and install plugins.
post-processor
provisioner
powershell
This package implements a provisioner for Packer that executes powershell scripts within the remote machine.
This package implements a provisioner for Packer that executes powershell scripts within the remote machine.
shell
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
windows-shell
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
This package implements a provisioner for Packer that executes shell scripts within the remote machine.
Generate Plugins is a small program that updates the lists of plugins in command/plugin.go so they will be compiled into the main packer binary.
Generate Plugins is a small program that updates the lists of plugins in command/plugin.go so they will be compiled into the main packer binary.
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL