image

Documentation

Index

• Constants
• type Cache
  • func BundleCache(basePath string) Cache
  • func CatalogCache(basePath string) Cache
• type ContainersImagePuller
  • func (p *ContainersImagePuller) Pull(ctx context.Context, ownerID string, ref string, cache Cache) (fs.FS, reference.Canonical, time.Time, error)
• type LayerData
• type MockCache
  • func (m MockCache) Delete(_ context.Context, _ string) error
  • func (m MockCache) Fetch(_ context.Context, _ string, _ reference.Canonical) (fs.FS, time.Time, error)
  • func (m MockCache) GarbageCollect(_ context.Context, _ string, _ reference.Canonical) error
  • func (m MockCache) Store(_ context.Context, _ string, _ reference.Named, _ reference.Canonical, ...) (fs.FS, time.Time, error)
• type MockPuller
  • func (ms *MockPuller) Pull(_ context.Context, _, _ string, _ Cache) (fs.FS, reference.Canonical, time.Time, error)
• type Puller

Constants

const ConfigDirLabel = "operators.operatorframework.io.index.configs.v1"

Types

type Cache

type Cache interface {
	Fetch(context.Context, string, reference.Canonical) (fs.FS, time.Time, error)
	Store(context.Context, string, reference.Named, reference.Canonical, ocispecv1.Image, iter.Seq[LayerData]) (fs.FS, time.Time, error)
	Delete(context.Context, string) error
	GarbageCollect(context.Context, string, reference.Canonical) error
}

func BundleCache

func BundleCache(basePath string) Cache

func CatalogCache

func CatalogCache(basePath string) Cache

type ContainersImagePuller

type ContainersImagePuller struct {
	SourceCtxFunc func(context.Context) (*types.SystemContext, error)
}

func (*ContainersImagePuller) Pull

func (p *ContainersImagePuller) Pull(ctx context.Context, ownerID string, ref string, cache Cache) (fs.FS, reference.Canonical, time.Time, error)

type LayerData

type LayerData struct {
	Reader io.Reader
	Index  int
	Err    error
}

type MockCache

type MockCache struct {
	FetchFS      fs.FS
	FetchModTime time.Time
	FetchError   error

	StoreFS      fs.FS
	StoreModTime time.Time
	StoreError   error

	DeleteErr error

	GarbageCollectError error
}

func (MockCache) Delete

func (m MockCache) Delete(_ context.Context, _ string) error

func (MockCache) Fetch

func (m MockCache) Fetch(_ context.Context, _ string, _ reference.Canonical) (fs.FS, time.Time, error)

func (MockCache) GarbageCollect

func (m MockCache) GarbageCollect(_ context.Context, _ string, _ reference.Canonical) error

func (MockCache) Store

func (m MockCache) Store(_ context.Context, _ string, _ reference.Named, _ reference.Canonical, _ ocispecv1.Image, _ iter.Seq[LayerData]) (fs.FS, time.Time, error)

type MockPuller

type MockPuller struct {
	ImageFS fs.FS
	Ref     reference.Canonical
	ModTime time.Time
	Error   error
}

MockPuller is a utility for mocking out a Puller interface

func (*MockPuller) Pull

func (ms *MockPuller) Pull(_ context.Context, _, _ string, _ Cache) (fs.FS, reference.Canonical, time.Time, error)

type Puller

type Puller interface {
	Pull(context.Context, string, string, Cache) (fs.FS, reference.Canonical, time.Time, error)
}