tarfile

Documentation

Overview

Package tarfile is an internal implementation detail of some transports. Do not use outside of the github.com/containers/image repo!

Index

• type Destination
  • func NewDestination(dest io.Writer, ref reference.NamedTagged) *Destination
  • func (d *Destination) AcceptsForeignLayerURLs() bool
  • func (d *Destination) AddRepoTags(tags []reference.NamedTagged)
  • func (d *Destination) Commit(ctx context.Context) error
  • func (d *Destination) HasBlob(ctx context.Context, info types.BlobInfo) (bool, int64, error)
  • func (d *Destination) IgnoresEmbeddedDockerReference() bool
  • func (d *Destination) MustMatchRuntimeOS() bool
  • func (d *Destination) PutBlob(ctx context.Context, stream io.Reader, inputInfo types.BlobInfo, isConfig bool) (types.BlobInfo, error)
  • func (d *Destination) PutManifest(ctx context.Context, m []byte) error
  • func (d *Destination) PutSignatures(ctx context.Context, signatures [][]byte) error
  • func (d *Destination) ReapplyBlob(ctx context.Context, info types.BlobInfo) (types.BlobInfo, error)
  • func (d *Destination) SupportedManifestMIMETypes() []string
  • func (d *Destination) SupportsSignatures(ctx context.Context) error
• type ManifestItem
• type Source
  • func NewSourceFromFile(path string) (*Source, error)
  • func NewSourceFromStream(inputStream io.Reader) (*Source, error)
  • func (s *Source) Close() error
  • func (s *Source) GetBlob(ctx context.Context, info types.BlobInfo) (io.ReadCloser, int64, error)
  • func (s *Source) GetManifest(ctx context.Context, instanceDigest *digest.Digest) ([]byte, string, error)
  • func (s *Source) GetSignatures(ctx context.Context, instanceDigest *digest.Digest) ([][]byte, error)
  • func (s *Source) LoadTarManifest() ([]ManifestItem, error)

Types

type Destination

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

Destination is a partial implementation of types.ImageDestination for writing to an io.Writer.

func NewDestination

func NewDestination(dest io.Writer, ref reference.NamedTagged) *Destination

NewDestination returns a tarfile.Destination for the specified io.Writer.

func (*Destination) AcceptsForeignLayerURLs

func (d *Destination) AcceptsForeignLayerURLs() bool

AcceptsForeignLayerURLs returns false iff foreign layers in manifest should be actually uploaded to the image destination, true otherwise.

func (*Destination) AddRepoTags

func (d *Destination) AddRepoTags(tags []reference.NamedTagged)

AddRepoTags adds the specified tags to the destination's repoTags.

func (*Destination) Commit

func (d *Destination) Commit(ctx context.Context) error

Commit finishes writing data to the underlying io.Writer. It is the caller's responsibility to close it, if necessary.

func (*Destination) HasBlob

func (d *Destination) HasBlob(ctx context.Context, info types.BlobInfo) (bool, int64, error)

HasBlob returns true iff the image destination already contains a blob with the matching digest which can be reapplied using ReapplyBlob. Unlike PutBlob, the digest can not be empty. If HasBlob returns true, the size of the blob must also be returned. If the destination does not contain the blob, or it is unknown, HasBlob ordinarily returns (false, -1, nil); it returns a non-nil error only on an unexpected failure.

func (*Destination) IgnoresEmbeddedDockerReference

func (d *Destination) IgnoresEmbeddedDockerReference() bool

IgnoresEmbeddedDockerReference returns true iff the destination does not care about Image.EmbeddedDockerReferenceConflicts(), and would prefer to receive an unmodified manifest instead of one modified for the destination. Does not make a difference if Reference().DockerReference() is nil.

func (*Destination) MustMatchRuntimeOS

func (d *Destination) MustMatchRuntimeOS() bool

MustMatchRuntimeOS returns true iff the destination can store only images targeted for the current runtime OS. False otherwise.

func (*Destination) PutBlob

func (d *Destination) PutBlob(ctx context.Context, stream io.Reader, inputInfo types.BlobInfo, isConfig bool) (types.BlobInfo, error)

PutBlob writes contents of stream and returns data representing the result (with all data filled in). inputInfo.Digest can be optionally provided if known; it is not mandatory for the implementation to verify it. inputInfo.Size is the expected length of stream, if known. WARNING: The contents of stream are being verified on the fly. Until stream.Read() returns io.EOF, the contents of the data SHOULD NOT be available to any other readers for download using the supplied digest. If stream.Read() at any time, ESPECIALLY at end of input, returns an error, PutBlob MUST 1) fail, and 2) delete any data stored so far.

func (*Destination) PutManifest

func (d *Destination) PutManifest(ctx context.Context, m []byte) error

PutManifest writes manifest to the destination. FIXME? This should also receive a MIME type if known, to differentiate between schema versions. If the destination is in principle available, refuses this manifest type (e.g. it does not recognize the schema), but may accept a different manifest type, the returned error must be an ManifestTypeRejectedError.

func (*Destination) PutSignatures

func (d *Destination) PutSignatures(ctx context.Context, signatures [][]byte) error

PutSignatures adds the given signatures to the docker tarfile (currently not supported). MUST be called after PutManifest (signatures reference manifest contents)

func (*Destination) ReapplyBlob

func (d *Destination) ReapplyBlob(ctx context.Context, info types.BlobInfo) (types.BlobInfo, error)

ReapplyBlob informs the image destination that a blob for which HasBlob previously returned true would have been passed to PutBlob if it had returned false. Like HasBlob and unlike PutBlob, the digest can not be empty. If the blob is a filesystem layer, this signifies that the changes it describes need to be applied again when composing a filesystem tree.

func (*Destination) SupportedManifestMIMETypes

func (d *Destination) SupportedManifestMIMETypes() []string

SupportedManifestMIMETypes tells which manifest mime types the destination supports If an empty slice or nil it's returned, then any mime type can be tried to upload

func (*Destination) SupportsSignatures

func (d *Destination) SupportsSignatures(ctx context.Context) error

SupportsSignatures returns an error (to be displayed to the user) if the destination certainly can't store signatures. Note: It is still possible for PutSignatures to fail if SupportsSignatures returns nil.

type ManifestItem

type ManifestItem struct {
	Config       string
	RepoTags     []string
	Layers       []string
	Parent       imageID                                      `json:",omitempty"`
	LayerSources map[digest.Digest]manifest.Schema2Descriptor `json:",omitempty"`
}

ManifestItem is an element of the array stored in the top-level manifest.json file.

type Source

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

Source is a partial implementation of types.ImageSource for reading from tarPath.

func NewSourceFromFile

func NewSourceFromFile(path string) (*Source, error)

NewSourceFromFile returns a tarfile.Source for the specified path.

func NewSourceFromStream

func NewSourceFromStream(inputStream io.Reader) (*Source, error)

NewSourceFromStream returns a tarfile.Source for the specified inputStream, which can be either compressed or uncompressed. The caller can close the inputStream immediately after NewSourceFromFile returns.

func (*Source) Close

func (s *Source) Close() error

Close removes resources associated with an initialized Source, if any.

func (*Source) GetBlob

func (s *Source) GetBlob(ctx context.Context, info types.BlobInfo) (io.ReadCloser, int64, error)

GetBlob returns a stream for the specified blob, and the blob’s size (or -1 if unknown).

func (*Source) GetManifest

func (s *Source) GetManifest(ctx context.Context, instanceDigest *digest.Digest) ([]byte, string, error)

GetManifest returns the image's manifest along with its MIME type (which may be empty when it can't be determined but the manifest is available). It may use a remote (= slow) service. If instanceDigest is not nil, it contains a digest of the specific manifest instance to retrieve (when the primary manifest is a manifest list); this never happens if the primary manifest is not a manifest list (e.g. if the source never returns manifest lists).

func (*Source) GetSignatures

func (s *Source) GetSignatures(ctx context.Context, instanceDigest *digest.Digest) ([][]byte, error)

GetSignatures returns the image's signatures. It may use a remote (= slow) service. If instanceDigest is not nil, it contains a digest of the specific manifest instance to retrieve signatures for (when the primary manifest is a manifest list); this never happens if the primary manifest is not a manifest list (e.g. if the source never returns manifest lists).

func (*Source) LoadTarManifest

func (s *Source) LoadTarManifest() ([]ManifestItem, error)

LoadTarManifest loads and decodes the manifest.json