mirror of
https://github.com/hashicorp/packer.git
synced 2026-04-29 18:20:05 -04:00
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.
63 lines
1.3 KiB
Text
63 lines
1.3 KiB
Text
---
|
|
description: >
|
|
The scaffolding builder is used to create endless Packer plugins using
|
|
a consistent plugin structure.
|
|
page_title: Scaffolding - Builders
|
|
nav_title: Scaffolding
|
|
---
|
|
|
|
# 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"]
|
|
}
|
|
```
|
|
|
|
|