image

Documentation

Index

• type Image
  • func (i *Image) Apply() (resource.TaskStatus, error)
  • func (i *Image) Check(resource.Renderer) (resource.TaskStatus, error)
  • func (i *Image) RepoTag() string
  • func (i *Image) SetClient(client docker.APIClient)
• type Preparer
  • func (p *Preparer) Prepare(render resource.Renderer) (resource.Task, error)

Types

type Image

type Image struct {
	*resource.Status

	Name string
	Tag  string
	// contains filtered or unexported fields
}

Image is responsible for pulling docker images

func (*Image) Apply

func (i *Image) Apply() (resource.TaskStatus, error)

Apply pulls a docker image

func (*Image) Check

func (i *Image) Check(resource.Renderer) (resource.TaskStatus, error)

Check system for presence of docker image

func (*Image) RepoTag

func (i *Image) RepoTag() string

RepoTag builds a repo tag used to identify a specific docker image

func (*Image) SetClient

func (i *Image) SetClient(client docker.APIClient)

SetClient injects a docker api client

type Preparer

type Preparer struct {
	// name of the image to pull
	Name string `hcl:"name"`

	// tag of the image to pull
	Tag string `hcl:"tag"`

	// the amount of time to wait after a period of inactivity. The timeout is
	// reset each time new data arrives. The format is Go's duration string. A
	// duration string is a possibly signed sequence of decimal numbers, each with
	// optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m".
	// Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
	InactivityTimeout string `hcl:"inactivity_timeout" doc_type:"duration_string"`
}

Preparer for docker images

Image is responsible for pulling Docker images. It assumes that there is already a Docker daemon running on the system.

func (*Preparer) Prepare

func (p *Preparer) Prepare(render resource.Renderer) (resource.Task, error)

Prepare a new docker image