Reformat docs
This commit is contained in:
parent
f5abdffa71
commit
07eff4c014
|
@ -1,23 +1,25 @@
|
|||
---
|
||||
layout: "docs"
|
||||
page_title: "Local Shell Provisioner"
|
||||
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.
|
||||
---
|
||||
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
|
||||
...
|
||||
|
||||
# Local Shell Provisioner
|
||||
|
||||
Type: `shell-local`
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Basic Example
|
||||
|
||||
The example below is fully functional.
|
||||
|
||||
```javascript
|
||||
``` {.javascript}
|
||||
{
|
||||
"type": "shell-local",
|
||||
"command": "echo foo"
|
||||
|
@ -31,15 +33,14 @@ required element is "command".
|
|||
|
||||
Required:
|
||||
|
||||
* `command` (string) - The command to execute. This will be executed
|
||||
within the context of a shell as specified by `execute_command`.
|
||||
- `command` (string) - The command to execute. This will be executed within
|
||||
the context of a shell as specified by `execute_command`.
|
||||
|
||||
Optional parameters:
|
||||
|
||||
* `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.
|
||||
|
||||
- `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.
|
||||
|
|
|
@ -1,16 +1,17 @@
|
|||
---
|
||||
layout: "docs"
|
||||
page_title: "Windows Restart Provisioner"
|
||||
description: |-
|
||||
The Windows restart provisioner restarts a Windows machine and waits for it to come back up.
|
||||
---
|
||||
description: |
|
||||
The Windows restart provisioner restarts a Windows machine and waits for it to
|
||||
come back up.
|
||||
layout: docs
|
||||
page_title: Windows Restart Provisioner
|
||||
...
|
||||
|
||||
# Windows Restart Provisioner
|
||||
|
||||
Type: `windows-restart`
|
||||
|
||||
The Windows restart provisioner initiates a reboot on a Windows machine
|
||||
and waits for the machine to come back online.
|
||||
The Windows restart provisioner initiates a reboot on a Windows machine and
|
||||
waits for the machine to come back online.
|
||||
|
||||
The Windows provisioning process often requires multiple reboots, and this
|
||||
provisioner helps to ease that process.
|
||||
|
@ -19,7 +20,7 @@ provisioner helps to ease that process.
|
|||
|
||||
The example below is fully functional.
|
||||
|
||||
```javascript
|
||||
``` {.javascript}
|
||||
{
|
||||
"type": "windows-restart"
|
||||
}
|
||||
|
@ -31,13 +32,13 @@ The reference of available configuration options is listed below.
|
|||
|
||||
Optional parameters:
|
||||
|
||||
* `restart_command` (string) - The command to execute to initiate the
|
||||
restart. By default this is `shutdown /r /c "packer restart" /t 5 && net stop winrm`.
|
||||
A key action of this is to stop WinRM so that Packer can detect it
|
||||
is rebooting.
|
||||
- `restart_command` (string) - The command to execute to initiate the restart.
|
||||
By default this is `shutdown /r /c "packer restart" /t 5 && net stop winrm`.
|
||||
A key action of this is to stop WinRM so that Packer can detect it
|
||||
is rebooting.
|
||||
|
||||
* `restart_check_command` (string) - A command to execute to check if the
|
||||
restart succeeded. This will be done in a loop.
|
||||
- `restart_check_command` (string) - A command to execute to check if the
|
||||
restart succeeded. This will be done in a loop.
|
||||
|
||||
* `restart_timeout` (string) - The timeout to wait for the restart.
|
||||
By default this is 5 minutes. Example value: "5m"
|
||||
- `restart_timeout` (string) - The timeout to wait for the restart. By default
|
||||
this is 5 minutes. Example value: "5m"
|
||||
|
|
|
@ -1,22 +1,23 @@
|
|||
---
|
||||
layout: "docs"
|
||||
page_title: "Windows Shell Provisioner"
|
||||
description: |-
|
||||
The windows-shell Packer provisioner runs commands on Windows using the cmd shell.
|
||||
---
|
||||
description: |
|
||||
The windows-shell Packer provisioner runs commands on Windows using the cmd
|
||||
shell.
|
||||
layout: docs
|
||||
page_title: Windows Shell Provisioner
|
||||
...
|
||||
|
||||
# Windows Shell Provisioner
|
||||
|
||||
Type: `windows-shell`
|
||||
|
||||
The windows-shell Packer provisioner runs commands on a Windows machine
|
||||
using `cmd`. It assumes it is running over WinRM.
|
||||
The windows-shell Packer provisioner runs commands on a Windows machine using
|
||||
`cmd`. It assumes it is running over WinRM.
|
||||
|
||||
## Basic Example
|
||||
|
||||
The example below is fully functional.
|
||||
|
||||
```javascript
|
||||
``` {.javascript}
|
||||
{
|
||||
"type": "windows-shell",
|
||||
"inline": ["dir c:\\"]
|
||||
|
@ -28,48 +29,47 @@ The example below is fully functional.
|
|||
The reference of available configuration options is listed below. The only
|
||||
required element is either "inline" or "script". Every other option is optional.
|
||||
|
||||
Exactly _one_ of the following is required:
|
||||
Exactly *one* of the following is required:
|
||||
|
||||
* `inline` (array of strings) - This is an array of commands to execute.
|
||||
The commands are concatenated by newlines and turned into a single file,
|
||||
so they are all executed within the same context. This allows you to
|
||||
change directories in one command and use something in the directory in
|
||||
the next and so on. Inline scripts are the easiest way to pull off simple
|
||||
tasks within the machine.
|
||||
- `inline` (array of strings) - This is an array of commands to execute. The
|
||||
commands are concatenated by newlines and turned into a single file, so they
|
||||
are all executed within the same context. This allows you to change
|
||||
directories in one command and use something in the directory in the next
|
||||
and so on. Inline scripts are the easiest way to pull off simple tasks
|
||||
within the machine.
|
||||
|
||||
* `script` (string) - The path to a script to upload and execute in the machine.
|
||||
This path can be absolute or relative. If it is relative, it is relative
|
||||
to the working directory when Packer is executed.
|
||||
- `script` (string) - The path to a script to upload and execute in
|
||||
the machine. This path can be absolute or relative. If it is relative, it is
|
||||
relative to the working directory when Packer is executed.
|
||||
|
||||
* `scripts` (array of strings) - An array of scripts to execute. The scripts
|
||||
will be uploaded and executed in the order specified. Each script is executed
|
||||
in isolation, so state such as variables from one script won't carry on to
|
||||
the next.
|
||||
- `scripts` (array of strings) - An array of scripts to execute. The scripts
|
||||
will be uploaded and executed in the order specified. Each script is
|
||||
executed in isolation, so state such as variables from one script won't
|
||||
carry on to the next.
|
||||
|
||||
Optional parameters:
|
||||
|
||||
* `binary` (boolean) - If true, specifies that the script(s) are binary
|
||||
files, and Packer should therefore not convert Windows line endings to
|
||||
Unix line endings (if there are any). By default this is false.
|
||||
- `binary` (boolean) - If true, specifies that the script(s) are binary files,
|
||||
and Packer should therefore not convert Windows line endings to Unix line
|
||||
endings (if there are any). By default this is false.
|
||||
|
||||
* `environment_vars` (array of strings) - An array of key/value pairs
|
||||
to inject prior to the execute_command. The format should be
|
||||
`key=value`. Packer injects some environmental variables by default
|
||||
into the environment, as well, which are covered in the section below.
|
||||
- `environment_vars` (array of strings) - An array of key/value pairs to
|
||||
inject prior to the execute\_command. The format should be `key=value`.
|
||||
Packer injects some environmental variables by default into the environment,
|
||||
as well, which are covered in the section below.
|
||||
|
||||
* `execute_command` (string) - The command to use to execute the script.
|
||||
By default this is `{{ .Vars }}"{{ .Path }}"`. The value of this is
|
||||
treated as [configuration template](/docs/templates/configuration-templates.html).
|
||||
There are two available variables: `Path`, which is
|
||||
the path to the script to run, and `Vars`, which is the list of
|
||||
`environment_vars`, if configured.
|
||||
- `execute_command` (string) - The command to use to execute the script. By
|
||||
default this is `{{ .Vars }}"{{ .Path }}"`. The value of this is treated as
|
||||
[configuration template](/docs/templates/configuration-templates.html).
|
||||
There are two available variables: `Path`, which is the path to the script
|
||||
to run, and `Vars`, which is the list of `environment_vars`, if configured.
|
||||
|
||||
* `remote_path` (string) - The path where the script will be uploaded to
|
||||
in the machine. This defaults to "/tmp/script.sh". This value must be
|
||||
a writable location and any parent directories must already exist.
|
||||
- `remote_path` (string) - The path where the script will be uploaded to in
|
||||
the machine. This defaults to "/tmp/script.sh". This value must be a
|
||||
writable location and any parent directories must already exist.
|
||||
|
||||
* `start_retry_timeout` (string) - The amount of time to attempt to
|
||||
_start_ the remote process. By default this is "5m" or 5 minutes. This
|
||||
setting exists in order to deal with times when SSH may restart, such as
|
||||
a system reboot. Set this to a higher value if reboots take a longer
|
||||
amount of time.
|
||||
- `start_retry_timeout` (string) - The amount of time to attempt to *start*
|
||||
the remote process. By default this is "5m" or 5 minutes. This setting
|
||||
exists in order to deal with times when SSH may restart, such as a
|
||||
system reboot. Set this to a higher value if reboots take a longer amount
|
||||
of time.
|
||||
|
|
Loading…
Reference in New Issue