corrects default value and adds highlighting (#10886)

* value is expected to be `ssh` not `SSH`

* highlighting default values
This commit is contained in:
Kerim Satirli 2021-04-08 12:02:05 +02:00 committed by GitHub
parent 86788220a9
commit 8c4eb5f4aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -134,10 +134,10 @@ Optional Parameters:
different location. different location.
- `backend` (string) - Backend used by InSpec for connection. Defaults to - `backend` (string) - Backend used by InSpec for connection. Defaults to
SSH. `ssh`.
- `host` (string) - Host used for by InSpec for connection. Defaults to - `host` (string) - Host used for by InSpec for connection. Defaults to
localhost. `localhost`.
- `local_port` (uint) - The port on which to attempt to listen for SSH - `local_port` (uint) - The port on which to attempt to listen for SSH
connections. This value is a starting point. The provisioner will attempt to connections. This value is a starting point. The provisioner will attempt to
@ -149,7 +149,7 @@ Optional Parameters:
server on the host machine to forward commands to the target machine. server on the host machine to forward commands to the target machine.
InSpec connects to this server and will validate the identity of the server InSpec connects to this server and will validate the identity of the server
using the system known_hosts. The default behavior is to generate and use using the system known_hosts. The default behavior is to generate and use
a onetime key. a one-time key.
- `ssh_authorized_key_file` (string) - The SSH public key of the InSpec - `ssh_authorized_key_file` (string) - The SSH public key of the InSpec
`ssh_user`. The default behavior is to generate and use a onetime key. If `ssh_user`. The default behavior is to generate and use a onetime key. If
@ -160,7 +160,7 @@ Optional Parameters:
- `valid_exit_codes` (list of ints) - A list of valid exit codes returned by - `valid_exit_codes` (list of ints) - A list of valid exit codes returned by
inspec to be accepted by the provisioner. The default is (0,101) (accept inspec to be accepted by the provisioner. The default is (0,101) (accept
skipped tests). See [inspec exit codes](https://docs.chef.io/inspec/cli/#exec) skipped tests). See [InSpec exit codes](https://docs.chef.io/inspec/cli/#exec)
for a list and explanation of inspec exit codes. for a list and explanation of inspec exit codes.
@include 'provisioners/common-config.mdx' @include 'provisioners/common-config.mdx'