image

package
v1.1.0-alpha.4 Latest Latest
Warning

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

 Go to latest Published: Feb 4, 2020 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	WerfLabel               = "werf"
	WerfVersionLabel        = "werf-version"
	WerfCacheVersionLabel   = "werf-cache-version"
	WerfImageLabel          = "werf-image"
	WerfImageNameLabel      = "werf-image-name"
	WerfImageTagLabel       = "werf-image-tag"
	WerfDockerImageName     = "werf-docker-image-name"
	WerfStageSignatureLabel = "werf-stage-signature"

	WerfMountTmpDirLabel          = "werf-mount-type-tmp-dir"
	WerfMountBuildDirLabel        = "werf-mount-type-build-dir"
	WerfMountCustomDirLabelPrefix = "werf-mount-type-custom-dir-"

	WerfImportLabelPrefix = "werf-import-"

	WerfTagStrategyLabel = "werf-tag-strategy"

	BuildCacheVersion = "1"

	StageContainerNamePrefix = "werf.build."

	LocalImageStageImageNamePrefix = "werf-stages-storage/"
	LocalImageStageImageNameFormat = "werf-stages-storage/%s"
	LocalImageStageImageFormat     = "werf-stages-storage/%s:%s-%s"

	RepoImageStageTagFormat = "image-stage-%s"
)

Variables

This section is empty.

Functions

func ContainerLockName 

func ContainerLockName(containerName string) string

func ImageLockName 

func ImageLockName(imageName string) string

func IsStartContainerErr 

func IsStartContainerErr(err error) bool

https://docs.docker.com/engine/reference/run/#exit-status

func ShelloutPack 

func ShelloutPack(command string) string

Types

type BuildOptions 

type BuildOptions struct {
	IntrospectBeforeError bool
	IntrospectAfterError  bool
}

type BuilderContainer 

type BuilderContainer interface {
	AddServiceRunCommands(commands ...string)
	AddRunCommands(commands ...string)

	AddVolume(volumes ...string)
	AddVolumeFrom(volumesFrom ...string)
	AddExpose(exposes ...string)
	AddEnv(envs map[string]string)
	AddLabel(labels map[string]string)
}

type Container 

type Container interface {
	Name() string

	UserRunCommands() []string
	UserCommitChanges() []string

	AddServiceRunCommands(commands ...string)
	AddRunCommands(commands ...string)

	RunOptions() ContainerOptions
	CommitChangeOptions() ContainerOptions
	ServiceCommitChangeOptions() ContainerOptions
}

type ContainerOptions 

type ContainerOptions interface {
	AddVolume(volumes ...string)
	AddVolumeFrom(volumesFrom ...string)
	AddExpose(exposes ...string)
	AddEnv(envs map[string]string)
	AddLabel(labels map[string]string)
	AddCmd(cmd string)
	AddWorkdir(workdir string)
	AddUser(user string)
	AddEntrypoint(entrypoint string)
	AddHealthCheck(check string)
}

type DockerfileImageBuilder added in v1.1.0 

type DockerfileImageBuilder struct {
	BuildArgs []string
	// contains filtered or unexported fields
}

func NewDockerfileImageBuilder added in v1.1.0 

func NewDockerfileImageBuilder() *DockerfileImageBuilder

func (*DockerfileImageBuilder) AppendBuildArgs added in v1.1.0 

func (b *DockerfileImageBuilder) AppendBuildArgs(buildArgs ...string)

func (*DockerfileImageBuilder) Build added in v1.1.0 

func (b *DockerfileImageBuilder) Build() error

func (*DockerfileImageBuilder) Cleanup added in v1.1.0 

func (b *DockerfileImageBuilder) Cleanup() error

func (*DockerfileImageBuilder) GetBuiltId added in v1.1.0 

func (b *DockerfileImageBuilder) GetBuiltId() (string, error)

type Image 

type Image struct {
	*StageImage
}

func NewImage 

func NewImage(fromImage *StageImage, name string) *Image

func (*Image) Export 

func (i *Image) Export() error

func (Image) GetInspect 

func (i Image) GetInspect() (*types.ImageInspect, error)

func (Image) Name 

func (i Image) Name() string

func (Image) ResetInspect 

func (i Image) ResetInspect() error

func (Image) SetName added in v1.1.0 

func (i Image) SetName(name string)

func (*Image) Tag 

func (i *Image) Tag() error

func (Image) Untag 

func (i Image) Untag() error

type ImageInterface 

type ImageInterface interface {
	Name() string
	SetName(name string)
	Inspect() *types.ImageInspect
	Labels() map[string]string
	ID() string

	IsExists() bool

	SyncDockerState() error

	Pull() error
	Untag() error

	// TODO: build specifics for stapel builder and dockerfile builder
	// TODO: should be under a single separate interface
	Container() Container
	BuilderContainer() BuilderContainer
	DockerfileImageBuilder() *DockerfileImageBuilder

	Build(BuildOptions) error
	GetBuiltId() (string, error)
	TagBuiltImage(name string) error

	Introspect() error
}

type StageImage 

type StageImage struct {
	// contains filtered or unexported fields
}

func NewStageImage 

func NewStageImage(fromImage *StageImage, name string) *StageImage

func (*StageImage) Build 

func (i *StageImage) Build(options BuildOptions) error

func (*StageImage) BuilderContainer 

func (i *StageImage) BuilderContainer() BuilderContainer

func (*StageImage) Commit 

func (i *StageImage) Commit() error

func (*StageImage) Container 

func (i *StageImage) Container() Container

func (*StageImage) DockerfileImageBuilder added in v1.1.0 

func (i *StageImage) DockerfileImageBuilder() *DockerfileImageBuilder

func (*StageImage) Export 

func (i *StageImage) Export(name string) error

func (*StageImage) GetBuiltId added in v1.1.0 

func (i *StageImage) GetBuiltId() (string, error)

func (StageImage) GetInspect 

func (i StageImage) GetInspect() (*types.ImageInspect, error)

func (*StageImage) ID 

func (i *StageImage) ID() string

func (*StageImage) Import 

func (i *StageImage) Import(name string) error

func (*StageImage) Inspect 

func (i *StageImage) Inspect() *types.ImageInspect

func (*StageImage) Introspect 

func (i *StageImage) Introspect() error

func (*StageImage) IsExists 

func (i *StageImage) IsExists() bool

func (*StageImage) Labels 

func (i *StageImage) Labels() map[string]string

func (*StageImage) MustGetId 

func (i *StageImage) MustGetId() (string, error)

func (*StageImage) MustGetInspect 

func (i *StageImage) MustGetInspect() (*types.ImageInspect, error)

func (StageImage) Name 

func (i StageImage) Name() string

func (*StageImage) Pull 

func (i *StageImage) Pull() error

func (*StageImage) Push 

func (i *StageImage) Push() error

func (StageImage) ResetInspect 

func (i StageImage) ResetInspect() error

func (StageImage) SetName added in v1.1.0 

func (i StageImage) SetName(name string)

func (*StageImage) SyncDockerState 

func (i *StageImage) SyncDockerState() error

func (*StageImage) Tag 

func (i *StageImage) Tag(name string) error

func (*StageImage) TagBuiltImage added in v1.1.0 

func (i *StageImage) TagBuiltImage(name string) error

func (StageImage) Untag 

func (i StageImage) Untag() error

type StageImageBuilderContainer 

type StageImageBuilderContainer struct {
	// contains filtered or unexported fields
}

func (*StageImageBuilderContainer) AddEnv 

func (c *StageImageBuilderContainer) AddEnv(envs map[string]string)

func (*StageImageBuilderContainer) AddExpose 

func (c *StageImageBuilderContainer) AddExpose(exposes ...string)

func (*StageImageBuilderContainer) AddLabel 

func (c *StageImageBuilderContainer) AddLabel(labels map[string]string)

func (*StageImageBuilderContainer) AddRunCommands 

func (c *StageImageBuilderContainer) AddRunCommands(commands ...string)

func (*StageImageBuilderContainer) AddServiceRunCommands 

func (c *StageImageBuilderContainer) AddServiceRunCommands(commands ...string)

func (*StageImageBuilderContainer) AddVolume 

func (c *StageImageBuilderContainer) AddVolume(volumes ...string)

func (*StageImageBuilderContainer) AddVolumeFrom 

func (c *StageImageBuilderContainer) AddVolumeFrom(volumesFrom ...string)

type StageImageContainer 

type StageImageContainer struct {
	// contains filtered or unexported fields
}

func (*StageImageContainer) AddRunCommands 

func (c *StageImageContainer) AddRunCommands(commands ...string)

func (*StageImageContainer) AddServiceRunCommands 

func (c *StageImageContainer) AddServiceRunCommands(commands ...string)

func (*StageImageContainer) CommitChangeOptions 

func (c *StageImageContainer) CommitChangeOptions() ContainerOptions

func (*StageImageContainer) Name 

func (c *StageImageContainer) Name() string

func (*StageImageContainer) RunOptions 

func (c *StageImageContainer) RunOptions() ContainerOptions

func (*StageImageContainer) ServiceCommitChangeOptions 

func (c *StageImageContainer) ServiceCommitChangeOptions() ContainerOptions

func (*StageImageContainer) UserCommitChanges 

func (c *StageImageContainer) UserCommitChanges() []string

func (*StageImageContainer) UserRunCommands 

func (c *StageImageContainer) UserRunCommands() []string

type StageImageContainerOptions 

type StageImageContainerOptions struct {
	Volume      []string
	VolumesFrom []string
	Expose      []string
	Env         map[string]string
	Label       map[string]string
	Cmd         string
	Workdir     string
	User        string
	Entrypoint  string
	HealthCheck string
}

func (*StageImageContainerOptions) AddCmd 

func (co *StageImageContainerOptions) AddCmd(cmd string)

func (*StageImageContainerOptions) AddEntrypoint 

func (co *StageImageContainerOptions) AddEntrypoint(entrypoint string)

func (*StageImageContainerOptions) AddEnv 

func (co *StageImageContainerOptions) AddEnv(envs map[string]string)

func (*StageImageContainerOptions) AddExpose 

func (co *StageImageContainerOptions) AddExpose(exposes ...string)

func (*StageImageContainerOptions) AddHealthCheck 

func (co *StageImageContainerOptions) AddHealthCheck(check string)

func (*StageImageContainerOptions) AddLabel 

func (co *StageImageContainerOptions) AddLabel(labels map[string]string)

func (*StageImageContainerOptions) AddUser 

func (co *StageImageContainerOptions) AddUser(user string)

func (*StageImageContainerOptions) AddVolume 

func (co *StageImageContainerOptions) AddVolume(volumes ...string)

func (*StageImageContainerOptions) AddVolumeFrom 

func (co *StageImageContainerOptions) AddVolumeFrom(volumesFrom ...string)

func (*StageImageContainerOptions) AddWorkdir 

func (co *StageImageContainerOptions) AddWorkdir(workdir string)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.