indexer

Documentation

Index

• type AddToIndexRequest
• type DeleteFromIndexRequest
• type ExportFromIndexRequest
• type ImageIndexer
  • func (i ImageIndexer) AddToIndex(request AddToIndexRequest) error
  • func (i ImageIndexer) DeleteFromIndex(request DeleteFromIndexRequest) error
  • func (i ImageIndexer) ExportFromIndex(request ExportFromIndexRequest) error
  • func (i ImageIndexer) PruneFromIndex(request PruneFromIndexRequest) error
• type IndexAdder
  • func NewIndexAdder(buildTool, pullTool containertools.ContainerTool, logger *logrus.Entry) IndexAdder
• type IndexDeleter
  • func NewIndexDeleter(containerTool containertools.ContainerTool, logger *logrus.Entry) IndexDeleter
• type IndexExporter
  • func NewIndexExporter(containerTool containertools.ContainerTool, logger *logrus.Entry) IndexExporter
• type IndexPruner
  • func NewIndexPruner(containerTool containertools.ContainerTool, logger *logrus.Entry) IndexPruner
• type PruneFromIndexRequest

Types

type AddToIndexRequest

type AddToIndexRequest struct {
	Generate          bool
	Permissive        bool
	BinarySourceImage string
	FromIndex         string
	OutDockerfile     string
	Bundles           []string
	Tag               string
	Mode              pregistry.Mode
	SkipTLS           bool
}

AddToIndexRequest defines the parameters to send to the AddToIndex API

type DeleteFromIndexRequest

type DeleteFromIndexRequest struct {
	Generate          bool
	Permissive        bool
	BinarySourceImage string
	FromIndex         string
	OutDockerfile     string
	Tag               string
	Operators         []string
}

DeleteFromIndexRequest defines the parameters to send to the DeleteFromIndex API

type ExportFromIndexRequest

type ExportFromIndexRequest struct {
	Index         string
	Package       string
	DownloadPath  string
	ContainerTool containertools.ContainerTool
}

ExportFromIndexRequest defines the parameters to send to the ExportFromIndex API

type ImageIndexer

type ImageIndexer struct {
	DockerfileGenerator containertools.DockerfileGenerator
	CommandRunner       containertools.CommandRunner
	LabelReader         containertools.LabelReader
	ImageReader         containertools.ImageReader
	RegistryAdder       registry.RegistryAdder
	RegistryDeleter     registry.RegistryDeleter
	RegistryPruner      registry.RegistryPruner
	BuildTool           containertools.ContainerTool
	PullTool            containertools.ContainerTool
	Logger              *logrus.Entry
}

ImageIndexer is a struct implementation of the Indexer interface

func (ImageIndexer) AddToIndex

func (i ImageIndexer) AddToIndex(request AddToIndexRequest) error

AddToIndex is an aggregate API used to generate a registry index image with additional bundles

func (ImageIndexer) DeleteFromIndex

func (i ImageIndexer) DeleteFromIndex(request DeleteFromIndexRequest) error

DeleteFromIndex is an aggregate API used to generate a registry index image without specific operators

func (ImageIndexer) ExportFromIndex

func (i ImageIndexer) ExportFromIndex(request ExportFromIndexRequest) error

ExportFromIndex is an aggregate API used to specify operators from an index image

func (ImageIndexer) PruneFromIndex

func (i ImageIndexer) PruneFromIndex(request PruneFromIndexRequest) error

type IndexAdder

type IndexAdder interface {
	AddToIndex(AddToIndexRequest) error
}

IndexAdder allows the creation of index container images from scratch or based on previous index images

func NewIndexAdder

func NewIndexAdder(buildTool, pullTool containertools.ContainerTool, logger *logrus.Entry) IndexAdder

NewIndexAdder is a constructor that returns an IndexAdder

type IndexDeleter

type IndexDeleter interface {
	DeleteFromIndex(DeleteFromIndexRequest) error
}

IndexDeleter takes indexes and deletes all references to an operator from them

func NewIndexDeleter

func NewIndexDeleter(containerTool containertools.ContainerTool, logger *logrus.Entry) IndexDeleter

NewIndexDeleter is a constructor that returns an IndexDeleter

type IndexExporter

type IndexExporter interface {
	ExportFromIndex(ExportFromIndexRequest) error
}

func NewIndexExporter

func NewIndexExporter(containerTool containertools.ContainerTool, logger *logrus.Entry) IndexExporter

NewIndexExporter is a constructor that returns an IndexExporter

type IndexPruner

type IndexPruner interface {
	PruneFromIndex(PruneFromIndexRequest) error
}

IndexPruner prunes operators out of an index

func NewIndexPruner

func NewIndexPruner(containerTool containertools.ContainerTool, logger *logrus.Entry) IndexPruner

type PruneFromIndexRequest

type PruneFromIndexRequest struct {
	Generate          bool
	Permissive        bool
	BinarySourceImage string
	FromIndex         string
	OutDockerfile     string
	Tag               string
	Packages          []string
}

PruneFromIndexRequest defines the parameters to send to the PruneFromIndex API