packer README

The project's README from github.com/hashicorp/packer. As one markdown file: README.md.

Packer

License: BUSL-1.1 Build Status Discuss

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 supports various platforms through external plugin integrations, the full list of which can be found at https://developer.hashicorp.com/packer/integrations.

The images that Packer creates can easily be turned into Vagrant boxes.

Quick Start

Packer

There is a great introduction and getting started guide for building a Docker image on your local machine without using any paid cloud resources.

Alternatively, you can refer to getting started with AWS to learn how to build a machine image for an external cloud provider.

HCP Packer

HCP Packer registry stores Packer image metadata, enabling you to track your image lifecycle.

To get started with building an AWS machine image to HCP Packer for referencing in Terraform refer to the collection of HCP Packer Tutorials.

Documentation

Comprehensive documentation is viewable on the Packer website at https://developer.hashicorp.com/packer/docs.

Contributing to Packer

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

Contributing to Documentation

Important: Packer documentation has moved to the hashicorp/web-unified-docs repository.

To contribute documentation changes:

Unmaintained Plugins

As contributors' circumstances change, development on a community maintained plugin can slow. When this happens, HashiCorp may use GitHub's option to archive the plugin’s repository, 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 HashiCorp.

If you are interested in maintaining an unmaintained or archived plugin, please reach out to us at [email protected].

packer (hashicorp/packer)

Searching Database…

15.8K ·GitHub
What is this?Packer is a tool for creating identical machine images for multiple platforms from a single source configuration. It is lightweight, runs on every major OS, and builds images for multiple platforms in parallel.
Is this a CLI tool or something else?It's a command-line tool with a plugin architecture: Packer itself provides the core engine, and platform-specific builders (AWS, Docker, etc.) are added via external plugins.
How do I get it running?Follow the getting started guide for building a Docker image locally without any paid cloud resources, or the AWS getting started guide to build an image on an external cloud provider.
Do I need cloud accounts or specific plugins to build images?It depends on the target platform: building a Docker image needs only a local Docker install, while building for AWS or other clouds requires credentials for that provider's plugin.
Are all the platform plugins actively maintained?Some community-maintained plugins can become unmaintained over time; HashiCorp archives their repos to signal this, though the code, docs, and issue tracking remain available.
Who typically uses Packer?DevOps and infrastructure engineers who need to produce consistent machine images (VM images, containers, cloud AMIs) from one configuration for use across different platforms.
Does it run on Windows and macOS too, or just Linux?Packer runs on every major operating system, not just Linux.
Can I turn Packer images into Vagrant boxes?Yes, images Packer creates can easily be turned into Vagrant boxes.
What is HCP Packer?HCP Packer is a registry that stores Packer image metadata so you can track your image lifecycle, for example building an AWS image and referencing it later in Terraform.
Where do I find full Packer documentation?Comprehensive documentation is on the Packer website, though docs content has moved to the hashicorp/web-unified-docs repository for contributions.
What if I want to maintain an archived community plugin?You can reach out to HashiCorp at [email protected] if you're interested in taking over an unmaintained or archived plugin.
Creator
hashicorp
Size
117.5 MB
Stars
15.8K
Age
13y
Commits · 90 Days