types

Documentation

Overview

Package types contains launchr common types.

Index

• type BuildDefinition
  • func (b *BuildDefinition) ImageBuildInfo(name string, cwd string) *BuildDefinition
  • func (b *BuildDefinition) UnmarshalYAML(n *yaml.Node) (err error)
• type ContainerAttachOptions
• type ContainerCreateOptions
• type ContainerListOptions
• type ContainerListResult
• type ContainerPathStat
• type ContainerRemoveOptions
• type ContainerStartOptions
• type ContainerStopOptions
• type ContainerWaitOptions
• type ContainerWaitResponse
• type CopyToContainerOptions
• type ImageOptions
• type ImageRemoveOptions
• type ImageRemoveResponse
• type ImageStatus
• type ImageStatusResponse
• type NetworkMode
• type ResizeOptions
• type WaitCondition

Types

type BuildDefinition

type BuildDefinition struct {
	Context   string             `yaml:"context"`
	Buildfile string             `yaml:"buildfile"`
	Args      map[string]*string `yaml:"args"`
	Tags      []string           `yaml:"tags"`
}

BuildDefinition stores image build definition.

func (*BuildDefinition) ImageBuildInfo

func (b *BuildDefinition) ImageBuildInfo(name string, cwd string) *BuildDefinition

ImageBuildInfo preprocesses build info to be ready for a container build.

func (*BuildDefinition) UnmarshalYAML

func (b *BuildDefinition) UnmarshalYAML(n *yaml.Node) (err error)

UnmarshalYAML implements yaml.Unmarshaler to parse build options from a string or a struct.

type ContainerAttachOptions

type ContainerAttachOptions = types.ContainerAttachOptions

ContainerAttachOptions stores options for attaching to a running container.

type ContainerCreateOptions

type ContainerCreateOptions struct {
	Hostname      string
	ContainerName string
	Image         string
	Cmd           []string
	WorkingDir    string
	Binds         []string
	Volumes       map[string]struct{}
	NetworkMode   NetworkMode
	ExtraHosts    []string
	AutoRemove    bool
	OpenStdin     bool
	StdinOnce     bool
	AttachStdin   bool
	AttachStdout  bool
	AttachStderr  bool
	Tty           bool
	Env           []string
	User          string
}

ContainerCreateOptions stores options for creating a new container.

type ContainerListOptions

type ContainerListOptions struct {
	SearchName string
}

ContainerListOptions stores options to request container list.

type ContainerListResult

type ContainerListResult struct {
	ID     string
	Names  []string
	Status string
}

ContainerListResult defines container list result.

type ContainerPathStat

type ContainerPathStat = types.ContainerPathStat

ContainerPathStat is a type alias for container path stat result.

type ContainerRemoveOptions

type ContainerRemoveOptions = types.ContainerRemoveOptions

ContainerRemoveOptions stores options to remove a container.

type ContainerStartOptions

type ContainerStartOptions struct {
}

ContainerStartOptions stores options for starting a container.

type ContainerStopOptions

type ContainerStopOptions struct {
	Timeout *time.Duration
}

ContainerStopOptions stores options to stop a container.

type ContainerWaitOptions

type ContainerWaitOptions struct {
	Condition WaitCondition
}

ContainerWaitOptions stores options for waiting while container works.

type ContainerWaitResponse

type ContainerWaitResponse struct {
	StatusCode int
	Error      error
}

ContainerWaitResponse stores response given by wait result.

type CopyToContainerOptions

type CopyToContainerOptions = types.CopyToContainerOptions

CopyToContainerOptions is a type alias for container copy to container options.

type ImageOptions

type ImageOptions struct {
	Name  string
	Build *BuildDefinition
}

ImageOptions stores options for creating/pulling an image.

type ImageRemoveOptions

type ImageRemoveOptions = types.ImageRemoveOptions

ImageRemoveOptions stores options for removing an image.

type ImageRemoveResponse

type ImageRemoveResponse struct {
	Status ImageStatus
}

ImageRemoveResponse stores response when removing the image.

type ImageStatus

type ImageStatus int64

ImageStatus defines image status on local machine.

const (
	ImageExists          ImageStatus = iota // ImageExists - image exists locally.
	ImageUnexpectedError                    // ImageUnexpectedError - image can't be pulled or retrieved.
	ImagePull                               // ImagePull - image is being pulled from the registry.
	ImageBuild                              // ImageBuild - image is being built.
	ImageRemoved                            // ImageRemoved - image was removed
)

type ImageStatusResponse

type ImageStatusResponse struct {
	Status   ImageStatus
	Progress io.ReadCloser
}

ImageStatusResponse stores response when getting the image.

type NetworkMode

type NetworkMode = typescontainer.NetworkMode

NetworkMode is a type alias for container Network mode.

const (
	NetworkModeHost NetworkMode = "host" // NetworkModeHost for host network.
)

type ResizeOptions

type ResizeOptions = types.ResizeOptions

ResizeOptions is a struct for terminal resizing.

type WaitCondition

type WaitCondition = typescontainer.WaitCondition

WaitCondition is a type for available wait conditions.

const (
	WaitConditionNotRunning WaitCondition = typescontainer.WaitConditionNotRunning // WaitConditionNotRunning when container exits when running.
	WaitConditionNextExit   WaitCondition = typescontainer.WaitConditionNextExit   // WaitConditionNextExit when container exits after next start.
	WaitConditionRemoved    WaitCondition = typescontainer.WaitConditionRemoved    // WaitConditionRemoved when container is removed.
)