mirror of
https://github.com/hashicorp/packer.git
synced 2026-09-20 23:11:40 -04:00
d75975821f
* IPE-727 first commit, adds release notes * content for the 1.11 release notes * updates to init CLI reference * updates to install plugins CLI reference * updates to source information on the packer block configuration reference * updated Packer configuration page * updated plugins installation overview page * updated plugins installation usage page * added Upgrades section * added outline for an upgrade page for this version * added comments for upgrade page outline * renamed install plugins mdx and added redirects * Apply suggestions from code review Co-authored-by: Lucas Bajolet <[email protected]> * fix nav * fix bad links * applying additional feedback * Apply suggestions from code review Co-authored-by: Lucas Bajolet <[email protected]> * integrated rationale into release notes * removed 'upgrade from older version' section in the upgrade instructions * docs: fill-in the upgrade/1.11 document * Apply suggestions from code review Co-authored-by: Wilken Rivera <[email protected]> * edits to upgrade 1.11 and release note * Apply suggestions from code review Co-authored-by: Lucas Bajolet <[email protected]> * Apply suggestions from code review Co-authored-by: Lucas Bajolet <[email protected]> --------- Co-authored-by: Lucas Bajolet <[email protected]> Co-authored-by: Lucas Bajolet <[email protected]> Co-authored-by: Wilken Rivera <[email protected]>
47 lines
2.5 KiB
Plaintext
47 lines
2.5 KiB
Plaintext
---
|
|
description: |
|
|
This topic provides overview information about installing and loading Packer plugins
|
|
page_title: Plugins
|
|
---
|
|
|
|
# Plugin installation overview
|
|
|
|
This topic provides overview information about installing and loading Packer plugins. Plugins are standalone applications that perform additional tasks during each build.
|
|
|
|
## Introduction
|
|
|
|
The Packer binary includes a set of built-in components that are automatically usable. You can also install external plugins for Packer to run and communicate with throughout the build. These external plugins extend Packer functionality without modifying the core source code. Packer launches one plugin process for each component in the build.
|
|
|
|
## Workflows
|
|
|
|
To use a plugin with Packer, you must install the plugin code and its SHA256SUM file into the Packer plugins directory. Refer to [Installing Plugins](/packer/docs/plugins/install) for instructions.
|
|
|
|
## Where Packer stores plugins
|
|
|
|
Packer stores external plugins that are downloaded during initialization into the plugins directory. The default plugins directory is `$HOME/.config/packer/plugins` on Unix and `%APPDATA%\packer.d\plugins` on Windows. Refer to [`PACKER_PLUGIN_PATH`](/packer/docs/configure#packer_plugin_path) in the configuration reference for additional information.
|
|
|
|
## Guidance
|
|
|
|
Refer to the following plugin documentation for details about the plugin installation process:
|
|
|
|
### Installing plugins
|
|
|
|
Refer to [Installing Plugins](/packer/docs/plugins/install) for instructions on adding external plugins to your Packer template and installing the binaries.
|
|
|
|
### External plugins
|
|
|
|
Refer to the [Packer Integrations](/packer/integrations) documentation to learn about the available external plugins not included with the Packer binary.
|
|
|
|
|
|
### Built-in plugins
|
|
|
|
- Packer uses plugins called _builders_ to create machines and images. Refer to [Builders](/packer/docs/builders) for additional information.
|
|
- The _data sources_ plugin fetches data to use in a template. Refer to [Data Sources](/packer/docs/datasources) for additional information.
|
|
- Plugins called _provisioners_ install and configure machine images after booting. Refer to [Provisioners](/packer/docs/provisioners) for additional information.
|
|
- _Post-processors_ perform additional tasks after provisioning. Refer to [Post-Processors](/packer/docs/post-processors) for additional information.
|
|
|
|
|
|
### Developing plugins
|
|
|
|
Refer to the [Developing Plugins](/packer/docs/plugins/creation) to learn how to create custom external plugins.
|