drivers

Documentation

Overview

Package drivers implements Backplane drivers (e.g Docker, Kubernetes, etc.)

Index

• func ForwardTCP(stopCh <-chan struct{}, cname string, localPort, remotePort int) error
• type Driver
  • func GetDriver(driver string) (Driver, error)
• type Option
  • func WithArgs(args ...string) Option

Functions

func ForwardTCP

func ForwardTCP(
	stopCh <-chan struct{},
	cname string,
	localPort, remotePort int,
) error

ForwardTCP forwards locaPort on host to a remotePort on a container cname.

Types

type Driver

type Driver interface {
	// Deploy deploys the proxy.
	Start(ctx context.Context, orgID uuid.UUID, proxyName string, opts ...Option) (string, error)
}

func GetDriver

func GetDriver(driver string) (Driver, error)

GetDriver returns a driver by name.

type Option

type Option func(*options)

func WithArgs

func WithArgs(args ...string) Option

WithArgs sets the arguments for the driver.