indexer

Documentation

Index

• Variables
• type AddToIndexRequest
• type DeleteFromIndexRequest
• type DeprecateFromIndexRequest
• type ExportFromIndexRequest
• type ImageIndexer
  • func (i ImageIndexer) AddToIndex(request AddToIndexRequest) error
  • func (i ImageIndexer) DeleteFromIndex(request DeleteFromIndexRequest) error
  • func (i ImageIndexer) DeprecateFromIndex(request DeprecateFromIndexRequest) error
  • func (i ImageIndexer) ExportFromIndex(request ExportFromIndexRequest) error
  • func (i ImageIndexer) ExtractDatabase(buildDir, fromIndex, caFile string, skipTLSVerify, plainHTTP bool) (string, error)
  • func (i ImageIndexer) PruneFromIndex(request PruneFromIndexRequest) error
  • func (i ImageIndexer) PruneStrandedFromIndex(request PruneStrandedFromIndexRequest) error
• type IndexAdder
  • func NewIndexAdder(buildTool, pullTool containertools.ContainerTool, logger *logrus.Entry) IndexAdder
• type IndexDeleter
  • func NewIndexDeleter(buildTool, pullTool containertools.ContainerTool, logger *logrus.Entry) IndexDeleter
• type IndexDeprecator
  • func NewIndexDeprecator(buildTool, pullTool containertools.ContainerTool, logger *logrus.Entry) IndexDeprecator
• type IndexExporter
  • func NewIndexExporter(containerTool containertools.ContainerTool, logger *logrus.Entry) IndexExporter
• type IndexPruner
  • func NewIndexPruner(containerTool containertools.ContainerTool, logger *logrus.Entry) IndexPruner
• type IndexStrandedPruner
  • func NewIndexStrandedPruner(containerTool containertools.ContainerTool, logger *logrus.Entry) IndexStrandedPruner
• type PruneFromIndexRequest
• type PruneStrandedFromIndexRequest

Variables

var ErrFileBasedCatalogPrune = errors.New("`opm index prune` only supports sqlite-based catalogs. See https://github.com/redhat-openshift-ecosystem/community-operators-prod/issues/793 for instructions on pruning a plaintext files backed catalog.")

Types

type AddToIndexRequest

type AddToIndexRequest struct {
	Generate          bool
	Permissive        bool
	BinarySourceImage string
	FromIndex         string
	OutDockerfile     string
	Bundles           []string
	Tag               string
	Mode              pregistry.Mode
	CaFile            string
	SkipTLSVerify     bool
	PlainHTTP         bool
	Overwrite         bool
	EnableAlpha       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
	SkipTLSVerify     bool
	PlainHTTP         bool
	CaFile            string
}

DeleteFromIndexRequest defines the parameters to send to the DeleteFromIndex API

type DeprecateFromIndexRequest

type DeprecateFromIndexRequest struct {
	Generate            bool
	Permissive          bool
	BinarySourceImage   string
	FromIndex           string
	OutDockerfile       string
	Bundles             []string
	Tag                 string
	CaFile              string
	SkipTLSVerify       bool
	PlainHTTP           bool
	AllowPackageRemoval bool
}

DeprecateFromIndexRequest defines the parameters to send to the PruneFromIndex API

type ExportFromIndexRequest

type ExportFromIndexRequest struct {
	Index         string
	Packages      []string
	DownloadPath  string
	ContainerTool containertools.ContainerTool
	CaFile        string
	SkipTLSVerify bool
	PlainHTTP     bool
}

ExportFromIndexRequest defines the parameters to send to the ExportFromIndex API

type ImageIndexer

type ImageIndexer struct {
	DockerfileGenerator    containertools.DockerfileGenerator
	CommandRunner          containertools.CommandRunner
	LabelReader            containertools.LabelReader
	RegistryAdder          registry.RegistryAdder
	RegistryDeleter        registry.RegistryDeleter
	RegistryPruner         registry.RegistryPruner
	RegistryStrandedPruner registry.RegistryStrandedPruner
	RegistryDeprecator     registry.RegistryDeprecator
	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) DeprecateFromIndex

func (i ImageIndexer) DeprecateFromIndex(request DeprecateFromIndexRequest) error

DeprecateFromIndex takes a DeprecateFromIndexRequest and deprecates the requested bundles.

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) ExtractDatabase

func (i ImageIndexer) ExtractDatabase(buildDir, fromIndex, caFile string, skipTLSVerify, plainHTTP bool) (string, error)

ExtractDatabase sets a temp directory for unpacking an image

func (ImageIndexer) PruneFromIndex

func (i ImageIndexer) PruneFromIndex(request PruneFromIndexRequest) error

func (ImageIndexer) PruneStrandedFromIndex

func (i ImageIndexer) PruneStrandedFromIndex(request PruneStrandedFromIndexRequest) error

PruneStrandedFromIndex is an aggregate API used to generate a registry index image that has removed stranded bundles from the index

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(buildTool, pullTool containertools.ContainerTool, logger *logrus.Entry) IndexDeleter

NewIndexDeleter is a constructor that returns an IndexDeleter

type IndexDeprecator

type IndexDeprecator interface {
	DeprecateFromIndex(DeprecateFromIndexRequest) error
}

IndexDeprecator prunes operators out of an index

func NewIndexDeprecator

func NewIndexDeprecator(buildTool, pullTool containertools.ContainerTool, logger *logrus.Entry) IndexDeprecator

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 IndexStrandedPruner

type IndexStrandedPruner interface {
	PruneStrandedFromIndex(PruneStrandedFromIndexRequest) error
}

IndexStrandedPruner prunes operators out of an index

func NewIndexStrandedPruner

func NewIndexStrandedPruner(containerTool containertools.ContainerTool, logger *logrus.Entry) IndexStrandedPruner

type PruneFromIndexRequest

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

PruneFromIndexRequest defines the parameters to send to the PruneFromIndex API

type PruneStrandedFromIndexRequest

type PruneStrandedFromIndexRequest struct {
	Generate          bool
	BinarySourceImage string
	FromIndex         string
	OutDockerfile     string
	Tag               string
	CaFile            string
	SkipTLSVerify     bool
	PlainHTTP         bool
}

PruneStrandedFromIndexRequest defines the parameters to send to the PruneStrandedFromIndex API