dockerimage

Documentation

Index

• type DockerImage
  • func New(spec interface{}) (*DockerImage, error)
  • func (di *DockerImage) Changelog() string
  • func (di *DockerImage) Condition(source string, scm scm.ScmHandler, resultCondition *result.Condition) error
  • func (di *DockerImage) Source(workingDir string, resultSource *result.Source) error
  • func (di *DockerImage) Target(source string, scm scm.ScmHandler, dryRun bool, resultTarget *result.Target) error
• type Spec
  • func NewDockerImageSpecFromImage(image, tag string, auths map[string]docker.InlineKeyChain) *Spec

Types

type DockerImage

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

DockerImage defines a resource of type "dockerimage"

func New

func New(spec interface{}) (*DockerImage, error)

New returns a reference to a newly initialized DockerImage object from a dockerimage.Spec or an error if the provided Spec triggers a validation error.

func (*DockerImage) Changelog

func (di *DockerImage) Changelog() string

Changelog returns the changelog for this resource, or an empty string if not supported

func (*DockerImage) Condition

func (di *DockerImage) Condition(source string, scm scm.ScmHandler, resultCondition *result.Condition) error

Condition checks if a docker image with a specific tag is published We assume that if we can't retrieve the docker image digest, then it means it doesn't exist.

func (*DockerImage) Source

func (di *DockerImage) Source(workingDir string, resultSource *result.Source) error

func (*DockerImage) Target

func (di *DockerImage) Target(source string, scm scm.ScmHandler, dryRun bool, resultTarget *result.Target) error

type Spec

type Spec struct {
	// [C] architectures specifies a list of architectures to check container images for (conditions only)
	Architectures []string `yaml:",omitempty"`
	// [S][C] architecture specifies the container image architecture such as `amd64`
	Architecture string `yaml:",omitempty"`
	// [S][C] image specifies the container image such as `updatecli/updatecli`
	Image string `yaml:",omitempty"`
	// [C] tag specifies the container image tag such as `latest`
	Tag                   string `yaml:",omitempty"`
	docker.InlineKeyChain `yaml:",inline" mapstructure:",squash"`
	// [S] versionfilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
	VersionFilter version.Filter `yaml:",omitempty"`
	// [S] tagfilter allows to restrict tags retrieved from a remote registry by using a regular expression.
	TagFilter string `yaml:",omitempty"`
}

Spec defines a specification for a "dockerimage" resource parsed from an updatecli manifest file

func NewDockerImageSpecFromImage

func NewDockerImageSpecFromImage(image, tag string, auths map[string]docker.InlineKeyChain) *Spec

NewDockerImageSpecFromImage return a new docker image specification using an image provided as parameter