imageprovider

Documentation

Index

• type GeneratedImage
• type ImageBuildInvalid
  • func BuildInvalidError(err error) ImageBuildInvalid
  • func (ibf ImageBuildInvalid) Error() string
  • func (ibf ImageBuildInvalid) Unwrap() error
• type ImageData
• type ImageNotReady
  • func (inr ImageNotReady) Error() string
• type ImageProvider
  • func NewDefaultImageProvider() ImageProvider
• type NetworkData

Types

type GeneratedImage

type GeneratedImage struct {
	ImageURL          string
	KernelURL         string
	ExtraKernelParams string
}

GeneratedImage contains information about the generated image. At least the URL must be populated.

type ImageBuildInvalid

type ImageBuildInvalid struct {
	// contains filtered or unexported fields
}

func BuildInvalidError

func BuildInvalidError(err error) ImageBuildInvalid

func (ImageBuildInvalid) Error

func (ibf ImageBuildInvalid) Error() string

func (ImageBuildInvalid) Unwrap

func (ibf ImageBuildInvalid) Unwrap() error

type ImageData

type ImageData struct {
	ImageMetadata     *metav1.ObjectMeta
	Format            metal3.ImageFormat
	Architecture      string
	NetworkDataStatus metal3.SecretStatus
}

ImageData contains information about the image type being requested, and metadata about the request.

type ImageNotReady

type ImageNotReady struct{}

func (ImageNotReady) Error

func (inr ImageNotReady) Error() string

type ImageProvider

type ImageProvider interface {
	// SupportsArchitecture returns whether the ImageProvider can provide
	// images for the given processor architecture.
	SupportsArchitecture(string) bool

	// SupportsFormat returns whether the ImageProvider can provide images in
	// the given format.
	SupportsFormat(metal3.ImageFormat) bool

	// BuildImage requests the ImageProvider to build an image with the
	// supplied network data and return a URL where it can be accessed.
	BuildImage(ImageData, NetworkData, logr.Logger) (GeneratedImage, error)

	// DiscardImage notifies the ImageProvider that a previously built image
	// is no longer required.
	DiscardImage(ImageData) error
}

func NewDefaultImageProvider

func NewDefaultImageProvider() ImageProvider

type NetworkData

type NetworkData map[string][]byte