docs/builder/vsphere-iso: Add documentation for BootConfig (#9538)
* docs/builder/vsphere-iso: Add documentation for BootConfig * Add documenation for http_ip * Remove duplicate build configuration section
This commit is contained in:
parent
eeb6f017bd
commit
892413b7ea
|
@ -1,3 +1,4 @@
|
||||||
|
//go:generate struct-markdown
|
||||||
package common
|
package common
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
@ -15,6 +16,8 @@ import (
|
||||||
|
|
||||||
type BootConfig struct {
|
type BootConfig struct {
|
||||||
bootcommand.BootConfig `mapstructure:",squash"`
|
bootcommand.BootConfig `mapstructure:",squash"`
|
||||||
|
// The IP address to use for the HTTP server started to serve the `http_directory`.
|
||||||
|
// If unset, Packer will automatically discover and assign an IP.
|
||||||
HTTPIP string `mapstructure:"http_ip"`
|
HTTPIP string `mapstructure:"http_ip"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -54,8 +54,7 @@ necessary for this build to succeed and can be found further down the page.
|
||||||
|
|
||||||
@include 'common/bootcommand/BootConfig-not-required.mdx'
|
@include 'common/bootcommand/BootConfig-not-required.mdx'
|
||||||
|
|
||||||
For more examples of various boot commands, see the sample projects from our
|
@include 'builder/vsphere/common/BootConfig-not-required.mdx'
|
||||||
[community templates page](/community-tools#templates).
|
|
||||||
|
|
||||||
### Http directory configuration
|
### Http directory configuration
|
||||||
|
|
||||||
|
|
|
@ -41,6 +41,33 @@ necessary for this build to succeed and can be found further down the page.
|
||||||
|
|
||||||
@include 'builder/vsphere/iso/Config-not-required.mdx'
|
@include 'builder/vsphere/iso/Config-not-required.mdx'
|
||||||
|
|
||||||
|
### Boot Configuration
|
||||||
|
|
||||||
|
@include 'common/bootcommand/BootConfig.mdx'
|
||||||
|
|
||||||
|
We send each character to the VM with a default delay of 100ms between groups.
|
||||||
|
The delay alleviates possible issues with latency and CPU
|
||||||
|
contention. If you notice missing keys, you can tune this delay by specifying
|
||||||
|
"boot_keygroup_interval" in your Packer template, for example:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"builders": [
|
||||||
|
{
|
||||||
|
"type": "vsphere-iso",
|
||||||
|
"boot_keygroup_interval": "500ms"
|
||||||
|
...
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Optional:
|
||||||
|
|
||||||
|
@include 'common/bootcommand/BootConfig-not-required.mdx'
|
||||||
|
|
||||||
|
@include 'builder/vsphere/common/BootConfig-not-required.mdx'
|
||||||
|
|
||||||
### Http directory configuration
|
### Http directory configuration
|
||||||
|
|
||||||
@include 'common/HTTPConfig.mdx'
|
@include 'common/HTTPConfig.mdx'
|
||||||
|
@ -162,31 +189,6 @@ from the datastore. Example:
|
||||||
|
|
||||||
@include 'helper/communicator/WinRM-not-required.mdx'
|
@include 'helper/communicator/WinRM-not-required.mdx'
|
||||||
|
|
||||||
## Boot Configuration
|
|
||||||
|
|
||||||
@include 'common/bootcommand/BootConfig.mdx'
|
|
||||||
|
|
||||||
We send each character to the VM with a default delay of 100ms between groups.
|
|
||||||
The delay alleviates possible issues with latency and CPU
|
|
||||||
contention. If you notice missing keys, you can tune this delay by specifying
|
|
||||||
"boot_keygroup_interval" in your Packer template, for example:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"builders": [
|
|
||||||
{
|
|
||||||
"type": "vsphere-iso",
|
|
||||||
"boot_keygroup_interval": "500ms"
|
|
||||||
...
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Optional:
|
|
||||||
|
|
||||||
@include 'common/bootcommand/BootConfig-not-required.mdx'
|
|
||||||
|
|
||||||
## Working with Clusters
|
## Working with Clusters
|
||||||
|
|
||||||
#### Standalone Hosts
|
#### Standalone Hosts
|
||||||
|
|
|
@ -0,0 +1,5 @@
|
||||||
|
<!-- Code generated from the comments of the BootConfig struct in builder/vsphere/common/step_boot_command.go; DO NOT EDIT MANUALLY -->
|
||||||
|
|
||||||
|
- `http_ip` (string) - The IP address to use for the HTTP server started to serve the `http_directory`.
|
||||||
|
If unset, Packer will automatically discover and assign an IP.
|
||||||
|
|
Loading…
Reference in New Issue