tunnel

Opens an SSH tunnel between your local machine and the remote server on a specific port. This is useful when connecting to remote databases or other services using local tools.

tunnel does the following:

Opens a lease in port 22 for your local IP address
Fetches your SSH key from your Cloud 66 account
Starts an SSH tunnel between your machine and the server on the given ports
Closes the tunnel when you exit the Toolbelt (Ctrl-C)

If the server is behind a deployment gateway (bastion server), pass the gateway's key with --gateway-key. The tunnel then goes through your gateway to the server's private IP address. If you're using an older version of toolbelt, run cx update first.

If a role is specified the command will connect to the first server with that role.

To specify the ports for the tunnel, use --local and --remote arguments. For example, if you need to connect to a MySQL server, you can use 3307 locally and 3306 (MySQL port on the server) as the remote port. Once the tunnel is established, you can use your favourite MySQL client to connect to the server on 127.0.0.1 and the local port (3307 in this case).

If a local port is not specified, cx will use "remote + 1" as a convention for the local port. For example, if you only specify --remote 5432 without explicitly specifying local, cx will use 5433 as the local port.

This command is only supported on Linux and OS X (for Windows you can run this in a virtual machine if necessary)

$ cx tunnel --stack <application name> --server <server name> | <server IP> | <server role> --local <local port> --remote <remote port>

Options

Argument	Required?	Default	Description
`--stack, -s <application name>`	yes	—	The application name
`--server <server name> \| <server ip> \| <server role>`	either/or	—	Name or IP or role of the server to access
`-local, -l <local port>`	no	—	Local port for the tunnel
`-remote, -r <remote port>`	yes	—	Remote port for the tunnel
`--gateway-key <path to gateway key>`	only behind a gateway	—	Path to the private key for the gateway server (Rails and Deploy v2)
`--identity-file, -i <path to private key>`	no	—	Path to the private key for your own SSH access to the server

Examples

$ cx tunnel -s mystack --server lion --local 3307 --remote 3306
$ cx tunnel -s mystack --server 52.65.34.98 --local 3307 --remote 3306
$ cx tunnel -s mystack --server web -l 3307 -r 3306

Reach the Kubernetes API of a cluster behind a gateway, for use with the kubeconfig file you download for the cluster:

$ cx tunnel -s mycluster --server kubes_master --gateway-key ~/.ssh/bastion_key -l 6443 -r 6443