packer-cn/website/source/docs/provisioners/shell-local.html.markdown

47 lines
1.3 KiB
Markdown
Raw Normal View History

2015-06-19 18:31:17 -04:00
---
2015-08-03 14:32:54 -04:00
description: |
The shell Packer provisioner provisions machines built by Packer using shell
scripts. Shell provisioning is the easiest way to get software installed and
configured on a machine.
layout: docs
page_title: Local Shell Provisioner
...
2015-06-19 18:31:17 -04:00
# Local Shell Provisioner
Type: `shell-local`
2015-08-03 14:32:54 -04:00
The local shell provisioner executes a local shell script on the machine running
Packer. The [remote shell](/docs/provisioners/shell.html) provisioner executes
shell scripts on a remote machine.
2015-06-19 18:31:17 -04:00
## Basic Example
The example below is fully functional.
2015-08-03 14:32:54 -04:00
``` {.javascript}
2015-06-19 18:31:17 -04:00
{
"type": "shell-local",
"command": "echo foo"
}
```
## Configuration Reference
The reference of available configuration options is listed below. The only
required element is "command".
Required:
2015-08-03 14:32:54 -04:00
- `command` (string) - The command to execute. This will be executed within
the context of a shell as specified by `execute_command`.
2015-06-19 18:31:17 -04:00
Optional parameters:
2015-08-03 14:32:54 -04:00
- `execute_command` (array of strings) - The command to use to execute
the script. By default this is `["/bin/sh", "-c", "{{.Command}"]`. The value
is an array of arguments executed directly by the OS. The value of this is
treated as [configuration
template](/docs/templates/configuration-templates.html). The only available
variable is `Command` which is the command to execute.