docker: github.com/docker/docker/daemon/images Index | Files

package images

import "github.com/docker/docker/daemon/images"

Index

Package Files

cache.go image.go image_builder.go image_commit.go image_delete.go image_events.go image_exporter.go image_history.go image_import.go image_inspect.go image_prune.go image_pull.go image_push.go image_search.go image_tag.go image_unix.go images.go locals.go service.go store.go

type DistributionServices Uses

type DistributionServices struct {
    DownloadManager   distribution.RootFSDownloadManager
    V2MetadataService metadata.V2MetadataService
    LayerStore        layer.Store // TODO: lcow
    ImageStore        image.Store
    ReferenceStore    dockerreference.Store
}

DistributionServices provides daemon image storage services

type ErrImageDoesNotExist Uses

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

ErrImageDoesNotExist is error returned when no image can be found for a reference.

func (ErrImageDoesNotExist) Error Uses

func (e ErrImageDoesNotExist) Error() string

func (ErrImageDoesNotExist) NotFound Uses

func (e ErrImageDoesNotExist) NotFound()

NotFound implements the NotFound interface

type ImageService Uses

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

ImageService provides a backend for image management

func NewImageService Uses

func NewImageService(config ImageServiceConfig) *ImageService

NewImageService returns a new ImageService from a configuration

func (*ImageService) Children Uses

func (i *ImageService) Children(id image.ID) []image.ID

Children returns the children image.IDs for a parent image. called from list.go to filter containers TODO: refactor to expose an ancestry for image.ID?

func (*ImageService) Cleanup Uses

func (i *ImageService) Cleanup()

Cleanup resources before the process is shutdown. called from daemon.go Daemon.Shutdown()

func (*ImageService) CommitBuildStep Uses

func (i *ImageService) CommitBuildStep(c backend.CommitConfig) (image.ID, error)

CommitBuildStep is used by the builder to create an image for each step in the build.

This method is different from CreateImageFromContainer:

* it doesn't attempt to validate container state
* it doesn't send a commit action to metrics
* it doesn't log a container commit event

This is a temporary shim. Should be removed when builder stops using commit.

func (*ImageService) CommitImage Uses

func (i *ImageService) CommitImage(c backend.CommitConfig) (image.ID, error)

CommitImage creates a new image from a commit config

func (*ImageService) CountImages Uses

func (i *ImageService) CountImages() int

CountImages returns the number of images stored by ImageService called from info.go

func (*ImageService) CreateImage Uses

func (i *ImageService) CreateImage(config []byte, parent string) (builder.Image, error)

CreateImage creates a new image by adding a config and ID to the image store. This is similar to LoadImage() except that it receives JSON encoded bytes of an image instead of a tar archive.

func (*ImageService) CreateLayer Uses

func (i *ImageService) CreateLayer(container *container.Container, initFunc layer.MountInit) (layer.RWLayer, error)

CreateLayer creates a filesystem layer for a container. called from create.go TODO: accept an opt struct instead of container?

func (*ImageService) DistributionServices Uses

func (i *ImageService) DistributionServices() DistributionServices

DistributionServices return services controlling daemon image storage

func (*ImageService) ExportImage Uses

func (i *ImageService) ExportImage(names []string, outStream io.Writer) error

ExportImage exports a list of images to the given output stream. The exported images are archived into a tar when written to the output stream. All images with the given tag and all versions containing the same tag are exported. names is the set of tags to export, and outStream is the writer which the images are written to.

func (*ImageService) GetContainerLayerSize Uses

func (i *ImageService) GetContainerLayerSize(containerID string) (int64, int64)

GetContainerLayerSize returns the real size & virtual size of the container.

func (*ImageService) GetImage Uses

func (i *ImageService) GetImage(refOrID string, platform *specs.Platform) (retImg *image.Image, retErr error)

GetImage returns an image corresponding to the image referred to by refOrID.

func (*ImageService) GetImageAndReleasableLayer Uses

func (i *ImageService) GetImageAndReleasableLayer(ctx context.Context, refOrID string, opts backend.GetImageAndLayerOptions) (builder.Image, builder.ROLayer, error)

GetImageAndReleasableLayer returns an image and releaseable layer for a reference or ID. Every call to GetImageAndReleasableLayer MUST call releasableLayer.Release() to prevent leaking of layers.

func (*ImageService) GetLayerByID Uses

func (i *ImageService) GetLayerByID(cid string, os string) (layer.RWLayer, error)

GetLayerByID returns a layer by ID and operating system called from daemon.go Daemon.restore(), and Daemon.containerExport()

func (*ImageService) GetLayerMountID Uses

func (i *ImageService) GetLayerMountID(cid string, os string) (string, error)

GetLayerMountID returns the mount ID for a layer called from daemon.go Daemon.Shutdown(), and Daemon.Cleanup() (cleanup is actually continerCleanup) TODO: needs to be refactored to Unmount (see callers), or removed and replaced with GetLayerByID

func (*ImageService) GetRepository Uses

func (i *ImageService) GetRepository(ctx context.Context, ref reference.Named, authConfig *types.AuthConfig) (dist.Repository, bool, error)

GetRepository returns a repository from the registry.

func (*ImageService) GraphDriverForOS Uses

func (i *ImageService) GraphDriverForOS(os string) string

GraphDriverForOS returns the name of the graph drvier moved from Daemon.GraphDriverName, used by: - newContainer - to report an error in Daemon.Mount(container)

func (*ImageService) ImageDelete Uses

func (i *ImageService) ImageDelete(imageRef string, force, prune bool) ([]types.ImageDeleteResponseItem, error)

ImageDelete deletes the image referenced by the given imageRef from this daemon. The given imageRef can be an image ID, ID prefix, or a repository reference (with an optional tag or digest, defaulting to the tag name "latest"). There is differing behavior depending on whether the given imageRef is a repository reference or not.

If the given imageRef is a repository reference then that repository reference will be removed. However, if there exists any containers which were created using the same image reference then the repository reference cannot be removed unless either there are other repository references to the same image or force is true. Following removal of the repository reference, the referenced image itself will attempt to be deleted as described below but quietly, meaning any image delete conflicts will cause the image to not be deleted and the conflict will not be reported.

There may be conflicts preventing deletion of an image and these conflicts are divided into two categories grouped by their severity:

Hard Conflict:

- a pull or build using the image.
- any descendant image.
- any running container using the image.

Soft Conflict:

- any stopped container using the image.
- any repository tag or digest references to the image.

The image cannot be removed if there are any hard conflicts and can be removed if there are soft conflicts only if force is true.

If prune is true, ancestor images will each attempt to be deleted quietly, meaning any delete conflicts will cause the image to not be deleted and the conflict will not be reported.

func (*ImageService) ImageHistory Uses

func (i *ImageService) ImageHistory(name string) ([]*image.HistoryResponseItem, error)

ImageHistory returns a slice of ImageHistory structures for the specified image name by walking the image lineage.

func (*ImageService) Images Uses

func (i *ImageService) Images(imageFilters filters.Args, all bool, withExtraAttrs bool) ([]*types.ImageSummary, error)

Images returns a filtered list of images. filterArgs is a JSON-encoded set of filter arguments which will be interpreted by api/types/filters. filter is a shell glob string applied to repository names. The argument named all controls whether all images in the graph are filtered, or just the heads.

func (*ImageService) ImagesPrune Uses

func (i *ImageService) ImagesPrune(ctx context.Context, pruneFilters filters.Args) (*types.ImagesPruneReport, error)

ImagesPrune removes unused images

func (*ImageService) ImportImage Uses

func (i *ImageService) ImportImage(src string, repository, os string, tag string, msg string, inConfig io.ReadCloser, outStream io.Writer, changes []string) error

ImportImage imports an image, getting the archived layer data either from inConfig (if src is "-"), or from a URI specified in src. Progress output is written to outStream. Repository and tag names can optionally be given in the repo and tag arguments, respectively.

func (*ImageService) LayerDiskUsage Uses

func (i *ImageService) LayerDiskUsage(ctx context.Context) (int64, error)

LayerDiskUsage returns the number of bytes used by layer stores called from disk_usage.go

func (*ImageService) LayerStoreStatus Uses

func (i *ImageService) LayerStoreStatus() map[string][][2]string

LayerStoreStatus returns the status for each layer store called from info.go

func (*ImageService) LoadImage Uses

func (i *ImageService) LoadImage(inTar io.ReadCloser, outStream io.Writer, quiet bool) error

LoadImage uploads a set of images into the repository. This is the complement of ImageExport. The input stream is an uncompressed tar ball containing images and metadata.

func (*ImageService) LogImageEvent Uses

func (i *ImageService) LogImageEvent(imageID, refName, action string)

LogImageEvent generates an event related to an image with only the default attributes.

func (*ImageService) LogImageEventWithAttributes Uses

func (i *ImageService) LogImageEventWithAttributes(imageID, refName, action string, attributes map[string]string)

LogImageEventWithAttributes generates an event related to an image with specific given attributes.

func (*ImageService) LookupImage Uses

func (i *ImageService) LookupImage(name string) (*types.ImageInspect, error)

LookupImage looks up an image by name and returns it as an ImageInspect structure.

func (*ImageService) MakeImageCache Uses

func (i *ImageService) MakeImageCache(sourceRefs []string) builder.ImageCache

MakeImageCache creates a stateful image cache.

func (*ImageService) Map Uses

func (i *ImageService) Map() map[image.ID]*image.Image

Map returns a map of all images in the ImageStore

func (*ImageService) PullImage Uses

func (i *ImageService) PullImage(ctx context.Context, image, tag string, platform *specs.Platform, metaHeaders map[string][]string, authConfig *types.AuthConfig, outStream io.Writer) error

PullImage initiates a pull operation. image is the repository name to pull, and tag may be either empty, or indicate a specific tag to pull.

func (*ImageService) PushImage Uses

func (i *ImageService) PushImage(ctx context.Context, image, tag string, metaHeaders map[string][]string, authConfig *types.AuthConfig, outStream io.Writer) error

PushImage initiates a push operation on the repository named localName.

func (*ImageService) ReleaseLayer Uses

func (i *ImageService) ReleaseLayer(rwlayer layer.RWLayer, containerOS string) error

ReleaseLayer releases a layer allowing it to be removed called from delete.go Daemon.cleanupContainer(), and Daemon.containerExport()

func (*ImageService) SearchRegistryForImages Uses

func (i *ImageService) SearchRegistryForImages(ctx context.Context, filtersArgs string, term string, limit int,
    authConfig *types.AuthConfig,
    headers map[string][]string) (*registrytypes.SearchResults, error)

SearchRegistryForImages queries the registry for images matching term. authConfig is used to login.

TODO: this could be implemented in a registry service instead of the image service.

func (*ImageService) SquashImage Uses

func (i *ImageService) SquashImage(id, parent string) (string, error)

SquashImage creates a new image with the diff of the specified image and the specified parent. This new image contains only the layers from it's parent + 1 extra layer which contains the diff of all the layers in between. The existing image(s) is not destroyed. If no parent is specified, a new image with the diff of all the specified image's layers merged into a new layer that has no parents.

func (*ImageService) TagImage Uses

func (i *ImageService) TagImage(imageName, repository, tag string) (string, error)

TagImage creates the tag specified by newTag, pointing to the image named imageName (alternatively, imageName can also be an image ID).

func (*ImageService) TagImageWithReference Uses

func (i *ImageService) TagImageWithReference(imageID image.ID, newTag reference.Named) error

TagImageWithReference adds the given reference to the image ID provided.

func (*ImageService) UpdateConfig Uses

func (i *ImageService) UpdateConfig(maxDownloads, maxUploads *int)

UpdateConfig values

called from reload.go

type ImageServiceConfig Uses

type ImageServiceConfig struct {
    ContainerStore            containerStore
    DistributionMetadataStore metadata.Store
    EventsService             *daemonevents.Events
    ImageStore                image.Store
    LayerStores               map[string]layer.Store
    MaxConcurrentDownloads    int
    MaxConcurrentUploads      int
    MaxDownloadAttempts       int
    ReferenceStore            dockerreference.Store
    RegistryService           registry.Service
    TrustKey                  libtrust.PrivateKey
    ContentStore              content.Store
    Leases                    leases.Manager
    ContentNamespace          string
}

ImageServiceConfig is the configuration used to create a new ImageService

Package images imports 61 packages (graph) and is imported by 3 packages. Updated 2020-11-23. Refresh now. Tools for package owners.