model

Documentation

Index

• Constants
• func AddBoxSize(labels commonModel.Labels, size ResourceSize) commonModel.Labels
• func BoxLabelSelector() string
• func NewBoxLabels() commonModel.Labels
• func PortFormatPadding(ports []BoxPort) int
• func ToBoxTemplateName(boxName string) string
• func ToEnvironmentVariables(values []string) map[string]BoxEnv
• type BoxClientOptions
• type BoxDetails
• type BoxEnv
  • func SortEnv(env []BoxEnv) []BoxEnv
• type BoxInfo
• type BoxPort
  • func SortPorts(ports []BoxPort) []BoxPort
• type BoxProvider
  • func (p BoxProvider) String() string
• type BoxProviderInfo
• type BoxTemplateInfo
  • func (info *BoxTemplateInfo) IsCached() bool
• type BoxV1
  • func (box *BoxV1) EnvironmentVariableValues() []BoxEnv
  • func (box *BoxV1) EnvironmentVariables() map[string]BoxEnv
  • func (box *BoxV1) GenerateName() string
  • func (box *BoxV1) HasPorts() bool
  • func (box *BoxV1) MainContainerName() string
  • func (box *BoxV1) NetworkPortValues(includeVirtual bool) []BoxPort
  • func (box *BoxV1) NetworkPorts(includeVirtual bool) map[string]BoxPort
  • func (box *BoxV1) Pretty() string
• type CommonBoxOptions
  • func NewCommonBoxOpts() *CommonBoxOptions
• type ConnectOptions
• type CreateOptions
• type ResourceSize
  • func ExistResourceSize(value string) (ResourceSize, error)
  • func ToBoxSize(labels commonModel.Labels) (ResourceSize, error)
  • func (size ResourceSize) String() string
  • func (size ResourceSize) ToKubeResource() *kubernetes.KubeResource

Constants

const (
	BoxPrefixName = "box-"
	BoxShellNone  = "none" // distroless
	BoxPortNone   = "none" // runtime only when tunnelling

)

const (
	LabelBoxSize = "com.hckops.box.size"
)

Functions

func AddBoxSize

func AddBoxSize(labels commonModel.Labels, size ResourceSize) commonModel.Labels

func BoxLabelSelector

func BoxLabelSelector() string

func NewBoxLabels

func NewBoxLabels() commonModel.Labels

func PortFormatPadding

func PortFormatPadding(ports []BoxPort) int

func ToBoxTemplateName

func ToBoxTemplateName(boxName string) string

ToBoxTemplateName returns the strictly validated template name, or the original trimmed name

func ToEnvironmentVariables

func ToEnvironmentVariables(values []string) map[string]BoxEnv

Types

type BoxClientOptions

type BoxClientOptions struct {
	Provider   BoxProvider
	DockerOpts *commonModel.DockerOptions
	KubeOpts   *commonModel.KubeOptions
	CloudOpts  *commonModel.CloudOptions
}

type BoxDetails

type BoxDetails struct {
	Info         BoxInfo
	TemplateInfo *BoxTemplateInfo
	ProviderInfo *BoxProviderInfo
	Size         ResourceSize
	Env          []BoxEnv  // TODO map[string]BoxEnv
	Ports        []BoxPort // TODO map[string]BoxPort
	Created      time.Time
}

type BoxEnv

type BoxEnv struct {
	Key   string
	Value string
}

func SortEnv

func SortEnv(env []BoxEnv) []BoxEnv

type BoxInfo

type BoxInfo struct {
	Id      string
	Name    string
	Healthy bool // TODO BoxStatus healthy, offline, unknown, error, etc
}

type BoxPort

type BoxPort struct {
	Alias  string
	Remote string // TODO int ?
	Local  string // TODO int ?
	Public bool   // TODO
}

func SortPorts

func SortPorts(ports []BoxPort) []BoxPort

type BoxProvider

type BoxProvider string

const (
	Docker     BoxProvider = model.DockerProvider
	Kubernetes BoxProvider = model.KubernetesProvider
	Cloud      BoxProvider = model.CloudProvider
)

func (BoxProvider) String

func (p BoxProvider) String() string

type BoxProviderInfo

type BoxProviderInfo struct {
	Provider       BoxProvider
	DockerProvider *commonModel.DockerProviderInfo
	KubeProvider   *commonModel.KubeProviderInfo
}

type BoxTemplateInfo

type BoxTemplateInfo struct {
	CachedTemplate *commonModel.CachedTemplateInfo
	GitTemplate    *commonModel.GitTemplateInfo
}

func (*BoxTemplateInfo) IsCached

func (info *BoxTemplateInfo) IsCached() bool

type BoxV1

type BoxV1 struct {
	Kind    string
	Name    string
	Tags    []string
	Image   commonModel.Image
	Shell   string
	Env     []string
	Network struct {
		Ports []string
	}
}

func (*BoxV1) EnvironmentVariableValues

func (box *BoxV1) EnvironmentVariableValues() []BoxEnv

func (*BoxV1) EnvironmentVariables

func (box *BoxV1) EnvironmentVariables() map[string]BoxEnv

func (*BoxV1) GenerateName

func (box *BoxV1) GenerateName() string

func (*BoxV1) HasPorts

func (box *BoxV1) HasPorts() bool

func (*BoxV1) MainContainerName

func (box *BoxV1) MainContainerName() string

func (*BoxV1) NetworkPortValues

func (box *BoxV1) NetworkPortValues(includeVirtual bool) []BoxPort

func (*BoxV1) NetworkPorts

func (box *BoxV1) NetworkPorts(includeVirtual bool) map[string]BoxPort

TODO return error validation?

func (*BoxV1) Pretty

func (box *BoxV1) Pretty() string

type CommonBoxOptions

type CommonBoxOptions struct {
	EventBus *event.EventBus
}

func NewCommonBoxOpts

func NewCommonBoxOpts() *CommonBoxOptions

type ConnectOptions

type ConnectOptions struct {
	Template            *BoxV1
	StreamOpts          *commonModel.StreamOptions
	Name                string
	DisableExec         bool
	DisableTunnel       bool
	DeleteOnExit        bool
	OnInterruptCallback func(func())
}

type CreateOptions

type CreateOptions struct {
	Template   *BoxV1
	Labels     commonModel.Labels
	CommonInfo commonModel.CommonInfo
	Size       ResourceSize
}

type ResourceSize

type ResourceSize uint

const (
	ExtraSmall ResourceSize = iota
	Small
	Medium
	Large
	ExtraLarge
)

func ExistResourceSize

func ExistResourceSize(value string) (ResourceSize, error)

func ToBoxSize

func ToBoxSize(labels commonModel.Labels) (ResourceSize, error)

func (ResourceSize) String

func (size ResourceSize) String() string

func (ResourceSize) ToKubeResource

func (size ResourceSize) ToKubeResource() *kubernetes.KubeResource