packer/packer_test/common/plugin_tester/docs
Lucas Bajolet 35b2317ef3 packer_test: rename/split lib into common/check
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.
2024-09-11 16:08:51 -04:00
..
builders packer_test: rename/split lib into common/check 2024-09-11 16:08:51 -04:00
datasources packer_test: rename/split lib into common/check 2024-09-11 16:08:51 -04:00
post-processors packer_test: rename/split lib into common/check 2024-09-11 16:08:51 -04:00
provisioners packer_test: rename/split lib into common/check 2024-09-11 16:08:51 -04:00
README.md packer_test: rename/split lib into common/check 2024-09-11 16:08:51 -04:00

Scaffolding Plugins

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 for more information.

To install this plugin, copy and paste this code into your Packer configuration . Then, run packer init.

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

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.

Plugin Contents

The Scaffolding plugin is intended as a starting point for creating Packer plugins, containing:

Builders

  • builder - The scaffolding builder is used to create endless Packer plugins using a consistent plugin structure.

Provisioners

  • provisioner - The scaffolding provisioner is used to provisioner Packer builds.

Post-processors

  • post-processor - The scaffolding post-processor is used to export scaffolding builds.

Data Sources

  • data source - The scaffolding data source is used to export scaffolding data.