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 ClassifyTunnelErrors(tunnelErr, handlerErr error) error
- func CreateSSHCommand(ctx context.Context, client client2.BaseWorkspaceClient, extraArgs []string) (*exec.Cmd, error)
- func IsEOF(err error) bool
- func NewTunnel(ctx context.Context, tunnel Tunnel, handler Handler) error
- func RunServices(ctx context.Context, opts RunServicesOptions) error
- func SetupBackhaul(ctx context.Context, client client2.BaseWorkspaceClient, authSockID string) error
- func StartBrowserTunnel(p BrowserTunnelParams) error
- type BrowserTunnelParams
- type ContainerTunnel
- type ErrorKind
- type Handler
- type HandlerFunc
- type PipeBridge
- type PortAttributeResolver
- type RunServicesOptions
- type Tunnel
- type TunnelFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ClassifyTunnelErrors ¶ added in v1.1.0
func CreateSSHCommand ¶
func CreateSSHCommand( ctx context.Context, client client2.BaseWorkspaceClient, extraArgs []string, ) (*exec.Cmd, error)
CreateSSHCommand builds an exec.Cmd that runs `devsy ssh` with the given arguments.
func NewTunnel ¶
NewTunnel creates a tunnel to the devcontainer using generic functions to establish the "outer" and "inner" tunnel, used by proxy clients. The tunnel will be an SSH connection with its 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, opts RunServicesOptions) error
RunServices forwards the ports for a given workspace and uses its SSH client to run the credentials server remotely and the services server locally to communicate with the container.
func SetupBackhaul ¶
func SetupBackhaul( ctx context.Context, client client2.BaseWorkspaceClient, authSockID string, ) error
SetupBackhaul sets up a long-running SSH connection for backhaul.
func StartBrowserTunnel ¶
func StartBrowserTunnel(p BrowserTunnelParams) error
StartBrowserTunnel sets up a browser tunnel for IDE access, either via daemon or SSH.
Types ¶
type BrowserTunnelParams ¶
type BrowserTunnelParams struct {
Ctx context.Context
DevsyConfig *config.Config
Client client2.BaseWorkspaceClient
User string
TargetURL string
ForwardPorts bool
ExtraPorts []string
AuthSockID string
GitSSHSigningKey string
// DaemonStartFunc is called when the client is a DaemonClient.
// If nil, the SSH tunnel path is always used.
DaemonStartFunc func(ctx context.Context) error
}
BrowserTunnelParams bundles the arguments for browser-based IDE tunnels.
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) *ContainerTunnel
NewContainerTunnel constructs a ContainerTunnel using the workspace client, if proxy is True then the workspace's agent config is not periodically updated.
type HandlerFunc ¶ added in v1.1.0
type PipeBridge ¶ added in v1.1.0
type PipeBridge struct {
StdoutReader *os.File
StdoutWriter *os.File
StdinReader *os.File
StdinWriter *os.File
}
func NewPipeBridge ¶ added in v1.1.0
func NewPipeBridge() (*PipeBridge, error)
func (*PipeBridge) Close ¶ added in v1.1.0
func (pb *PipeBridge) Close()
func (*PipeBridge) RunPair ¶ added in v1.1.0
func (pb *PipeBridge) RunPair( ctx context.Context, tunnelFn TunnelFunc, handlerFn HandlerFunc, ) error
type PortAttributeResolver ¶ added in v1.1.0
type PortAttributeResolver func(port string) config2.PortAttribute
PortAttributeResolver resolves port attributes for a given port string.
func NewPortAttributeResolver ¶ added in v1.1.0
func NewPortAttributeResolver( portsAttrs map[string]config2.PortAttribute, fallback *config2.PortAttribute, ) PortAttributeResolver
NewPortAttributeResolver builds a resolver from the devcontainer config.
type RunServicesOptions ¶
type RunServicesOptions struct {
DevsyConfig *config.Config
ContainerClient *ssh.Client
User string
ForwardPorts bool
ExtraPorts []string
PlatformOptions *devsy.PlatformOptions
Workspace *provider.Workspace
ConfigureDockerCredentials bool
ConfigureGitCredentials bool
ConfigureGitSSHSignatureHelper bool
GitSSHSigningKey string
}
RunServicesOptions contains all options for running services.
Source Files