Skip to content

Commit

Permalink
builder: update docs on PVE download option
Browse files Browse the repository at this point in the history
This commit makes the comment more concise and harmonises it between the
image's base ISO and the additional ISOs to fetch before starting the
build.
  • Loading branch information
lbajolet-hashicorp committed Nov 21, 2023
1 parent 0dc820e commit 108e332
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 16 deletions.
4 changes: 3 additions & 1 deletion .web-docs/components/builder/clone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,9 @@ In HCL2:
- `iso_storage_pool` (string) - Proxmox storage pool onto which to upload
the ISO file.

- `iso_download_pve` (bool) - ISO Download PVE
- `iso_download_pve` (bool) - Download the ISO directly from the PVE node rather than through Packer.

Defaults to `false`

- `unmount` (bool) - If true, remove the mounted ISO from the template after finishing. Defaults to `false`.

Expand Down
11 changes: 6 additions & 5 deletions .web-docs/components/builder/iso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,10 +216,9 @@ in the image's Cloud-Init settings for provisioning.
- `iso_storage_pool` (string) - Proxmox storage pool onto which to upload
the ISO file.

- `iso_download_pve` (bool) - Download the specified `iso_url` directly from
the PVE node. Defaults to `false`.
By default Packer downloads the ISO and uploads it in a second step, this
option lets Proxmox handle downloading the ISO directly from the server.
- `iso_download_pve` (bool) - Download the ISO directly from the PVE node rather than through Packer.

Defaults to `false`

- `unmount_iso` (bool) - If true, remove the mounted ISO from the template
after finishing. Defaults to `false`.
Expand Down Expand Up @@ -416,7 +415,9 @@ In HCL2:
- `iso_storage_pool` (string) - Proxmox storage pool onto which to upload
the ISO file.

- `iso_download_pve` (bool) - ISO Download PVE
- `iso_download_pve` (bool) - Download the ISO directly from the PVE node rather than through Packer.

Defaults to `false`

- `unmount` (bool) - If true, remove the mounted ISO from the template after finishing. Defaults to `false`.

Expand Down
5 changes: 4 additions & 1 deletion builder/proxmox/common/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,10 @@ type additionalISOsConfig struct {
// Proxmox storage pool onto which to upload
// the ISO file.
ISOStoragePool string `mapstructure:"iso_storage_pool"`
ISODownloadPVE bool `mapstructure:"iso_download_pve"`
// Download the ISO directly from the PVE node rather than through Packer.
//
// Defaults to `false`
ISODownloadPVE bool `mapstructure:"iso_download_pve"`
// If true, remove the mounted ISO from the template after finishing. Defaults to `false`.
Unmount bool `mapstructure:"unmount"`
ShouldUploadISO bool `mapstructure-to-hcl2:",skip"`
Expand Down
7 changes: 3 additions & 4 deletions builder/proxmox/iso/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ type Config struct {
// Proxmox storage pool onto which to upload
// the ISO file.
ISOStoragePool string `mapstructure:"iso_storage_pool"`
// Download the specified `iso_url` directly from
// the PVE node. Defaults to `false`.
// By default Packer downloads the ISO and uploads it in a second step, this
// option lets Proxmox handle downloading the ISO directly from the server.
// Download the ISO directly from the PVE node rather than through Packer.
//
// Defaults to `false`
ISODownloadPVE bool `mapstructure:"iso_download_pve"`
// If true, remove the mounted ISO from the template
// after finishing. Defaults to `false`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@
- `iso_storage_pool` (string) - Proxmox storage pool onto which to upload
the ISO file.

- `iso_download_pve` (bool) - ISO Download PVE
- `iso_download_pve` (bool) - Download the ISO directly from the PVE node rather than through Packer.

Defaults to `false`

- `unmount` (bool) - If true, remove the mounted ISO from the template after finishing. Defaults to `false`.

Expand Down
7 changes: 3 additions & 4 deletions docs-partials/builder/proxmox/iso/Config-not-required.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@
- `iso_storage_pool` (string) - Proxmox storage pool onto which to upload
the ISO file.

- `iso_download_pve` (bool) - Download the specified `iso_url` directly from
the PVE node. Defaults to `false`.
By default Packer downloads the ISO and uploads it in a second step, this
option lets Proxmox handle downloading the ISO directly from the server.
- `iso_download_pve` (bool) - Download the ISO directly from the PVE node rather than through Packer.

Defaults to `false`

- `unmount_iso` (bool) - If true, remove the mounted ISO from the template
after finishing. Defaults to `false`.
Expand Down

0 comments on commit 108e332

Please sign in to comment.