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: ${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.

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

Property Details

SshTunnelOptions

Configuration options for an SSH tunnel.

Property	Default	Type	Required	Description
description		string	No	Brief description of what the model does.
metadata			No	Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
name		string	Yes	The name of the model
host		string	Yes	Bastion host to connect to.
port		integer	Yes	Port to connect to on the bastion host.
user		string	Yes	Username for connecting to the bastion host.
password		string	No	Password for connecting to the bastion host.
private_key		string	No	Private key for connecting to the bastion host.
private_key_passphrase		string	No	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			No	The origin or source information for the resource.
source_event_uuid		string	No	Event UUID 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.