diff --git a/website/source/docs/provisioners/ansible-local.html.md b/website/source/docs/provisioners/ansible-local.html.md.erb similarity index 99% rename from website/source/docs/provisioners/ansible-local.html.md rename to website/source/docs/provisioners/ansible-local.html.md.erb index 63cd15125..65f00944a 100644 --- a/website/source/docs/provisioners/ansible-local.html.md +++ b/website/source/docs/provisioners/ansible-local.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/ansible.html.md b/website/source/docs/provisioners/ansible.html.md.erb similarity index 99% rename from website/source/docs/provisioners/ansible.html.md rename to website/source/docs/provisioners/ansible.html.md.erb index b5b68fe94..3d8edf181 100644 --- a/website/source/docs/provisioners/ansible.html.md +++ b/website/source/docs/provisioners/ansible.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/breakpoint.html.md b/website/source/docs/provisioners/breakpoint.html.md.erb similarity index 96% rename from website/source/docs/provisioners/breakpoint.html.md rename to website/source/docs/provisioners/breakpoint.html.md.erb index d251e534b..8b8709be2 100644 --- a/website/source/docs/provisioners/breakpoint.html.md +++ b/website/source/docs/provisioners/breakpoint.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/chef-client.html.md b/website/source/docs/provisioners/chef-client.html.md.erb similarity index 99% rename from website/source/docs/provisioners/chef-client.html.md rename to website/source/docs/provisioners/chef-client.html.md.erb index c0ae990b9..803b346e6 100644 --- a/website/source/docs/provisioners/chef-client.html.md +++ b/website/source/docs/provisioners/chef-client.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/chef-solo.html.md b/website/source/docs/provisioners/chef-solo.html.md.erb similarity index 99% rename from website/source/docs/provisioners/chef-solo.html.md rename to website/source/docs/provisioners/chef-solo.html.md.erb index 280dc3462..44b4a3000 100644 --- a/website/source/docs/provisioners/chef-solo.html.md +++ b/website/source/docs/provisioners/chef-solo.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/converge.html.md b/website/source/docs/provisioners/converge.html.md.erb similarity index 98% rename from website/source/docs/provisioners/converge.html.md rename to website/source/docs/provisioners/converge.html.md.erb index 0a41ecdb6..6c79e8db0 100644 --- a/website/source/docs/provisioners/converge.html.md +++ b/website/source/docs/provisioners/converge.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/file.html.md b/website/source/docs/provisioners/file.html.md.erb similarity index 99% rename from website/source/docs/provisioners/file.html.md rename to website/source/docs/provisioners/file.html.md.erb index ec63aeaee..ed76682e5 100644 --- a/website/source/docs/provisioners/file.html.md +++ b/website/source/docs/provisioners/file.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/index.html.md b/website/source/docs/provisioners/index.html.md.erb similarity index 100% rename from website/source/docs/provisioners/index.html.md rename to website/source/docs/provisioners/index.html.md.erb diff --git a/website/source/docs/provisioners/inspec.html.md b/website/source/docs/provisioners/inspec.html.md.erb similarity index 98% rename from website/source/docs/provisioners/inspec.html.md rename to website/source/docs/provisioners/inspec.html.md.erb index 56809050d..e315529ac 100644 --- a/website/source/docs/provisioners/inspec.html.md +++ b/website/source/docs/provisioners/inspec.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/powershell.html.md.erb b/website/source/docs/provisioners/powershell.html.md.erb index 50b4ba312..2dfcc90a6 100644 --- a/website/source/docs/provisioners/powershell.html.md.erb +++ b/website/source/docs/provisioners/powershell.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/puppet-masterless.html.md b/website/source/docs/provisioners/puppet-masterless.html.md.erb similarity index 99% rename from website/source/docs/provisioners/puppet-masterless.html.md rename to website/source/docs/provisioners/puppet-masterless.html.md.erb index 41ced3fde..bca789e90 100644 --- a/website/source/docs/provisioners/puppet-masterless.html.md +++ b/website/source/docs/provisioners/puppet-masterless.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/puppet-server.html.md b/website/source/docs/provisioners/puppet-server.html.md.erb similarity index 99% rename from website/source/docs/provisioners/puppet-server.html.md rename to website/source/docs/provisioners/puppet-server.html.md.erb index 71bb54a9c..79f4e986c 100644 --- a/website/source/docs/provisioners/puppet-server.html.md +++ b/website/source/docs/provisioners/puppet-server.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/salt-masterless.html.md b/website/source/docs/provisioners/salt-masterless.html.md.erb similarity index 98% rename from website/source/docs/provisioners/salt-masterless.html.md rename to website/source/docs/provisioners/salt-masterless.html.md.erb index c59255847..7e6942e2f 100644 --- a/website/source/docs/provisioners/salt-masterless.html.md +++ b/website/source/docs/provisioners/salt-masterless.html.md.erb @@ -97,3 +97,5 @@ Optional: - `guest_os_type` (string) - The target guest OS type, either "unix" or "windows". + +<%= partial "partials/provisioners/common-config" %> diff --git a/website/source/docs/provisioners/shell-local.html.md b/website/source/docs/provisioners/shell-local.html.md.erb similarity index 99% rename from website/source/docs/provisioners/shell-local.html.md rename to website/source/docs/provisioners/shell-local.html.md.erb index 4ce66d6a8..5625d611c 100644 --- a/website/source/docs/provisioners/shell-local.html.md +++ b/website/source/docs/provisioners/shell-local.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/shell.html.md.erb b/website/source/docs/provisioners/shell.html.md.erb index 781c7e88d..3bfe898fe 100644 --- a/website/source/docs/provisioners/shell.html.md.erb +++ b/website/source/docs/provisioners/shell.html.md.erb @@ -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 diff --git a/website/source/docs/provisioners/windows-restart.html.md b/website/source/docs/provisioners/windows-restart.html.md.erb similarity index 98% rename from website/source/docs/provisioners/windows-restart.html.md rename to website/source/docs/provisioners/windows-restart.html.md.erb index bb340efc8..a32b98946 100644 --- a/website/source/docs/provisioners/windows-restart.html.md +++ b/website/source/docs/provisioners/windows-restart.html.md.erb @@ -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" %> diff --git a/website/source/docs/provisioners/windows-shell.html.md.erb b/website/source/docs/provisioners/windows-shell.html.md.erb index cbec0c3cc..06f7e8e82 100644 --- a/website/source/docs/provisioners/windows-shell.html.md.erb +++ b/website/source/docs/provisioners/windows-shell.html.md.erb @@ -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 diff --git a/website/source/partials/provisioners/_common-config.html.md b/website/source/partials/provisioners/_common-config.html.md new file mode 100644 index 000000000..6d4d48c35 --- /dev/null +++ b/website/source/partials/provisioners/_common-config.html.md @@ -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. \ No newline at end of file