diff --git a/website/pages/docs/builders/azure/arm.mdx b/website/pages/docs/builders/azure/arm.mdx index 5cb0a1b3f..be2d84905 100644 --- a/website/pages/docs/builders/azure/arm.mdx +++ b/website/pages/docs/builders/azure/arm.mdx @@ -147,6 +147,16 @@ Providing `temp_resource_group_name` or `location` in combination with @include 'builder/azure/common/client/Config-not-required.mdx' +### Communicator Config + +In addition to the builder options, a communicator may also be defined: + +@include 'helper/communicator/Config-not-required.mdx' + +@include 'helper/communicator/SSH-not-required.mdx' + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + ## Basic Example Here is a basic example for Azure. diff --git a/website/pages/docs/builders/digitalocean.mdx b/website/pages/docs/builders/digitalocean.mdx index c7cc74427..8125b0a17 100644 --- a/website/pages/docs/builders/digitalocean.mdx +++ b/website/pages/docs/builders/digitalocean.mdx @@ -34,9 +34,16 @@ There are many configuration options available for the builder. They are segmented below into two categories: required and optional parameters. Within each category, the available configuration keys are alphabetized. -In addition to the options listed here, a -[communicator](/docs/templates/communicator) can be configured for this -builder. +### Communicator Config + +In addition to the builder options, a +[communicator](/docs/templates/communicator) can be configured for this builder. + +@include 'helper/communicator/Config-not-required.mdx' + +@include 'helper/communicator/SSH-not-required.mdx' + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' ### Required: diff --git a/website/pages/docs/builders/googlecompute.mdx b/website/pages/docs/builders/googlecompute.mdx index 89b49204d..3982fb01d 100644 --- a/website/pages/docs/builders/googlecompute.mdx +++ b/website/pages/docs/builders/googlecompute.mdx @@ -346,6 +346,16 @@ In addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this builder. +### Communicator Configuration + +#### Optional: + +@include 'helper/communicator/Config-not-required.mdx' + +@include 'helper/communicator/SSH-not-required.mdx' + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + ### Required: @include 'builder/googlecompute/Config-required.mdx' diff --git a/website/pages/docs/builders/hetzner-cloud.mdx b/website/pages/docs/builders/hetzner-cloud.mdx index 2d6e43016..88dc055d8 100644 --- a/website/pages/docs/builders/hetzner-cloud.mdx +++ b/website/pages/docs/builders/hetzner-cloud.mdx @@ -33,7 +33,7 @@ In addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this builder. -### Required: +### Required Builder Configuration options: - `token` (string) - The client TOKEN to use to access your account. It can also be specified via environment variable `HCLOUD_TOKEN`, if set. diff --git a/website/pages/docs/builders/hyperv/iso.mdx b/website/pages/docs/builders/hyperv/iso.mdx index d5c7eef18..b3ec0c227 100644 --- a/website/pages/docs/builders/hyperv/iso.mdx +++ b/website/pages/docs/builders/hyperv/iso.mdx @@ -115,6 +115,8 @@ builder. @include 'helper/communicator/SSH-not-required.mdx' +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + ### Optional WinRM fields: @include 'helper/communicator/WinRM-not-required.mdx' diff --git a/website/pages/docs/builders/hyperv/vmcx.mdx b/website/pages/docs/builders/hyperv/vmcx.mdx index 390bb6d92..a4e4cb228 100644 --- a/website/pages/docs/builders/hyperv/vmcx.mdx +++ b/website/pages/docs/builders/hyperv/vmcx.mdx @@ -113,6 +113,8 @@ builder. @include 'helper/communicator/SSH-not-required.mdx' +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + ### Optional WinRM fields: @include 'helper/communicator/WinRM-not-required.mdx' diff --git a/website/pages/docs/builders/linode.mdx b/website/pages/docs/builders/linode.mdx index a3f471c53..bc63e04ce 100644 --- a/website/pages/docs/builders/linode.mdx +++ b/website/pages/docs/builders/linode.mdx @@ -37,7 +37,10 @@ each category, the available configuration keys are alphabetized. In addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this -builder. +builder. In addition to the options defined there, a private key file +can also be supplied to override the typical auto-generated key: + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' ### Required diff --git a/website/pages/docs/builders/oneandone.mdx b/website/pages/docs/builders/oneandone.mdx index e82c41279..7262037a5 100644 --- a/website/pages/docs/builders/oneandone.mdx +++ b/website/pages/docs/builders/oneandone.mdx @@ -20,7 +20,10 @@ each category, the available configuration keys are alphabetized. In addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this -builder. +builder. In addition to the options defined there, a private key file +can also be supplied to override the typical auto-generated key: + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' ### Required diff --git a/website/pages/docs/builders/oracle/oci.mdx b/website/pages/docs/builders/oracle/oci.mdx index 209282f43..1e703fbcb 100644 --- a/website/pages/docs/builders/oracle/oci.mdx +++ b/website/pages/docs/builders/oracle/oci.mdx @@ -44,6 +44,11 @@ addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this builder. +In addition to the options defined there, a private key file +can also be supplied to override the typical auto-generated key: + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + ### Required - `availability_domain` (string) - The name of the [Availability diff --git a/website/pages/docs/builders/parallels/iso.mdx b/website/pages/docs/builders/parallels/iso.mdx index 248537434..ed5d0e519 100644 --- a/website/pages/docs/builders/parallels/iso.mdx +++ b/website/pages/docs/builders/parallels/iso.mdx @@ -55,7 +55,10 @@ category, the available options are alphabetized and described. In addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this -builder. +builder. In addition to the options defined there, a private key file +can also be supplied to override the typical auto-generated key: + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' ## ISO Configuration Reference diff --git a/website/pages/docs/builders/parallels/pvm.mdx b/website/pages/docs/builders/parallels/pvm.mdx index 175b0c99f..5dbf79025 100644 --- a/website/pages/docs/builders/parallels/pvm.mdx +++ b/website/pages/docs/builders/parallels/pvm.mdx @@ -52,7 +52,10 @@ category, the available options are alphabetized and described. In addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this -builder. +builder. In addition to the options defined there, a private key file +can also be supplied to override the typical auto-generated key: + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' ### Required: diff --git a/website/pages/docs/builders/profitbricks.mdx b/website/pages/docs/builders/profitbricks.mdx index 98f423455..216db8c99 100644 --- a/website/pages/docs/builders/profitbricks.mdx +++ b/website/pages/docs/builders/profitbricks.mdx @@ -20,7 +20,10 @@ each category, the available configuration keys are alphabetized. In addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this -builder. +builder. In addition to the options defined there, a private key file +can also be supplied to override the typical auto-generated key: + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' ### Required diff --git a/website/pages/docs/builders/scaleway.mdx b/website/pages/docs/builders/scaleway.mdx index 036910069..a93fbdbaf 100644 --- a/website/pages/docs/builders/scaleway.mdx +++ b/website/pages/docs/builders/scaleway.mdx @@ -36,7 +36,10 @@ each category, the available configuration keys are alphabetized. In addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this -builder. +builder. In addition to the options defined there, a private key file +can also be supplied to override the typical auto-generated key: + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' ### Required: diff --git a/website/pages/docs/builders/triton.mdx b/website/pages/docs/builders/triton.mdx index a458a76e4..bd822de30 100644 --- a/website/pages/docs/builders/triton.mdx +++ b/website/pages/docs/builders/triton.mdx @@ -49,7 +49,12 @@ segmented below into two categories: required and optional parameters. In addition to the options listed here, a [communicator](/docs/templates/communicator) can be configured for this -builder. +builder. In addition to the options defined there, a private key file +can also be supplied to override the typical auto-generated key: + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' + +@include 'helper/communicator/SSH-Agent-Auth-not-required.mdx' ### Required: diff --git a/website/pages/docs/builders/yandex.mdx b/website/pages/docs/builders/yandex.mdx index 331342c7a..7f8f51df3 100644 --- a/website/pages/docs/builders/yandex.mdx +++ b/website/pages/docs/builders/yandex.mdx @@ -63,7 +63,10 @@ optional. Within each category, the available options are alphabetized and described. In addition to the options listed here, a [communicator](/docs/templates/communicator) -can be configured for this builder. +can be configured for this builder. In addition to the options defined there, a private key file +can also be supplied to override the typical auto-generated key: + +@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx' ### Required: