Add regenerated docs from packer-plugin-sdk

```
cd $HOME/Development/packer-plugin-sdk
PROJECT_ROOT=packer-plugin-sdk go generate ./...
rsync -av multistep/commonsteps/packer-plugin-sdk/website/content/partials/ ../packer/website/content/partials/
rsync -av bootcommand/packer-plugin-sdk/website/content/partials/ ../packer/website/content/partials/
rsync -av shutdowncommand/packer-plugin-sdk/website/content/partials/ ../packer/website/content/partials/
rsync -av communicator/packer-plugin-sdk/website/content/partials/ ../packer/website/content/partials/
```
This commit is contained in:
Wilken Rivera 2021-01-06 09:40:39 -05:00
parent 5ade0dc87b
commit 2e78193cc8
22 changed files with 118 additions and 117 deletions

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the BootConfig struct in packer-plugin-sdk/bootcommand/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the BootConfig struct in bootcommand/config.go; DO NOT EDIT MANUALLY -->
- `boot_keygroup_interval` (duration string | ex: "1h5m2s") - Time to wait after sending a group of key pressses. The value of this - `boot_keygroup_interval` (duration string | ex: "1h5m2s") - Time to wait after sending a group of key pressses. The value of this
should be a duration. Examples are `5s` and `1m30s` which will cause should be a duration. Examples are `5s` and `1m30s` which will cause

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the BootConfig struct in packer-plugin-sdk/bootcommand/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the BootConfig struct in bootcommand/config.go; DO NOT EDIT MANUALLY -->
The boot configuration is very important: `boot_command` specifies the keys The boot configuration is very important: `boot_command` specifies the keys
to type when the virtual machine is first booted in order to start the OS to type when the virtual machine is first booted in order to start the OS
@ -11,62 +11,62 @@ sequence. It is an array only to improve readability within the template.
There are a set of special keys available. If these are in your boot There are a set of special keys available. If these are in your boot
command, they will be replaced by the proper key: command, they will be replaced by the proper key:
- `<bs>` - Backspace - `<bs>` - Backspace
- `<del>` - Delete - `<del>` - Delete
- `<enter> <return>` - Simulates an actual "enter" or "return" keypress. - `<enter> <return>` - Simulates an actual "enter" or "return" keypress.
- `<esc>` - Simulates pressing the escape key. - `<esc>` - Simulates pressing the escape key.
- `<tab>` - Simulates pressing the tab key. - `<tab>` - Simulates pressing the tab key.
- `<f1> - <f12>` - Simulates pressing a function key. - `<f1> - <f12>` - Simulates pressing a function key.
- `<up> <down> <left> <right>` - Simulates pressing an arrow key. - `<up> <down> <left> <right>` - Simulates pressing an arrow key.
- `<spacebar>` - Simulates pressing the spacebar. - `<spacebar>` - Simulates pressing the spacebar.
- `<insert>` - Simulates pressing the insert key. - `<insert>` - Simulates pressing the insert key.
- `<home> <end>` - Simulates pressing the home and end keys. - `<home> <end>` - Simulates pressing the home and end keys.
- `<pageUp> <pageDown>` - Simulates pressing the page up and page down - `<pageUp> <pageDown>` - Simulates pressing the page up and page down
keys. keys.
- `<menu>` - Simulates pressing the Menu key. - `<menu>` - Simulates pressing the Menu key.
- `<leftAlt> <rightAlt>` - Simulates pressing the alt key. - `<leftAlt> <rightAlt>` - Simulates pressing the alt key.
- `<leftCtrl> <rightCtrl>` - Simulates pressing the ctrl key. - `<leftCtrl> <rightCtrl>` - Simulates pressing the ctrl key.
- `<leftShift> <rightShift>` - Simulates pressing the shift key. - `<leftShift> <rightShift>` - Simulates pressing the shift key.
- `<leftSuper> <rightSuper>` - Simulates pressing the ⌘ or Windows key. - `<leftSuper> <rightSuper>` - Simulates pressing the ⌘ or Windows key.
- `<wait> <wait5> <wait10>` - Adds a 1, 5 or 10 second pause before - `<wait> <wait5> <wait10>` - Adds a 1, 5 or 10 second pause before
sending any additional keys. This is useful if you have to generally sending any additional keys. This is useful if you have to generally
wait for the UI to update before typing more. wait for the UI to update before typing more.
- `<waitXX>` - Add an arbitrary pause before sending any additional keys. - `<waitXX>` - Add an arbitrary pause before sending any additional keys.
The format of `XX` is a sequence of positive decimal numbers, each with The format of `XX` is a sequence of positive decimal numbers, each with
optional fraction and a unit suffix, such as `300ms`, `1.5h` or `2h45m`. optional fraction and a unit suffix, such as `300ms`, `1.5h` or `2h45m`.
Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. For Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. For
example `<wait10m>` or `<wait1m20s>`. example `<wait10m>` or `<wait1m20s>`.
- `<XXXOn> <XXXOff>` - Any printable keyboard character, and of these - `<XXXOn> <XXXOff>` - Any printable keyboard character, and of these
"special" expressions, with the exception of the `<wait>` types, can "special" expressions, with the exception of the `<wait>` types, can
also be toggled on or off. For example, to simulate ctrl+c, use also be toggled on or off. For example, to simulate ctrl+c, use
`<leftCtrlOn>c<leftCtrlOff>`. Be sure to release them, otherwise they `<leftCtrlOn>c<leftCtrlOff>`. Be sure to release them, otherwise they
will be held down until the machine reboots. To hold the `c` key down, will be held down until the machine reboots. To hold the `c` key down,
you would use `<cOn>`. Likewise, `<cOff>` to release. you would use `<cOn>`. Likewise, `<cOff>` to release.
- `{{ .HTTPIP }} {{ .HTTPPort }}` - The IP and port, respectively of an - `{{ .HTTPIP }} {{ .HTTPPort }}` - The IP and port, respectively of an
HTTP server that is started serving the directory specified by the HTTP server that is started serving the directory specified by the
`http_directory` configuration parameter. If `http_directory` isn't `http_directory` configuration parameter. If `http_directory` isn't
specified, these will be blank! specified, these will be blank!
- `{{ .Name }}` - The name of the VM. - `{{ .Name }}` - The name of the VM.
Example boot command. This is actually a working boot command used to start an Example boot command. This is actually a working boot command used to start an
CentOS 6.4 installer: CentOS 6.4 installer:

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the VNCConfig struct in packer-plugin-sdk/bootcommand/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the VNCConfig struct in bootcommand/config.go; DO NOT EDIT MANUALLY -->
- `disable_vnc` (bool) - Whether to create a VNC connection or not. A boot_command cannot be used - `disable_vnc` (bool) - Whether to create a VNC connection or not. A boot_command cannot be used
when this is true. Defaults to false. when this is true. Defaults to false.

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the VNCConfig struct in packer-plugin-sdk/bootcommand/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the VNCConfig struct in bootcommand/config.go; DO NOT EDIT MANUALLY -->
The boot command "typed" character for character over a VNC connection to The boot command "typed" character for character over a VNC connection to
the machine, simulating a human actually typing the keyboard. the machine, simulating a human actually typing the keyboard.

View File

@ -1,14 +1,14 @@
<!-- Code generated from the comments of the Config struct in packer-plugin-sdk/communicator/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the Config struct in communicator/config.go; DO NOT EDIT MANUALLY -->
- `communicator` (string) - Packer currently supports three kinds of communicators: - `communicator` (string) - Packer currently supports three kinds of communicators:
- `none` - No communicator will be used. If this is set, most - `none` - No communicator will be used. If this is set, most
provisioners also can't be used. provisioners also can't be used.
- `ssh` - An SSH connection will be established to the machine. This - `ssh` - An SSH connection will be established to the machine. This
is usually the default. is usually the default.
- `winrm` - A WinRM connection will be established. - `winrm` - A WinRM connection will be established.
In addition to the above, some builders have custom communicators they In addition to the above, some builders have custom communicators they
can use. For example, the Docker builder has a "docker" communicator can use. For example, the Docker builder has a "docker" communicator

View File

@ -1,4 +1,5 @@
<!-- Code generated from the comments of the Config struct in packer-plugin-sdk/communicator/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the Config struct in communicator/config.go; DO NOT EDIT MANUALLY -->
Config is the common configuration that communicators allow within Config is the common configuration a builder uses to define and configure a Packer
a builder. communicator. Embed this struct in your builder config to implement
communicator support.

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the SSH struct in packer-plugin-sdk/communicator/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the SSH struct in communicator/config.go; DO NOT EDIT MANUALLY -->
- `ssh_host` (string) - The address to SSH to. This usually is automatically configured by the - `ssh_host` (string) - The address to SSH to. This usually is automatically configured by the
builder. builder.
@ -11,9 +11,9 @@
- `ssh_ciphers` ([]string) - This overrides the value of ciphers supported by default by golang. - `ssh_ciphers` ([]string) - This overrides the value of ciphers supported by default by golang.
The default value is [ The default value is [
"aes128-gcm@openssh.com", "aes128-gcm@openssh.com",
"chacha20-poly1305@openssh.com", "chacha20-poly1305@openssh.com",
"aes128-ctr", "aes192-ctr", "aes256-ctr", "aes128-ctr", "aes192-ctr", "aes256-ctr",
] ]
Valid options for ciphers include: Valid options for ciphers include:

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the SSHInterface struct in packer-plugin-sdk/communicator/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the SSHInterface struct in communicator/config.go; DO NOT EDIT MANUALLY -->
- `ssh_interface` (string) - One of `public_ip`, `private_ip`, `public_dns`, or `private_dns`. If - `ssh_interface` (string) - One of `public_ip`, `private_ip`, `public_dns`, or `private_dns`. If
set, either the public IP address, private IP address, public DNS name set, either the public IP address, private IP address, public DNS name

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the SSHTemporaryKeyPair struct in packer-plugin-sdk/communicator/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the SSHTemporaryKeyPair struct in communicator/config.go; DO NOT EDIT MANUALLY -->
- `temporary_key_pair_type` (string) - `dsa` | `ecdsa` | `ed25519` | `rsa` ( the default ) - `temporary_key_pair_type` (string) - `dsa` | `ecdsa` | `ed25519` | `rsa` ( the default )

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the SSHTemporaryKeyPair struct in packer-plugin-sdk/communicator/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the SSHTemporaryKeyPair struct in communicator/config.go; DO NOT EDIT MANUALLY -->
When no ssh credentials are specified, Packer will generate a temporary SSH When no ssh credentials are specified, Packer will generate a temporary SSH
keypair for the instance, you can change the algorithm type and bits keypair for the instance, you can change the algorithm type and bits

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the WinRM struct in packer-plugin-sdk/communicator/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the WinRM struct in communicator/config.go; DO NOT EDIT MANUALLY -->
- `winrm_username` (string) - The username to use to connect to WinRM. - `winrm_username` (string) - The username to use to connect to WinRM.
@ -30,4 +30,4 @@
for WinRM, rather than default (basic authentication), removing the for WinRM, rather than default (basic authentication), removing the
requirement for basic authentication to be enabled within the target requirement for basic authentication to be enabled within the target
guest. Further reading for remote connection authentication can be found guest. Further reading for remote connection authentication can be found
[here](<https://msdn.microsoft.com/en-us/library/aa384295(v=vs.85).aspx>). [here](https://msdn.microsoft.com/en-us/library/aa384295(v=vs.85).aspx).

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the CDConfig struct in packer-plugin-sdk/multistep/commonsteps/extra_iso_config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the CDConfig struct in multistep/commonsteps/extra_iso_config.go; DO NOT EDIT MANUALLY -->
- `cd_files` ([]string) - A list of files to place onto a CD that is attached when the VM is - `cd_files` ([]string) - A list of files to place onto a CD that is attached when the VM is
booted. This can include either files or directories; any directories booted. This can include either files or directories; any directories
@ -39,9 +39,9 @@
that can handle the iso creation. Packer will use one of the following that can handle the iso creation. Packer will use one of the following
tools: tools:
- xorriso * xorriso
- mkisofs * mkisofs
- hdiutil (normally found in macOS) * hdiutil (normally found in macOS)
- oscdimg (normally found in Windows as part of the Windows ADK) * oscdimg (normally found in Windows as part of the Windows ADK)
- `cd_label` (string) - CD Label - `cd_label` (string) - CD Label

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the CDConfig struct in packer-plugin-sdk/multistep/commonsteps/extra_iso_config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the CDConfig struct in multistep/commonsteps/extra_iso_config.go; DO NOT EDIT MANUALLY -->
An iso (CD) containing custom files can be made available for your build. An iso (CD) containing custom files can be made available for your build.

View File

@ -1,8 +1,8 @@
<!-- Code generated from the comments of the FloppyConfig struct in packer-plugin-sdk/multistep/commonsteps/floppy_config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the FloppyConfig struct in multistep/commonsteps/floppy_config.go; DO NOT EDIT MANUALLY -->
- `floppy_files` ([]string) - A list of files to place onto a floppy disk that is attached when the VM - `floppy_files` ([]string) - A list of files to place onto a floppy disk that is attached when the VM
is booted. Currently, no support exists for creating sub-directories on is booted. Currently, no support exists for creating sub-directories on
the floppy. Wildcard characters (\\\*, ?, and \[\]) are allowed. Directory the floppy. Wildcard characters (\\*, ?, and \[\]) are allowed. Directory
names are also allowed, which will add all the files found in the names are also allowed, which will add all the files found in the
directory to the floppy. directory to the floppy.
@ -10,7 +10,7 @@
similar to the `floppy_files` option except that the directory structure similar to the `floppy_files` option except that the directory structure
is preserved. This is useful for when your floppy disk includes drivers is preserved. This is useful for when your floppy disk includes drivers
or if you just want to organize it's contents as a hierarchy. Wildcard or if you just want to organize it's contents as a hierarchy. Wildcard
characters (\\\*, ?, and \[\]) are allowed. The maximum summary size of characters (\\*, ?, and \[\]) are allowed. The maximum summary size of
all files in the listed directories are the same as in `floppy_files`. all files in the listed directories are the same as in `floppy_files`.
- `floppy_label` (string) - Floppy Label - `floppy_label` (string) - Floppy Label

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the FloppyConfig struct in packer-plugin-sdk/multistep/commonsteps/floppy_config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the FloppyConfig struct in multistep/commonsteps/floppy_config.go; DO NOT EDIT MANUALLY -->
A floppy can be made available for your build. This is most useful for A floppy can be made available for your build. This is most useful for
unattended Windows installs, which look for an Autounattend.xml file on unattended Windows installs, which look for an Autounattend.xml file on

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the HTTPConfig struct in packer-plugin-sdk/multistep/commonsteps/http_config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the HTTPConfig struct in multistep/commonsteps/http_config.go; DO NOT EDIT MANUALLY -->
- `http_directory` (string) - Path to a directory to serve using an HTTP server. The files in this - `http_directory` (string) - Path to a directory to serve using an HTTP server. The files in this
directory will be available over HTTP that will be requestable from the directory will be available over HTTP that will be requestable from the

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the HTTPConfig struct in packer-plugin-sdk/multistep/commonsteps/http_config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the HTTPConfig struct in multistep/commonsteps/http_config.go; DO NOT EDIT MANUALLY -->
Packer will create an http server serving `http_directory` when it is set, a Packer will create an http server serving `http_directory` when it is set, a
random free port will be selected and the architecture of the directory random free port will be selected and the architecture of the directory
@ -6,4 +6,4 @@ referenced will be available in your builder.
Example usage from a builder: Example usage from a builder:
`wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg` `wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg`

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the ISOConfig struct in packer-plugin-sdk/multistep/commonsteps/iso_config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the ISOConfig struct in multistep/commonsteps/iso_config.go; DO NOT EDIT MANUALLY -->
- `iso_urls` ([]string) - Multiple URLs for the ISO to download. Packer will try these in order. - `iso_urls` ([]string) - Multiple URLs for the ISO to download. Packer will try these in order.
If anything goes wrong attempting to download or while downloading a If anything goes wrong attempting to download or while downloading a

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the ISOConfig struct in packer-plugin-sdk/multistep/commonsteps/iso_config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the ISOConfig struct in multistep/commonsteps/iso_config.go; DO NOT EDIT MANUALLY -->
- `iso_checksum` (string) - The checksum for the ISO file or virtual hard drive file. The type of - `iso_checksum` (string) - The checksum for the ISO file or virtual hard drive file. The type of
the checksum is specified within the checksum field as a prefix, ex: the checksum is specified within the checksum field as a prefix, ex:
@ -7,20 +7,19 @@
"none", "{$checksum}", "md5:{$checksum}", "sha1:{$checksum}", "none", "{$checksum}", "md5:{$checksum}", "sha1:{$checksum}",
"sha256:{$checksum}", "sha512:{$checksum}" or "file:{$path}". Here is a "sha256:{$checksum}", "sha512:{$checksum}" or "file:{$path}". Here is a
list of valid checksum values: list of valid checksum values:
* md5:090992ba9fd140077b0661cb75f7ce13
- md5:090992ba9fd140077b0661cb75f7ce13 * 090992ba9fd140077b0661cb75f7ce13
- 090992ba9fd140077b0661cb75f7ce13 * sha1:ebfb681885ddf1234c18094a45bbeafd91467911
- sha1:ebfb681885ddf1234c18094a45bbeafd91467911 * ebfb681885ddf1234c18094a45bbeafd91467911
- ebfb681885ddf1234c18094a45bbeafd91467911 * sha256:ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
- sha256:ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93 * ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
- ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93 * file:http://releases.ubuntu.com/20.04/SHA256SUMS
- file:http://releases.ubuntu.com/20.04/MD5SUMS * file:file://./local/path/file.sum
- file:file://./local/path/file.sum * file:./local/path/file.sum
- file:./local/path/file.sum * none
- none Although the checksum will not be verified when it is set to "none",
Although the checksum will not be verified when it is set to "none", this is not recommended since these files can be very large and
this is not recommended since these files can be very large and corruption does happen from time to time.
corruption does happen from time to time.
- `iso_url` (string) - A URL to the ISO containing the installation image or virtual hard drive - `iso_url` (string) - A URL to the ISO containing the installation image or virtual hard drive
(VHD or VHDX) file to clone. (VHD or VHDX) file to clone.

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the ISOConfig struct in packer-plugin-sdk/multistep/commonsteps/iso_config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the ISOConfig struct in multistep/commonsteps/iso_config.go; DO NOT EDIT MANUALLY -->
By default, Packer will symlink, download or copy image files to the Packer By default, Packer will symlink, download or copy image files to the Packer
cache into a "`hash($iso_url+$iso_checksum).$iso_target_extension`" file. cache into a "`hash($iso_url+$iso_checksum).$iso_target_extension`" file.
@ -7,11 +7,11 @@ file mode in order to perform a download.
go-getter supports the following protocols: go-getter supports the following protocols:
- Local files * Local files
- Git * Git
- Mercurial * Mercurial
- HTTP * HTTP
- Amazon S3 * Amazon S3
Examples: Examples:
go-getter can guess the checksum type based on `iso_checksum` length, and it is go-getter can guess the checksum type based on `iso_checksum` length, and it is

View File

@ -1,4 +1,4 @@
<!-- Code generated from the comments of the ShutdownConfig struct in packer-plugin-sdk/shutdowncommand/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the ShutdownConfig struct in shutdowncommand/config.go; DO NOT EDIT MANUALLY -->
- `shutdown_command` (string) - The command to use to gracefully shut down the machine once all - `shutdown_command` (string) - The command to use to gracefully shut down the machine once all
provisioning is complete. By default this is an empty string, which provisioning is complete. By default this is an empty string, which

View File

@ -1,7 +1,8 @@
<!-- Code generated from the comments of the ShutdownConfig struct in packer-plugin-sdk/shutdowncommand/config.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the ShutdownConfig struct in shutdowncommand/config.go; DO NOT EDIT MANUALLY -->
ShutdownConfig defines implementation details for shutting down a VM once it ShutdownConfig defines implementation details for shutting down a VM once it
is done provisioned. is done being provisioned.
It is provided as a convenience to encourage builder developers to It is provided as a convenience to encourage builder developers to
consider implementing these options, which we believe are valuable for all consider implementing these options, which we believe are valuable for all
builders. It also helps guarantee that option names for similar options builders. It also helps guarantee that option names for similar options