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_configuration.yaml

ssh_tunnel:
  host: example-bastion-host.com
  port: 22
  user: example-user
  private_key: ${secret.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.

Property	Default	Type	Required	Description
ssh_tunnel		SshTunnelOptions	Yes	Configuration options for the SSH tunnel.

Property Details

SshTunnelOptions

Configuration options for an SSH tunnel.

Property	Default	Type	Required	Description
name		string	No	The name of the model
description		string	No	A brief description of what the model does.
metadata		ResourceMetadata	No	Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
host		string	Yes	The bastion host to connect to.
port		integer	Yes	The port to connect to on the bastion host.
user		string	Yes	The username to use when connecting to the bastion host.
password		string	No	The password to use when connecting to the bastion host.
private_key		string	No	The private key to use when connecting to the bastion host.
private_key_passphrase		string	No	The passphrase 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.

Property	Default	Type	Required	Description
source		ResourceLocation	No	The origin or source information for the resource.
source_event_uuid		string	No	UUID of the event that is associated with creation of this resource.

ResourceLocation

The origin or source information for the resource.

Property	Default	Type	Required	Description
path		string	Yes	Path within repository files where the resource is defined.
first_line_number		integer	No	First line number within path file where the resource is defined.