index

Documentation

Index

• Constants
• func GetRegistryPodHost(ipStr string) string
• type BundleAddMode
  • func (m BundleAddMode) Validate() error
• type BundleItem
• type RegistryPod
  • func (rp *RegistryPod) Create(ctx context.Context, cfg *operator.Configuration, cs *v1alpha1.CatalogSource) (*corev1.Pod, error)

Constants

const (
	// DefaultIndexImage is the index base image used if none is specified. It contains no bundles.
	DefaultIndexImage = "quay.io/operator-framework/upstream-opm-builder:latest"
)

Functions

func GetRegistryPodHost

func GetRegistryPodHost(ipStr string) string

Types

type BundleAddMode

type BundleAddMode string

BundleAddMode is the mode to add a bundle to an index.

const (
	// SemverBundleAddMode - bundle add mode for semver
	SemverBundleAddMode BundleAddMode = "semver"
	// ReplacesBundleAddMode - bundle add mode for replaces
	ReplacesBundleAddMode BundleAddMode = "replaces"
)

func (BundleAddMode) Validate

func (m BundleAddMode) Validate() error

type BundleItem

type BundleItem struct {
	// ImageTag is the bundle image's tag.
	ImageTag string `json:"imageTag"`
	// AddMode describes how the bundle should be added to an index image.
	AddMode BundleAddMode `json:"mode"`
}

BundleItem contains the metadata of a bundle image relevant to the registry pod.

type RegistryPod

type RegistryPod struct {
	// BundleItems contains all bundles to be added to a registry pod.
	BundleItems []BundleItem

	// Index image contains a database of pointers to operator manifest content that is queriable via an API.
	// new version of an operator bundle when published can be added to an index image
	IndexImage string

	// DBPath refers to the registry DB;
	// if an index image is provided, the existing registry DB is located at /database/index.db
	DBPath string

	// GRPCPort is the container grpc port
	GRPCPort int32
	// contains filtered or unexported fields
}

RegistryPod holds resources necessary for creation of a registry server

func (*RegistryPod) Create

func (rp *RegistryPod) Create(ctx context.Context, cfg *operator.Configuration, cs *v1alpha1.CatalogSource) (*corev1.Pod, error)

Create creates a bundle registry pod built from an index image, sets the catalog source as the owner for the pod and verifies that the pod is running