tunnel

Documentation

Overview

Package tunnel provides the functions used by the CLI to tunnel into a container using either a tunneled connection from the workspace client (using a machine provider) or a direct SSH connection from the proxy client (Ssh, k8s or docker provider)

Index

• func NewTunnel(ctx context.Context, tunnel Tunnel, handler Handler) error
• func RunServices(ctx context.Context, devPodConfig *config.Config, containerClient *ssh.Client, ...) error
• type ContainerTunnel
  • func NewContainerTunnel(client client.WorkspaceClient, proxy bool, log log.Logger) *ContainerTunnel
  • func (c *ContainerTunnel) Run(ctx context.Context, handler Handler, cfg *config.Config, ...) error
• type Handler
• type Tunnel

Functions

func NewTunnel

func NewTunnel(ctx context.Context, tunnel Tunnel, handler Handler) error

NewTunnel creates a tunnel to the devcontainer using generic functions to establish the "outer" and "inner" tunnel, used by proxy clients Here the tunnel will be an SSH connection with it's STDIO as arguments and the handler will be the function to execute the command using the connected SSH client.

func RunServices

func RunServices(
	ctx context.Context,
	devPodConfig *config.Config,
	containerClient *ssh.Client,
	user string,
	forwardPorts bool,
	extraPorts []string,
	gitUsername,
	gitToken string,
	workspace *provider.Workspace,
	log log.Logger,
) error

RunServices forwards the ports for a given workspace and uses it's SSH client to run the credentials server remotely and the services server locally to communicate with the container

Types

type ContainerTunnel

type ContainerTunnel struct {
	// contains filtered or unexported fields
}

ContainerTunnel manages the state of the tunnel to the container

func NewContainerTunnel

func NewContainerTunnel(client client.WorkspaceClient, proxy bool, log log.Logger) *ContainerTunnel

NewContainerTunnel constructs a ContainerTunnel using the workspace client, if proxy is True then the workspace's agent config is not periodically updated

func (*ContainerTunnel) Run

func (c *ContainerTunnel) Run(ctx context.Context, handler Handler, cfg *config.Config, envVars map[string]string) error

Run creates an "outer" tunnel to the host to start the SSH server so that the "inner" tunnel can connect to the container over SSH

type Handler

type Handler func(ctx context.Context, containerClient *ssh.Client) error

Handler defines what to do once the tunnel has a client established

type Tunnel

type Tunnel func(ctx context.Context, stdin io.Reader, stdout io.Writer) error

Tunnel defines the function to create an "outer" tunnel