images

Documentation

Index

• func Build(opts ImageBuildOptions) (string, error)
• func Diff(id string) ([]string, error)
• func History(id string) ([][]string, error)
• func Import(opts ImageImportOptions) (string, error)
• func Inspect(id string) (string, error)
• func Prune() error
• func Pull(name string) error
• func Push(id string, opts ImagePushOptions) error
• func Remove(id string) ([]string, error)
• func Save(imageID string, opts ImageSaveOptions) error
• func Search(term string) ([][]string, error)
• func Tag(id string, tag string) error
• func Tree(id string) (string, error)
• func Untag(id string) error
• type ImageBuildOptions
• type ImageImportOptions
• type ImageListReporter
  • func List() ([]ImageListReporter, error)
• type ImagePushOptions
• type ImageSaveOptions

Functions

func Build

func Build(opts ImageBuildOptions) (string, error)

Build creates an image using a containerfile reference.

func Diff

func Diff(id string) ([]string, error)

Diff returns the diff of specified image ID.

func History

func History(id string) ([][]string, error)

History returns history of an image.

func Import

func Import(opts ImageImportOptions) (string, error)

Import creates a container image from an archive.

func Inspect

func Inspect(id string) (string, error)

Inspect inspects the specified image ID.

func Prune

func Prune() error

Prune removes all un used specified images.

func Pull

func Pull(name string) error

Pull pulls image from registry.

func Push

func Push(id string, opts ImagePushOptions) error

Push push a source image to a specified destination.

func Remove

func Remove(id string) ([]string, error)

Remove removes the specified image ID.

func Save

func Save(imageID string, opts ImageSaveOptions) error

Save saves an image on the local machine.

func Search

func Search(term string) ([][]string, error)

Search search repostiroy for images matche the search term.

func Tag

func Tag(id string, tag string) error

Tag tags the specified image ID.

func Tree

func Tree(id string) (string, error)

Tree returns a tree based representation of the given image.

func Untag

func Untag(id string) error

Untag tags the specified image ID.

Types

type ImageBuildOptions

type ImageBuildOptions struct {
	ContainerFiles []string
	BuildOptions   entities.BuildOptions
}

ImageBuildOptions image build options.

type ImageImportOptions

type ImageImportOptions struct {
	Source    string
	Change    []string
	Message   string
	Reference string
	URL       bool
}

ImageImportOptions image import options.

type ImageListReporter

type ImageListReporter struct {
	Repository string `json:"repository,omitempty"`
	Tag        string `json:"tag,omitempty"`
	entities.ImageSummary
}

ImageListReporter image list report.

func List

func List() ([]ImageListReporter, error)

List returns list of images information.

type ImagePushOptions

type ImagePushOptions struct {
	Destination   string
	Compress      bool
	Format        string
	SkipTLSVerify bool
	AuthFile      string
	Username      string
	Password      string
}

ImagePushOptions image push options.

type ImageSaveOptions

type ImageSaveOptions struct {
	Output                      string
	Compressed                  bool
	OciAcceptUncompressedLayers bool
	Format                      string
}

ImageSaveOptions image save options.