more docs update to add ssh private key file to all the builders that have them built into the create ssh key step
This commit is contained in:
parent
ad0b413e2d
commit
24d5824061
|
@ -147,6 +147,16 @@ Providing `temp_resource_group_name` or `location` in combination with
|
||||||
|
|
||||||
@include 'builder/azure/common/client/Config-not-required.mdx'
|
@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
|
## Basic Example
|
||||||
|
|
||||||
Here is a basic example for Azure.
|
Here is a basic example for Azure.
|
||||||
|
|
|
@ -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
|
segmented below into two categories: required and optional parameters. Within
|
||||||
each category, the available configuration keys are alphabetized.
|
each category, the available configuration keys are alphabetized.
|
||||||
|
|
||||||
In addition to the options listed here, a
|
### Communicator Config
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
|
||||||
builder.
|
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:
|
### Required:
|
||||||
|
|
||||||
|
|
|
@ -346,6 +346,16 @@ In addition to the options listed here, a
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
[communicator](/docs/templates/communicator) can be configured for this
|
||||||
builder.
|
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:
|
### Required:
|
||||||
|
|
||||||
@include 'builder/googlecompute/Config-required.mdx'
|
@include 'builder/googlecompute/Config-required.mdx'
|
||||||
|
|
|
@ -33,7 +33,7 @@ In addition to the options listed here, a
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
[communicator](/docs/templates/communicator) can be configured for this
|
||||||
builder.
|
builder.
|
||||||
|
|
||||||
### Required:
|
### Required Builder Configuration options:
|
||||||
|
|
||||||
- `token` (string) - The client TOKEN to use to access your account. It can
|
- `token` (string) - The client TOKEN to use to access your account. It can
|
||||||
also be specified via environment variable `HCLOUD_TOKEN`, if set.
|
also be specified via environment variable `HCLOUD_TOKEN`, if set.
|
||||||
|
|
|
@ -115,6 +115,8 @@ builder.
|
||||||
|
|
||||||
@include 'helper/communicator/SSH-not-required.mdx'
|
@include 'helper/communicator/SSH-not-required.mdx'
|
||||||
|
|
||||||
|
@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx'
|
||||||
|
|
||||||
### Optional WinRM fields:
|
### Optional WinRM fields:
|
||||||
|
|
||||||
@include 'helper/communicator/WinRM-not-required.mdx'
|
@include 'helper/communicator/WinRM-not-required.mdx'
|
||||||
|
|
|
@ -113,6 +113,8 @@ builder.
|
||||||
|
|
||||||
@include 'helper/communicator/SSH-not-required.mdx'
|
@include 'helper/communicator/SSH-not-required.mdx'
|
||||||
|
|
||||||
|
@include 'helper/communicator/SSH-Private-Key-File-not-required.mdx'
|
||||||
|
|
||||||
### Optional WinRM fields:
|
### Optional WinRM fields:
|
||||||
|
|
||||||
@include 'helper/communicator/WinRM-not-required.mdx'
|
@include 'helper/communicator/WinRM-not-required.mdx'
|
||||||
|
|
|
@ -37,7 +37,10 @@ each category, the available configuration keys are alphabetized.
|
||||||
|
|
||||||
In addition to the options listed here, a
|
In addition to the options listed here, a
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
[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
|
### Required
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,10 @@ each category, the available configuration keys are alphabetized.
|
||||||
|
|
||||||
In addition to the options listed here, a
|
In addition to the options listed here, a
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
[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
|
### Required
|
||||||
|
|
||||||
|
|
|
@ -44,6 +44,11 @@ addition to the options listed here, a
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
[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
|
### Required
|
||||||
|
|
||||||
- `availability_domain` (string) - The name of the [Availability
|
- `availability_domain` (string) - The name of the [Availability
|
||||||
|
|
|
@ -55,7 +55,10 @@ category, the available options are alphabetized and described.
|
||||||
|
|
||||||
In addition to the options listed here, a
|
In addition to the options listed here, a
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
[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
|
## ISO Configuration Reference
|
||||||
|
|
||||||
|
|
|
@ -52,7 +52,10 @@ category, the available options are alphabetized and described.
|
||||||
|
|
||||||
In addition to the options listed here, a
|
In addition to the options listed here, a
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
[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:
|
### Required:
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,10 @@ each category, the available configuration keys are alphabetized.
|
||||||
|
|
||||||
In addition to the options listed here, a
|
In addition to the options listed here, a
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
[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
|
### Required
|
||||||
|
|
||||||
|
|
|
@ -36,7 +36,10 @@ each category, the available configuration keys are alphabetized.
|
||||||
|
|
||||||
In addition to the options listed here, a
|
In addition to the options listed here, a
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
[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:
|
### Required:
|
||||||
|
|
||||||
|
|
|
@ -49,7 +49,12 @@ segmented below into two categories: required and optional parameters.
|
||||||
|
|
||||||
In addition to the options listed here, a
|
In addition to the options listed here, a
|
||||||
[communicator](/docs/templates/communicator) can be configured for this
|
[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:
|
### Required:
|
||||||
|
|
||||||
|
|
|
@ -63,7 +63,10 @@ optional. Within each category, the available options are alphabetized and
|
||||||
described.
|
described.
|
||||||
|
|
||||||
In addition to the options listed here, a [communicator](/docs/templates/communicator)
|
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:
|
### Required:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue