Affected by 
The highest tagged major version is
Documentation
¶
Index ¶
- func BatchRemove(ctx context.Context, images []string, opts entities.ImageRemoveOptions) (*entities.ImageRemoveReport, []error)
- func Build(ctx context.Context, containerFiles []string, options entities.BuildOptions) (*entities.BuildReport, error)
- 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.ImageInspectReport, error)
- func History(ctx context.Context, nameOrID string) ([]*handlers.HistoryResponse, 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 MultiExport(ctx context.Context, namesOrIds []string, w io.Writer, format *string, ...) 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) (*entities.ImageRemoveReport, 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 Tree(ctx context.Context, nameOrID string, whatRequires *bool) (*entities.ImageTreeReport, error)
- func Untag(ctx context.Context, nameOrID, tag, repo string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BatchRemove ¶
func BatchRemove(ctx context.Context, images []string, opts entities.ImageRemoveOptions) (*entities.ImageRemoveReport, []error)
BachtRemove removes a batch of images from the local storage.
func Build ¶
func Build(ctx context.Context, containerFiles []string, options entities.BuildOptions) (*entities.BuildReport, error)
Build creates an image using a containerfile reference
func Exists ¶
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.ImageInspectReport, error)
Get performs an image inspect. To have the on-disk size of the image calculated, you can use the optional size parameter.
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 MultiExport ¶
func Prune ¶
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. Progress reported on stderr
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 referring 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 ¶
Remove removes an image from the local storage. Use force to remove an image, even if it's used by containers.
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 ¶
Tag adds an additional name to locally-stored image. Both the tag and repo parameters are required.
Types ¶
This section is empty.
Source Files