From 27ec05bc9fa3c7645f7ca930d606aed18ca14261 Mon Sep 17 00:00:00 2001 From: Ryan Johnson Date: Wed, 12 Jun 2024 22:31:27 -0400 Subject: [PATCH] docs: update provisioners Updates the provisioners documentation for a better reader experience by including a list of the built-in provisioners and a link to the community supported provisioners that are all withing the navigation tree. Ref: #12898 Signed-off-by: Ryan Johnson --- website/content/docs/provisioners/index.mdx | 26 +++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/website/content/docs/provisioners/index.mdx b/website/content/docs/provisioners/index.mdx index e9fb2f8669e..e6144beaef4 100644 --- a/website/content/docs/provisioners/index.mdx +++ b/website/content/docs/provisioners/index.mdx @@ -7,13 +7,31 @@ page_title: Provisioners # Provisioners -Provisioners use built-in and third-party software to install and configure the -machine image after booting. Provisioners prepare the system, so you may want to use them for the following use cases: +Provisioners use built-in and third-party software to install and configure the machine image after +booting. Provisioners prepare the system, so you may want to use them for the following use cases: - installing packages - patching the kernel - creating users - downloading application code -Refer to the [`provisioner`](/packer/docs/templates/hcl_templates/blocks/build/provisioner) block documentation to learn more -about working with provisioners. The documentation includes details about each type of provisioner. +The following provisioners are included with Packer: + +- [Breakpoint](/packer/docs/provisioners/breakpoint) - pause until the user presses `Enter` to resume + a build. +- [File](/packer/docs/provisioners/file) - upload files to machines image during a build. +- [Shell](/packer/docs/provisioners/shell) - run shell scripts on the machines image during a build. +- [Local Shell](/packer/docs/provisioners/shell-local) - run shell scripts on the host running Packer + during a build. +- [PowerShell](/packer/docs/provisioners/powershell) - run PowerShell scripts on Windows machine + images during a build. +- [Windows Shell](/packer/docs/provisioners/windows-shell) - run commands using `cmd` on Windows + machine images during a build. +- [Windows Restart](/packer/docs/provisioners/windows-restart) - initiate a reboot on a Windows + machine images during a build. + +Additional [Community Supported](/packer/docs/provisioners/community-supported) provisioners are +developed and maintained by various members of the community. + +Refer to the [`provisioner`](/packer/docs/templates/hcl_templates/blocks/build/provisioner) block +documentation to learn more about working with provisioners.