ContextQMD
Back to Packer

Scaffolding

packer_test/common/plugin_tester/docs/builders/builder-name.mdx

1.15.31.1 KB
Original Source

Scaffolding

Type: scaffolding

<!-- Include a short description about the builder. This is a good place to call out what the builder does, and any requirements for the given builder environment. See https://www.packer.io/docs/builders/null -->

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

<!-- Builder Configuration Fields -->

Required

  • mock (string) - The name of the mock to use for the Scaffolding API.
<!-- Optional Configuration Fields Configuration options that are not required or have reasonable defaults should be listed under the optionals section. Defaults values should be noted in the description of the field -->

Optional

  • mock_api_url (string) - The Scaffolding API endpoint to connect to. Defaults to https://example.com
<!-- A basic example on the usage of the builder. Multiple examples can be provided to highlight various build configurations. -->

Example Usage

hcl
 source "scaffolding" "example" {
   mock = "bird"
 }

 build {
   sources = ["source.scaffolding.example"]
 }