model

Documentation

Index

• Constants
• type CachedTemplateInfo
• type CloudOptions
• type CommonInfo
• type DockerOptions
• type DockerProviderInfo
• type GitTemplateInfo
• type Image
  • func (image *Image) Name() string
  • func (image *Image) ResolveVersion() string
• type KubeOptions
• type KubeProviderInfo
• type Labels
  • func NewSidecarLabels() Labels
  • func (l Labels) AddDefaultGit(url, revision, dir string) Labels
  • func (l Labels) AddDefaultLocal() Labels
  • func (l Labels) AddGit(path string, commit string) Labels
  • func (l Labels) AddLabel(key string, value string) Labels
  • func (l Labels) AddLabels(labels Labels) Labels
  • func (l Labels) AddLocal(path string) Labels
  • func (l Labels) AddSidecarMain(containerName string) Labels
  • func (l Labels) Exist(name string) (string, error)
  • func (l Labels) ToCachedTemplateInfo() *CachedTemplateInfo
  • func (l Labels) ToGitTemplateInfo() *GitTemplateInfo
• type NetworkVpnInfo
• type Parameters
• type ShareDirInfo
• type SidecarInfo
• type SidecarShareInjectOpts
• type SidecarShareUploadOpts
• type SidecarVpnInjectOpts
• type StreamOptions
  • func NewStdStreamOpts(tty bool) *StreamOptions

Constants

const (
	DockerProvider     = "docker"
	KubernetesProvider = "kube"
	CloudProvider      = "cloud"

	SidecarPrefixName             = "sidecar-"
	SidecarVpnImageName           = "hckops/alpine-openvpn:latest"
	SidecarVpnPrivilegedImageName = "hckops/alpine-openvpn-privileged:latest"
	SidecarShareImageName         = "busybox"
	SidecarShareDir               = "/hck/share"
)

const (
	LabelSchemaKind          = "com.hckops.schema.kind"
	LabelTemplateLocal       = "com.hckops.template.local"
	LabelTemplateRemote      = "com.hckops.template.remote" // TODO not used
	LabelTemplateGit         = "com.hckops.template.git"
	LabelTemplateGitUrl      = "com.hckops.template.git.url"
	LabelTemplateGitRevision = "com.hckops.template.git.revision"
	LabelTemplateGitCommit   = "com.hckops.template.git.commit"
	LabelTemplateGitDir      = "com.hckops.template.git.dir"
	LabelTemplateGitName     = "com.hckops.template.git.name"
	LabelTemplateCachePath   = "com.hckops.template.cache.path"
	LabelSidecarMain         = "com.hckops.sidecar.main"
)

Types

type CachedTemplateInfo

type CachedTemplateInfo struct {
	Path string
}

type CloudOptions

type CloudOptions struct {
	Version  string
	Address  string
	Username string
	Token    string
}

type CommonInfo

type CommonInfo struct {
	NetworkVpn *NetworkVpnInfo
	ShareDir   *ShareDirInfo
}

type DockerOptions

type DockerOptions struct {
	NetworkName          string
	IgnoreImagePullError bool
}

type DockerProviderInfo

type DockerProviderInfo struct {
	Network string
	Ip      string
}

type GitTemplateInfo

type GitTemplateInfo struct {
	Url      string
	Revision string
	Commit   string
	Name     string
}

type Image

type Image struct {
	Repository string
	Version    string
}

func (*Image) Name

func (image *Image) Name() string

func (*Image) ResolveVersion

func (image *Image) ResolveVersion() string

type KubeOptions

type KubeOptions struct {
	InCluster  bool
	ConfigPath string
	Namespace  string
}

type KubeProviderInfo

type KubeProviderInfo struct {
	Namespace string
}

type Labels

type Labels map[string]string

func NewSidecarLabels

func NewSidecarLabels() Labels

func (Labels) AddDefaultGit

func (l Labels) AddDefaultGit(url, revision, dir string) Labels

func (Labels) AddDefaultLocal

func (l Labels) AddDefaultLocal() Labels

func (Labels) AddGit

func (l Labels) AddGit(path string, commit string) Labels

func (Labels) AddLabel

func (l Labels) AddLabel(key string, value string) Labels

func (Labels) AddLabels

func (l Labels) AddLabels(labels Labels) Labels

func (Labels) AddLocal

func (l Labels) AddLocal(path string) Labels

func (Labels) AddSidecarMain

func (l Labels) AddSidecarMain(containerName string) Labels

func (Labels) Exist

func (l Labels) Exist(name string) (string, error)

func (Labels) ToCachedTemplateInfo

func (l Labels) ToCachedTemplateInfo() *CachedTemplateInfo

func (Labels) ToGitTemplateInfo

func (l Labels) ToGitTemplateInfo() *GitTemplateInfo

type NetworkVpnInfo

type NetworkVpnInfo struct {
	Name        string
	LocalPath   string
	ConfigValue string
	Privileged  bool
}

type Parameters

type Parameters map[string]string

type ShareDirInfo

type ShareDirInfo struct {
	LocalPath  string
	RemotePath string
	LockDir    bool
}

type SidecarInfo

type SidecarInfo struct {
	Id   string
	Name string
}

type SidecarShareInjectOpts

type SidecarShareInjectOpts struct {
	MainContainerName string
	ShareDir          *ShareDirInfo
}

type SidecarShareUploadOpts

type SidecarShareUploadOpts struct {
	Namespace string
	PodName   string
	ShareDir  *ShareDirInfo
}

type SidecarVpnInjectOpts

type SidecarVpnInjectOpts struct {
	Name       string // containerName for docker and podName for kube
	NetworkVpn *NetworkVpnInfo
}

type StreamOptions

type StreamOptions struct {
	In    io.ReadCloser
	Out   io.Writer
	Err   io.Writer
	IsTty bool // tty is false for ssh tunnel or logs
}

func NewStdStreamOpts

func NewStdStreamOpts(tty bool) *StreamOptions