Skip to main content

SSH Tunnel

An SSH tunnel is a secure connection between two devices. This resource allows you to create an SSH tunnel to a bastion host, which can then be used in other connections to tunnel through to a target host.

Examples​

ssh_tunnel:
host: example-bastion-host.com
port: 22
user: example-user
private_key: ${vaults.my_vault_name.my_private_key}

SshTunnel​

Below are the properties for the SshTunnel. Each property links to the specific details section further down in this page.

PropertyDefaultTypeRequiredDescription
ssh_tunnelYesConfiguration options for SSH tunnel.

Property Details​

SshTunnelOptions​

Configuration options for an SSH tunnel.

PropertyDefaultTypeRequiredDescription
descriptionstring
NoBrief description of what the model does.
metadataNoMeta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
namestringYesThe name of the model
hoststringYesBastion host to connect to.
portintegerYesPort to connect to on the bastion host.
userstringYesUsername for connecting to the bastion host.
passwordstring
NoPassword for connecting to the bastion host.
private_keystring
NoPrivate key for connecting to the bastion host.
private_key_passphrasestring
NoPassphrase for the private key, if it's encrypted.

ResourceMetadata​

Meta information of a resource. In most cases, it doesn't affect the system behavior but may be helpful to analyze Project resources.

PropertyDefaultTypeRequiredDescription
sourceNoThe origin or source information for the resource.
source_event_uuidstring
NoEvent UUID associated with creation of this resource.

ResourceLocation​

The origin or source information for the resource.

PropertyDefaultTypeRequiredDescription
pathstringYesPath within repository files where the resource is defined.
first_line_numberinteger
NoFirst line number within path file where the resource is defined.