document common provisioner parameters
This commit is contained in:
parent
0b4ada9690
commit
aa3cb5be63
|
@ -155,6 +155,8 @@ chi-appservers
|
|||
`staging_directory` will be removed after executing ansible. By default,
|
||||
this is set to `false`.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Default Extra Variables
|
||||
|
||||
In addition to being able to specify extra arguments using the
|
|
@ -143,6 +143,8 @@ Optional Parameters:
|
|||
- `user` (string) - The `ansible_user` to use. Defaults to the user running
|
||||
packer.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Default Extra Variables
|
||||
|
||||
In addition to being able to specify extra arguments using the
|
|
@ -41,6 +41,8 @@ and between every provisioner.
|
|||
breakpoints or label them with information about where in the build they
|
||||
occur
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Usage
|
||||
|
||||
Insert this provisioner wherever you want the build to pause. You'll see ui
|
|
@ -143,6 +143,8 @@ configuration is actually required.
|
|||
machine. If this is NOT set, then it is your responsibility via other means
|
||||
(shell provisioner, etc.) to get a validation key to where Chef expects it.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Chef Configuration
|
||||
|
||||
By default, Packer uses a simple Chef configuration file in order to set the
|
|
@ -111,6 +111,8 @@ configuration is actually required, but at least `run_list` is recommended.
|
|||
- `version` (string) - The version of Chef to be installed. By default this
|
||||
is empty which will install the latest version of Chef.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Chef Configuration
|
||||
|
||||
By default, Packer uses a simple Chef configuration file in order to set the
|
|
@ -70,6 +70,8 @@ Optional parameters:
|
|||
- `prevent_bootstrap_sudo` (boolean) - stop Converge from bootstrapping with
|
||||
administrator privileges via sudo
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
### Module Directories
|
||||
|
||||
The provisioner can transfer module directories to the remote host for
|
|
@ -65,6 +65,9 @@ The available configuration options are listed below.
|
|||
the Packer run, but realize that there are situations where this may be
|
||||
unavoidable.
|
||||
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Directory Uploads
|
||||
|
||||
The file provisioner is also able to upload a complete directory to the remote
|
|
@ -104,6 +104,8 @@ Optional Parameters:
|
|||
|
||||
- `user` (string) - The `--user` to use. Defaults to the user running Packer.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Default Extra Variables
|
||||
|
||||
In addition to being able to specify extra arguments using the
|
|
@ -129,6 +129,8 @@ The example below is fully functional.
|
|||
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.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Default Environmental Variables
|
||||
|
||||
In addition to being able to specify custom environmental variables using the
|
||||
|
|
|
@ -121,6 +121,8 @@ multiple manifests you should use `manifest_file` instead.
|
|||
[powershell](/docs/provisioners/powershell.html) provisioner for the full
|
||||
details.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Execute Command
|
||||
|
||||
By default, Packer uses the following command (broken across multiple lines for
|
|
@ -106,6 +106,8 @@ listed below:
|
|||
[powershell](/docs/provisioners/powershell.html) provisioner for the full
|
||||
details.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Execute Command
|
||||
|
||||
By default, Packer uses the following command (broken across multiple lines for
|
|
@ -97,3 +97,5 @@ Optional:
|
|||
|
||||
- `guest_os_type` (string) - The target guest OS type, either "unix" or
|
||||
"windows".
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
|
@ -133,6 +133,8 @@ Optional parameters:
|
|||
intend to use the shell-local provisioner to run a bash script, please
|
||||
ignore this option.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Execute Command
|
||||
|
||||
To many new users, the `execute_command` is puzzling. However, it provides an
|
|
@ -94,6 +94,8 @@ The example below is fully functional.
|
|||
- `pause_after` (string) - Wait the amount of time after provisioning a shell
|
||||
script, this pause be taken if all previous steps were successful.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Execute Command Example
|
||||
|
||||
To many new users, the `execute_command` is puzzling. However, it provides an
|
||||
|
|
|
@ -75,3 +75,5 @@ Optional parameters:
|
|||
default this is 5 minutes. Example value: `5m`. If you are installing
|
||||
updates or have a lot of startup services, you will probably need to
|
||||
increase this duration.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
|
@ -49,6 +49,8 @@ The example below is fully functional.
|
|||
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.
|
||||
|
||||
<%= partial "partials/provisioners/common-config" %>
|
||||
|
||||
## Default Environmental Variables
|
||||
|
||||
In addition to being able to specify custom environmental variables using the
|
||||
|
|
|
@ -0,0 +1,25 @@
|
|||
Parameters common to all provisioners:
|
||||
|
||||
|
||||
- `pause_before` (duration) - Sleep for duration before execution.
|
||||
|
||||
- `only` (array of string) - Only run the provisioner for listed builder(s)
|
||||
by name.
|
||||
|
||||
- `override` (object) - Override the builder with different settings for a
|
||||
specific builder, eg :
|
||||
|
||||
``` json
|
||||
{
|
||||
"type": "shell",
|
||||
"script": "script.sh",
|
||||
"override": {
|
||||
"vmware-iso": {
|
||||
"execute_command": "echo 'password' | sudo -S bash {{.Path}}"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- `timeout` (duration) - If the provisioner takes more than for example
|
||||
`1h10m1s` or `10m` to finish, the provisioner will timeout and fail.
|
Loading…
Reference in New Issue