packer/website/content/docs/builders/null.mdx
Zachary Shilton cae7bd9e5b
feat(website): add official and HCP Packer Ready labels (#11449)
* refactor(website): use prop and CSS for plugin label spacing

* fix: add official tier label to built-in plugin docs

* feat(website): add BadgesHeader component

* refactor(website): use BadgesHeader in all content

* feat(website): add HCP ready demo, tweak badge look

* refactor: integrate work from add-plugin-version branch

* fix(website): correct bad import

* fix: use updated MDX custom component

* chore: remove plugin version label work from this branch

* chore: remove unused var

* fix: use new BadgesHeader interface for dual tags

* chore: remove unused var, refine comment

* fix: remove unused broken import

* fix: shorten property for HCP packer readiness

* Apply suggestions from code review

Remove a few demo labels before merging

Co-authored-by: Wilken Rivera <dev@wilkenrivera.com>
2021-12-17 10:22:16 -05:00

61 lines
1.3 KiB
Text

---
description: |
The null Packer builder is not really a builder, it just sets up an SSH
connection and runs the provisioners. It can be used to debug provisioners
without incurring high wait times. It does not create any kind of image or
artifact.
page_title: Null - Builders
---
<BadgesHeader>
<PluginBadge type="official" />
</BadgesHeader>
# Null Builder
Type: `null`
The `null` Packer builder is not really a builder, it just sets up an SSH
connection and runs the provisioners. It can be used to debug provisioners
without incurring high wait times. It does not create any kind of image or
artifact.
## Basic Example
Below is a fully functioning example. It doesn't do anything useful, since no
provisioners are defined, but it will connect to the specified host via ssh.
<Tabs>
<Tab heading="JSON">
```json
{
"type": "null",
"ssh_host": "127.0.0.1",
"ssh_username": "foo",
"ssh_password": "bar"
}
```
</Tab>
<Tab heading="HCL2">
```hcl
source "null" "basic-example" {
ssh_host = "127.0.0.1"
ssh_username = "foo"
ssh_password = "bar"
}
build {
sources = ["sources.null.basic-example"]
}
```
</Tab>
</Tabs>
## Configuration Reference
The null builder has no configuration parameters other than the
[communicator](/docs/templates/legacy_json_templates/communicator) settings.