From 1aeb29036aa0617052a688f06fecc8361ba9102b Mon Sep 17 00:00:00 2001 From: Megan Marsh Date: Thu, 29 Nov 2018 14:47:06 -0800 Subject: [PATCH] docs --- .../docs/provisioners/breakpoint.html.md | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 website/source/docs/provisioners/breakpoint.html.md diff --git a/website/source/docs/provisioners/breakpoint.html.md b/website/source/docs/provisioners/breakpoint.html.md new file mode 100644 index 000000000..536768edb --- /dev/null +++ b/website/source/docs/provisioners/breakpoint.html.md @@ -0,0 +1,37 @@ +--- +description: | + The breakpoint provisioner will pause until the user presses "enter" to + resume the build. This is intended for debugging purposes, and allows you + to halt at a particular part of the provisioning process. +layout: docs +page_title: 'breakpoint - Provisioners' +sidebar_current: 'docs-provisioners-breakpoint' +--- + +# File Provisioner + +Type: `breakpoint` + +The breakpoint provisioner will pause until the user presses "enter" to +resume the build. This is intended for debugging purposes, and allows you +to halt at a particular part of the provisioning process, rather than using the +`-debug` flag, which will instead halt at every step and between every +provisioner. + +## Basic Example + +``` json +{ + "type": "breakpoint", + "note": "foo bar baz" +} +``` + +## Configuration Reference + +### Optional + +- `note` (string) - a string to include explaining the purpose or location of + the breakpoint. For example, you may find it useful to number your + breakpoints or label them with information about where in the build they + occur \ No newline at end of file