Documentation
¶
Index ¶
- func WithAllMetadata(s *Store)
- type Reference
- type Store
- func (is *Store) Get(ctx context.Context, store images.Store) (images.Image, error)
- func (is *Store) ImageFilter(h images.HandlerFunc, cs content.Store) images.HandlerFunc
- func (is *Store) Lookup(ctx context.Context, store images.Store) ([]images.Image, error)
- func (is *Store) MarshalAny(context.Context, streaming.StreamCreator) (typeurl.Any, error)
- func (is *Store) Store(ctx context.Context, desc ocispec.Descriptor, store images.Store) ([]images.Image, error)
- func (is *Store) String() string
- func (is *Store) UnmarshalAny(ctx context.Context, sm streaming.StreamGetter, a typeurl.Any) error
- func (is *Store) UnpackPlatforms() []transfer.UnpackConfiguration
- type StoreOpt
- func WithDigestRef(name string, allowOverwrite bool, skipNamed bool) StoreOpt
- func WithExtraReference(name string) StoreOpt
- func WithImageLabels(labels map[string]string) StoreOpt
- func WithManifestLimit(limit int) StoreOpt
- func WithNamedPrefix(name string, allowOverwrite bool) StoreOpt
- func WithPlatforms(p ...ocispec.Platform) StoreOpt
- func WithUnpack(p ocispec.Platform, snapshotter string) StoreOpt
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithAllMetadata ¶
func WithAllMetadata(s *Store)
Types ¶
type Reference ¶
type Reference struct { Name string // IsPrefix determines whether the Name should be considered // a prefix (without tag or digest). // For lookup, this may allow matching multiple tags. // For store, this must have a tag or digest added. IsPrefix bool // AllowOverwrite allows overwriting or ignoring the name if // another reference is provided (such as through an annotation). // Only used if IsPrefix is true. AllowOverwrite bool // AddDigest adds the manifest digest to the reference. // For lookup, this allows matching tags with any digest. // For store, this allows adding the digest to the name. // Only used if IsPrefix is true. AddDigest bool // SkipNamedDigest only considers digest references which do not // have a non-digested named reference. // For lookup, this will deduplicate digest references when there is a named match. // For store, this only adds this digest reference when there is no matching full // name reference from the prefix. // Only used if IsPrefix is true. SkipNamedDigest bool }
Reference is used to create or find a reference for an image
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
func (*Store) ImageFilter ¶
func (is *Store) ImageFilter(h images.HandlerFunc, cs content.Store) images.HandlerFunc
func (*Store) MarshalAny ¶
func (*Store) UnmarshalAny ¶
func (*Store) UnpackPlatforms ¶
func (is *Store) UnpackPlatforms() []transfer.UnpackConfiguration
type StoreOpt ¶
type StoreOpt func(*Store)
StoreOpt defines options when configuring an image store source or destination
func WithDigestRef ¶
WithNamedPrefix uses a named prefix to references images which only have a tag name reference in the annotation or check full references annotations against and additionally may add a digest reference. Images with no references resolved from matching annotations may be stored by digest. - name: image name prefix to append a tag to or check full name references with - allowOverwrite: allows the tag to be overwritten by full name reference inside the image which does not have name as the prefix - skipNamed: is set if no digest reference should be created if a named reference is successfully resolved from the annotations.
func WithExtraReference ¶
func WithImageLabels ¶
WithImageLabels are the image labels to apply to a new image
func WithManifestLimit ¶
WithManifestLimit defines the max number of manifests to fetch
func WithNamedPrefix ¶
WithNamedPrefix uses a named prefix to references images which only have a tag name reference in the annotation or check full references annotations against. Images with no reference resolved from matching annotations will not be stored. - name: image name prefix to append a tag to or check full name references with - allowOverwrite: allows the tag to be overwritten by full name reference inside the image which does not have name as the prefix
func WithPlatforms ¶
WithPlatforms specifies which platforms to fetch content for