boxpkg

Documentation

Index

• Constants
• Variables
• func GenerateConnectionScript(clusterConfig *fileclient.TeamClusterConfig) (string, error)
• type BoxClient
  • func NewClient(cmd *cobra.Command, args []string) (BoxClient, error)
• type Cntr
• type ContState
• type Container
• type ContainerConfig
• type ProxyConfig
  • func (c *ProxyConfig) GetHash() string

Constants

const (
	// CONTAINER_PORT = "1729"
	VpnImageName = "linuxserver/wireguard:latest"

	CONT_PATH_KEY           = "kl.container.path"
	CONT_NAME_KEY           = "kl.container.name"
	CONT_MARK_KEY           = "kl.container"
	CONT_VPN_MARK_KEY       = "kl.container.vpn"
	CONT_WORKSPACE_MARK_KEY = "kl.container.workspace"
	SSH_PORT_KEY            = "kl.container.ssh.port"
	KLCONFIG_HASH_KEY       = "kl.container.klconfig.hash"
)

const (
	NO_RUNNING_CONTAINERS = "no container running"
)

Variables

var NotFoundErr = functions.Error("container not found")

var UserCanceled = fn.Errorf("user canceled")

Functions

func GenerateConnectionScript

func GenerateConnectionScript(clusterConfig *fileclient.TeamClusterConfig) (string, error)

Types

type BoxClient

type BoxClient interface {
	SyncProxy(config ProxyConfig) error
	Stop() error
	Restart() error
	Start() error
	Ssh() error
	Reload() error
	PrintBoxes([]Cntr) error
	ListAllBoxes() ([]Cntr, error)
	Info() error
	Exec([]string, io.Writer) error

	ConfirmBoxRestart() error
	StartWgContainer() error
}

func NewClient

func NewClient(cmd *cobra.Command, args []string) (BoxClient, error)

type Cntr

type Cntr struct {
	Name   string
	Labels map[string]string
	State  ContState
}

type ContState

type ContState string

const (
	ContStateExited  ContState = "exited"
	ContStateCreated ContState = "created"
)

type Container

type Container struct {
	Name string
	Path string
}

type ContainerConfig

type ContainerConfig struct {
	Name string
	// contains filtered or unexported fields
}

type ProxyConfig

type ProxyConfig struct {
	// TargetContainerId   string
	TargetContainerPath string
	ExposedPorts        []int
}

func (*ProxyConfig) GetHash

func (c *ProxyConfig) GetHash() string