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
parent
04dbbe2d8e
commit
8d4c7d31b4
|
|
@ -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
|
||||
should be a duration. Examples are `5s` and `1m30s` which will cause
|
||||
|
|
|
|||
|
|
@ -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
|
||||
to type when the virtual machine is first booted in order to start the OS
|
||||
|
|
|
|||
|
|
@ -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
|
||||
when this is true. Defaults to false.
|
||||
|
|
|
|||
|
|
@ -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 machine, simulating a human actually typing the keyboard.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<!-- 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:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +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 a builder uses to define and configure a Packer
|
||||
Config is the common configuration a builder uses to define and configure a Packer
|
||||
communicator. Embed this struct in your builder config to implement
|
||||
communicator support.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
builder.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
set, either the public IP address, private IP address, public DNS name
|
||||
|
|
|
|||
|
|
@ -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 )
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
keypair for the instance. You can change the algorithm type and bits
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
@ -30,4 +30,4 @@
|
|||
for WinRM, rather than default (basic authentication), removing the
|
||||
requirement for basic authentication to be enabled within the target
|
||||
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).
|
||||
|
|
|
|||
|
|
@ -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
|
||||
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
|
||||
tools:
|
||||
|
||||
- xorriso
|
||||
- mkisofs
|
||||
- hdiutil (normally found in macOS)
|
||||
- oscdimg (normally found in Windows as part of the Windows ADK)
|
||||
* xorriso
|
||||
* mkisofs
|
||||
* hdiutil (normally found in macOS)
|
||||
* oscdimg (normally found in Windows as part of the Windows ADK)
|
||||
|
||||
- `cd_label` (string) - CD Label
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
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
|
||||
directory to the floppy.
|
||||
|
||||
|
|
@ -10,7 +10,7 @@
|
|||
similar to the `floppy_files` option except that the directory structure
|
||||
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
|
||||
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`.
|
||||
|
||||
- `floppy_label` (string) - Floppy Label
|
||||
|
|
|
|||
|
|
@ -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
|
||||
unattended Windows installs, which look for an Autounattend.xml file on
|
||||
|
|
|
|||
|
|
@ -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
|
||||
directory will be available over HTTP that will be requestable from the
|
||||
|
|
|
|||
|
|
@ -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
|
||||
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:
|
||||
|
||||
`wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg`
|
||||
`wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg`
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
If anything goes wrong attempting to download or while downloading a
|
||||
|
|
|
|||
|
|
@ -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
|
||||
the checksum is specified within the checksum field as a prefix, ex:
|
||||
|
|
@ -7,17 +7,16 @@
|
|||
"none", "{$checksum}", "md5:{$checksum}", "sha1:{$checksum}",
|
||||
"sha256:{$checksum}", "sha512:{$checksum}" or "file:{$path}". Here is a
|
||||
list of valid checksum values:
|
||||
|
||||
- md5:090992ba9fd140077b0661cb75f7ce13
|
||||
- 090992ba9fd140077b0661cb75f7ce13
|
||||
- sha1:ebfb681885ddf1234c18094a45bbeafd91467911
|
||||
- ebfb681885ddf1234c18094a45bbeafd91467911
|
||||
- sha256:ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
|
||||
- ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
|
||||
- file:http://releases.ubuntu.com/20.04/MD5SUMS
|
||||
- file:file://./local/path/file.sum
|
||||
- file:./local/path/file.sum
|
||||
- none
|
||||
* md5:090992ba9fd140077b0661cb75f7ce13
|
||||
* 090992ba9fd140077b0661cb75f7ce13
|
||||
* sha1:ebfb681885ddf1234c18094a45bbeafd91467911
|
||||
* ebfb681885ddf1234c18094a45bbeafd91467911
|
||||
* sha256:ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
|
||||
* ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
|
||||
* file:http://releases.ubuntu.com/20.04/SHA256SUMS
|
||||
* file:file://./local/path/file.sum
|
||||
* file:./local/path/file.sum
|
||||
* 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
|
||||
corruption does happen from time to time.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
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:
|
||||
|
||||
- Local files
|
||||
- Git
|
||||
- Mercurial
|
||||
- HTTP
|
||||
- Amazon S3
|
||||
* Local files
|
||||
* Git
|
||||
* Mercurial
|
||||
* HTTP
|
||||
* Amazon S3
|
||||
|
||||
Examples:
|
||||
go-getter can guess the checksum type based on `iso_checksum` length, and it is
|
||||
|
|
|
|||
|
|
@ -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
|
||||
provisioning is complete. By default this is an empty string, which
|
||||
|
|
|
|||
|
|
@ -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
|
||||
is done provisioned.
|
||||
is done being provisioned.
|
||||
|
||||
It is provided as a convenience to encourage builder developers to
|
||||
consider implementing these options, which we believe are valuable for all
|
||||
builders. It also helps guarantee that option names for similar options
|
||||
|
|
|
|||
Loading…
Reference in New Issue