types

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 22, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package types contains launchr common types.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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) BuildImageInfo

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

BuildImageInfo 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 struct {
	AttachStdin  bool
	AttachStdout bool
	AttachStderr bool
	Tty          bool
}

ContainerAttachOptions stores options for attaching to a running container.

type ContainerCreateOptions

type ContainerCreateOptions struct {
	ContainerName string
	Image         string
	Cmd           []string
	WorkingDir    string
	Mounts        map[string]string
	ExtraHosts    []string
	AutoRemove    bool
	OpenStdin     bool
	StdinOnce     bool
	AttachStdin   bool
	AttachStdout  bool
	AttachStderr  bool
	Tty           bool
	Env           []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 ContainerRemoveOptions

type ContainerRemoveOptions struct {
}

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 ImageOptions

type ImageOptions struct {
	Name  string
	Build *BuildDefinition
}

ImageOptions stores options for creating/pulling an 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.
)

type ImageStatusResponse

type ImageStatusResponse struct {
	Status   ImageStatus
	Progress io.ReadCloser
}

ImageStatusResponse stores response when getting the image.

type ResizeOptions

type ResizeOptions struct {
	Height uint
	Width  uint
}

ResizeOptions is a struct for terminal resizing.

type WaitCondition

type WaitCondition string

WaitCondition is a type for available wait conditions.

const (
	WaitConditionNotRunning WaitCondition = "not-running" // WaitConditionNotRunning when container exits when running.
	WaitConditionNextExit   WaitCondition = "next-exit"   // WaitConditionNextExit when container exits after next start.
	WaitConditionRemoved    WaitCondition = "removed"     // WaitConditionRemoved when container is removed.
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL