mirror of
https://github.com/hashicorp/packer.git
synced 2026-10-22 14:12:10 -04:00
backport of commit 1f4f2aebca
This commit is contained in:
@@ -0,0 +1,78 @@
|
||||
---
|
||||
description: >
|
||||
The scaffolding data source is used to create endless Packer plugins using
|
||||
a consistent plugin structure.
|
||||
page_title: Scaffolding - Data Sources
|
||||
nav_title: Scaffolding
|
||||
---
|
||||
|
||||
# Scaffolding
|
||||
|
||||
Type: `scaffolding`
|
||||
|
||||
<!--
|
||||
Include a short description about the data source. This is a good place
|
||||
to call out what the data source does, and any requirements for the given
|
||||
data source environment. See https://www.packer.io/docs/datasources/amazon-ami
|
||||
-->
|
||||
|
||||
The scaffolding data source is used to create endless Packer plugins using
|
||||
a consistent plugin structure.
|
||||
|
||||
|
||||
<!-- Data source 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 data source. Multiple examples
|
||||
can be provided to highlight various build configurations.
|
||||
|
||||
-->
|
||||
|
||||
### OutPut
|
||||
|
||||
- `foo` (string) - The Scaffolding output foo value.
|
||||
- `bar` (string) - The Scaffolding output bar value.
|
||||
|
||||
<!--
|
||||
A basic example on the usage of the data source. Multiple examples
|
||||
can be provided to highlight various build configurations.
|
||||
|
||||
-->
|
||||
|
||||
### Example Usage
|
||||
|
||||
|
||||
```hcl
|
||||
data "scaffolding" "example" {
|
||||
mock = "bird"
|
||||
}
|
||||
source "scaffolding" "example" {
|
||||
mock = data.scaffolding.example.foo
|
||||
}
|
||||
|
||||
build {
|
||||
sources = ["source.scaffolding.example"]
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user