mirror of
https://github.com/hashicorp/packer.git
synced 2026-10-20 05:02:13 -04:00
Lucas Bajolet
35b2317ef3
The lib name for the common components for writing packer_test suites was not clear, and did not follow the convention established in Packer core and plugins. Therefore this commit does two things: first the lib is renamed into common as to follow this convention, and clearly document which components are common to all tests. Also checkers are placed in a subpackage of common, common/check, so that it is clearer what is meant to be used as checks for a command's execution status after it's been run, as part of Assert.
79 lines
2.5 KiB
Markdown
79 lines
2.5 KiB
Markdown
# Scaffolding Plugins
|
|
|
|
<!--
|
|
Include a short overview about the plugin.
|
|
|
|
This document is a great location for creating a table of contents for each
|
|
of the components the plugin may provide. This document should load automatically
|
|
when navigating to the docs directory for a plugin.
|
|
|
|
-->
|
|
|
|
## Installation
|
|
|
|
### Using pre-built releases
|
|
|
|
#### Using the `packer init` command
|
|
|
|
Starting from version 1.7, Packer supports a new `packer init` command allowing
|
|
automatic installation of Packer plugins. Read the
|
|
[Packer documentation](https://www.packer.io/docs/commands/init) for more information.
|
|
|
|
To install this plugin, copy and paste this code into your Packer configuration .
|
|
Then, run [`packer init`](https://www.packer.io/docs/commands/init).
|
|
|
|
```hcl
|
|
packer {
|
|
required_plugins {
|
|
name = {
|
|
version = ">= 0.0.1"
|
|
source = "github.com/hashicorp/name"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
#### Manual installation
|
|
|
|
You can find pre-built binary releases of the plugin [here](https://github.com/hashicorp/packer-plugin-name/releases).
|
|
Once you have downloaded the latest archive corresponding to your target OS,
|
|
uncompress it to retrieve the plugin binary file corresponding to your platform.
|
|
To install the plugin, please follow the Packer documentation on
|
|
[installing a plugin](https://www.packer.io/docs/extending/plugins/#installing-plugins).
|
|
|
|
|
|
#### From Source
|
|
|
|
If you prefer to build the plugin from its source code, clone the GitHub
|
|
repository locally and run the command `go build` from the root
|
|
directory. Upon successful compilation, a `packer-plugin-name` plugin
|
|
binary file can be found in the root directory.
|
|
To install the compiled plugin, please follow the official Packer documentation
|
|
on [installing a plugin](https://www.packer.io/docs/extending/plugins/#installing-plugins).
|
|
|
|
|
|
## Plugin Contents
|
|
|
|
The Scaffolding plugin is intended as a starting point for creating Packer plugins, containing:
|
|
|
|
### Builders
|
|
|
|
- [builder](/docs/builders/builder-name.mdx) - The scaffolding builder is used to create endless Packer
|
|
plugins using a consistent plugin structure.
|
|
|
|
### Provisioners
|
|
|
|
- [provisioner](/docs/provisioners/provisioner-name.mdx) - The scaffolding provisioner is used to provisioner
|
|
Packer builds.
|
|
|
|
### Post-processors
|
|
|
|
- [post-processor](/docs/post-processors/postprocessor-name.mdx) - The scaffolding post-processor is used to
|
|
export scaffolding builds.
|
|
|
|
### Data Sources
|
|
|
|
- [data source](/docs/datasources/datasource-name.mdx) - The scaffolding data source is used to
|
|
export scaffolding data.
|
|
|