tunnelserver

package

v1.3.0-rc.21 Latest Latest Go to latest Published: May 19, 2026 License: MPL-2.0 Imports: 32 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/devsy-org/devsy

Links

Open Source Insights

Documentation ¶

Index ¶

func New(options ...Option) *tunnelServer
func NewStreamReader(stream tunnel.Tunnel_StreamWorkspaceClient) io.Reader
func NewStreamWriter(stream tunnel.Tunnel_StreamWorkspaceServer) io.Writer
func NewTunnelClient(reader io.Reader, writer io.WriteCloser, exitOnClose bool, exitCode int) (tunnel.TunnelClient, error)
func RunServicesServer(ctx context.Context, reader io.Reader, writer io.WriteCloser, ...) error
func RunSetupServer(ctx context.Context, reader io.Reader, writer io.WriteCloser, ...) (*config.Result, error)
func RunUpServer(ctx context.Context, reader io.Reader, writer io.WriteCloser, ...) (*config.Result, error)
type Logger
- func NewTunnelLogger(ctx context.Context, client tunnel.TunnelClient, debug bool) Logger
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(options ...Option) *tunnelServer

func NewStreamReader ¶

func NewStreamReader(stream tunnel.Tunnel_StreamWorkspaceClient) io.Reader

func NewStreamWriter ¶

func NewStreamWriter(stream tunnel.Tunnel_StreamWorkspaceServer) io.Writer

func NewTunnelClient ¶

func NewTunnelClient(
	reader io.Reader,
	writer io.WriteCloser,
	exitOnClose bool,
	exitCode int,
) (tunnel.TunnelClient, error)

func RunServicesServer ¶

func RunServicesServer(
	ctx context.Context,
	reader io.Reader,
	writer io.WriteCloser,
	allowGitCredentials, allowDockerCredentials bool,
	forwarder netstat.Forwarder,
	workspace *provider2.Workspace,
	options ...Option,
) error

func RunSetupServer ¶

func RunSetupServer(
	ctx context.Context,
	reader io.Reader,
	writer io.WriteCloser,
	allowGitCredentials, allowDockerCredentials bool,
	mounts []*config.Mount,
	options ...Option,
) (*config.Result, error)

func RunUpServer ¶

func RunUpServer(
	ctx context.Context,
	reader io.Reader,
	writer io.WriteCloser,
	allowGitCredentials, allowDockerCredentials bool,
	workspace *provider2.Workspace,
	options ...Option,
) (*config.Result, error)

Types ¶

type Logger ¶ added in v1.1.0

type Logger interface {
	Debugf(format string, args ...any)
	Info(args ...any)
	Infof(format string, args ...any)
	Warnf(format string, args ...any)
}

Logger is the minimal logging interface used by workspace initialization. It is implemented by tunnelLogger, which sends log messages through the tunnel protocol back to the client.

func NewTunnelLogger ¶

func NewTunnelLogger(ctx context.Context, client tunnel.TunnelClient, debug bool) Logger

type Option ¶

type Option func(*tunnelServer) *tunnelServer

func WithAllowDockerCredentials ¶

func WithAllowDockerCredentials(allowDockerCredentials bool) Option

func WithAllowGitCredentials ¶

func WithAllowGitCredentials(allowGitCredentials bool) Option

func WithAllowKubeConfig ¶

func WithAllowKubeConfig(allow bool) Option

func WithForwarder ¶

func WithForwarder(forwarder netstat.Forwarder) Option

func WithMounts ¶

func WithMounts(mounts []*config.Mount) Option

func WithPlatformOptions ¶

func WithPlatformOptions(options *devsy.PlatformOptions) Option

func WithWorkspace ¶

func WithWorkspace(workspace *provider2.Workspace) Option

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL