images

Documentation

Index

• func Build(nameOrId string)
• func Diff(ctx context.Context, nameOrId string) ([]archive.Change, error)
• func Exists(ctx context.Context, nameOrID string) (bool, error)
• func Export(ctx context.Context, nameOrID string, w io.Writer, format *string, ...) error
• func GetImage(ctx context.Context, nameOrID string, size *bool) (*entities.ImageData, error)
• func History(ctx context.Context, nameOrID string) ([]*handlers.HistoryResponse, error)
• func ImageTree(ctx context.Context, nameOrId string) error
• func Import(ctx context.Context, changes []string, message, reference, u *string, ...) (*entities.ImageImportReport, error)
• func List(ctx context.Context, all *bool, filters map[string][]string) ([]*entities.ImageSummary, error)
• func Load(ctx context.Context, r io.Reader, name *string) (*entities.ImageLoadReport, error)
• func Prune(ctx context.Context, all *bool, filters map[string][]string) ([]string, error)
• func Pull(ctx context.Context, rawImage string, options entities.ImagePullOptions) ([]string, error)
• func Push(ctx context.Context, source string, destination string, ...) error
• func Remove(ctx context.Context, nameOrID string, force *bool) ([]map[string]string, error)
• func Search(ctx context.Context, term string, opts entities.ImageSearchOptions) ([]entities.ImageSearchReport, error)
• func Tag(ctx context.Context, nameOrID, tag, repo string) error
• func Untag(ctx context.Context, nameOrID, tag, repo string) error

Functions

func Build

func Build(nameOrId string)

func Diff

func Diff(ctx context.Context, nameOrId string) ([]archive.Change, error)

Diff provides the changes between two container layers

func Exists

func Exists(ctx context.Context, nameOrID string) (bool, error)

Exists a lightweight way to determine if an image exists in local storage. It returns a boolean response.

func Export

func Export(ctx context.Context, nameOrID string, w io.Writer, format *string, compress *bool) error

Export saves an image from local storage as a tarball or image archive. The optional format parameter is used to change the format of the output.

func GetImage

func GetImage(ctx context.Context, nameOrID string, size *bool) (*entities.ImageData, error)

Get performs an image inspect. To have the on-disk size of the image calculated, you can use the optional size parameter.

func History

func History(ctx context.Context, nameOrID string) ([]*handlers.HistoryResponse, error)

History returns the parent layers of an image.

func ImageTree

func ImageTree(ctx context.Context, nameOrId string) error

func Import

func Import(ctx context.Context, changes []string, message, reference, u *string, r io.Reader) (*entities.ImageImportReport, error)

Imports adds the given image to the local image store. This can be done by file and the given reader or via the url parameter. Additional metadata can be associated with the image by using the changes and message parameters. The image can also be tagged given a reference. One of url OR r must be provided.

func List

func List(ctx context.Context, all *bool, filters map[string][]string) ([]*entities.ImageSummary, error)

List returns a list of images in local storage. The all boolean and filters parameters are optional ways to alter the image query.

func Load

func Load(ctx context.Context, r io.Reader, name *string) (*entities.ImageLoadReport, error)

func Prune

func Prune(ctx context.Context, all *bool, filters map[string][]string) ([]string, error)

Prune removes unused images from local storage. The optional filters can be used to further define which images should be pruned.

func Pull

func Pull(ctx context.Context, rawImage string, options entities.ImagePullOptions) ([]string, error)

Pull is the binding for libpod's v2 endpoints for pulling images. Note that `rawImage` must be a reference to a registry (i.e., of docker transport or be normalized to one). Other transports are rejected as they do not make sense in a remote context.

func Push

func Push(ctx context.Context, source string, destination string, options entities.ImagePushOptions) error

Push is the binding for libpod's v2 endpoints for push images. Note that `source` must be a refering to an image in the remote's container storage. The destination must be a reference to a registry (i.e., of docker transport or be normalized to one). Other transports are rejected as they do not make sense in a remote context.

func Remove

func Remove(ctx context.Context, nameOrID string, force *bool) ([]map[string]string, error)

Remove deletes an image from local storage. The optional force parameter will forcibly remove the image by removing all all containers, including those that are Running, first.

func Search

func Search(ctx context.Context, term string, opts entities.ImageSearchOptions) ([]entities.ImageSearchReport, error)

Search is the binding for libpod's v2 endpoints for Search images.

func Tag

func Tag(ctx context.Context, nameOrID, tag, repo string) error

Tag adds an additional name to locally-stored image. Both the tag and repo parameters are required.

func Untag

func Untag(ctx context.Context, nameOrID, tag, repo string) error

Untag removes a name from locally-stored image. Both the tag and repo parameters are required.