bundle

Documentation

Index

• Constants
• func IsNotBundleError(err error) bool
• type Bundle
  • func NewBundle(ref string, imagesMetadata ImagesMetadata) *Bundle
  • func NewBundleFromPlainImage(plainImg *plainimg.PlainImage, imagesMetadata ImagesMetadata) *Bundle
  • func NewBundleWithReader(ref string, imagesMetadata ImagesMetadata, imagesLockReader ImagesLockReader) *Bundle
  • func (o *Bundle) AllImagesRefs(concurrency int, ui util.UIWithLevels) ([]*Bundle, ImageRefs, error)
  • func (o *Bundle) DigestRef() string
  • func (o *Bundle) IsBundle() (bool, error)
  • func (o *Bundle) NoteCopy(processedImages *imageset.ProcessedImages, reg ImagesMetadataWriter, ...) error
  • func (o *Bundle) Pull(outputPath string, ui goui.UI, pullNestedBundles bool) error
  • func (o *Bundle) Repo() string
  • func (o *Bundle) Tag() string
• type Contents
  • func NewContents(paths []string, excludedPaths []string) Contents
  • func (b Contents) PresentsAsBundle() (bool, error)
  • func (b Contents) Push(uploadRef regname.Tag, registry ImagesMetadataWriter, ui ui.UI) (string, error)
• type ImageLocation
• type ImageLocationsConfig
  • func NewLocationConfigFromBytes(data []byte) (ImageLocationsConfig, error)
  • func NewLocationConfigFromPath(path string) (ImageLocationsConfig, error)
  • func (c ImageLocationsConfig) AsBytes() ([]byte, error)
  • func (c ImageLocationsConfig) Validate() error
  • func (c ImageLocationsConfig) WriteToPath(path string) error
• type ImageRef
  • func NewImageRef(imgRef lockconfig.ImageRef, isBundle bool) ImageRef
  • func (i ImageRef) DeepCopy() ImageRef
• type ImageRefLocationsConfig
• type ImageRefs
  • func NewImageRefs() ImageRefs
  • func NewImageRefsFromImagesLock(imagesLock lockconfig.ImagesLock, ...) (ImageRefs, error)
  • func (i *ImageRefs) AddImagesRef(refs ...ImageRef)
  • func (i *ImageRefs) Find(ref string) (ImageRef, bool)
  • func (i ImageRefs) ImageRefs() []ImageRef
  • func (i ImageRefs) ImagesLock() lockconfig.ImagesLock
  • func (i *ImageRefs) LocalizeToRepo(relativeToRepo string)
  • func (i *ImageRefs) MarkAsBundle(image string, isBundle bool)
  • func (i *ImageRefs) UpdateRelativeToRepo(imgRetriever ImagesMetadata, relativeToRepo string) (bool, error)
• type ImagesLockReader
• type ImagesMetadata
• type ImagesMetadataWriter
• type InfoLog
  • func (l InfoLog) Write(data []byte) (int, error)
• type LocationImageReader
• type LocationsConfig
  • func (l LocationsConfig) Config() (ImageLocationsConfig, error)
• type LocationsConfigs
  • func NewLocations(ui util.UIWithLevels) *LocationsConfigs
  • func NewLocationsWithReader(reader LocationImageReader, ui util.UIWithLevels) *LocationsConfigs
  • func (r LocationsConfigs) Fetch(registry ImagesMetadata, bundleRef name.Digest) (ImageLocationsConfig, error)
  • func (r LocationsConfigs) Save(reg ImagesMetadataWriter, bundleRef name.Digest, config ImageLocationsConfig, ...) error
• type LocationsNotFound
  • func (n LocationsNotFound) Error() string

Constants

const (
	ImgpkgDir      = ".imgpkg"
	BundlesDir     = "bundles"
	ImagesLockFile = "images.yml"
)

const (
	LocationFilepath   = "image-locations.yml"
	ImageLocationsKind = "ImageLocations"
	LocationAPIVersion = "imgpkg.carvel.dev/v1alpha1"
)

const (
	BundleConfigLabel = "dev.carvel.imgpkg.bundle"
)

Functions

func IsNotBundleError

func IsNotBundleError(err error) bool

Types

type Bundle

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

func NewBundle

func NewBundle(ref string, imagesMetadata ImagesMetadata) *Bundle

func NewBundleFromPlainImage

func NewBundleFromPlainImage(plainImg *plainimg.PlainImage, imagesMetadata ImagesMetadata) *Bundle

func NewBundleWithReader

func NewBundleWithReader(ref string, imagesMetadata ImagesMetadata, imagesLockReader ImagesLockReader) *Bundle

func (*Bundle) AllImagesRefs

func (o *Bundle) AllImagesRefs(concurrency int, ui util.UIWithLevels) ([]*Bundle, ImageRefs, error)

AllImagesRefs returns a flat list of nested bundles and every image reference for a specific bundle

func (*Bundle) DigestRef

func (o *Bundle) DigestRef() string

func (*Bundle) IsBundle

func (o *Bundle) IsBundle() (bool, error)

func (*Bundle) NoteCopy

func (o *Bundle) NoteCopy(processedImages *imageset.ProcessedImages, reg ImagesMetadataWriter, ui util.UIWithLevels) error

NoteCopy writes an image-location representing the bundle / images that have been copied

func (*Bundle) Pull

func (o *Bundle) Pull(outputPath string, ui goui.UI, pullNestedBundles bool) error

func (*Bundle) Repo

func (o *Bundle) Repo() string

func (*Bundle) Tag

func (o *Bundle) Tag() string

type Contents

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

func NewContents

func NewContents(paths []string, excludedPaths []string) Contents

func (Contents) PresentsAsBundle

func (b Contents) PresentsAsBundle() (bool, error)

func (Contents) Push

func (b Contents) Push(uploadRef regname.Tag, registry ImagesMetadataWriter, ui ui.UI) (string, error)

type ImageLocation

type ImageLocation struct {
	Image    string `json:"image"`    // This generated yaml, but due to lib we need to use `json`
	IsBundle bool   `json:"isBundle"` // This generated yaml, but due to lib we need to use `json`
}

type ImageLocationsConfig

type ImageLocationsConfig struct {
	APIVersion string          `json:"apiVersion"` // This generated yaml, but due to lib we need to use `json`
	Kind       string          `json:"kind"`       // This generated yaml, but due to lib we need to use `json`
	Images     []ImageLocation `json:"images"`     // This generated yaml, but due to lib we need to use `json`
}

func NewLocationConfigFromBytes

func NewLocationConfigFromBytes(data []byte) (ImageLocationsConfig, error)

func NewLocationConfigFromPath

func NewLocationConfigFromPath(path string) (ImageLocationsConfig, error)

func (ImageLocationsConfig) AsBytes

func (c ImageLocationsConfig) AsBytes() ([]byte, error)

func (ImageLocationsConfig) Validate

func (c ImageLocationsConfig) Validate() error

func (ImageLocationsConfig) WriteToPath

func (c ImageLocationsConfig) WriteToPath(path string) error

type ImageRef

type ImageRef struct {
	lockconfig.ImageRef
	IsBundle *bool
}

func NewImageRef

func NewImageRef(imgRef lockconfig.ImageRef, isBundle bool) ImageRef

func (ImageRef) DeepCopy

func (i ImageRef) DeepCopy() ImageRef

type ImageRefLocationsConfig

type ImageRefLocationsConfig interface {
	Config() (ImageLocationsConfig, error)
}

type ImageRefs

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

func NewImageRefs

func NewImageRefs() ImageRefs

func NewImageRefsFromImagesLock

func NewImageRefsFromImagesLock(imagesLock lockconfig.ImagesLock, imageRefsLocationConfig ImageRefLocationsConfig) (ImageRefs, error)

func (*ImageRefs) AddImagesRef

func (i *ImageRefs) AddImagesRef(refs ...ImageRef)

func (*ImageRefs) Find

func (i *ImageRefs) Find(ref string) (ImageRef, bool)

func (ImageRefs) ImageRefs

func (i ImageRefs) ImageRefs() []ImageRef

func (ImageRefs) ImagesLock

func (i ImageRefs) ImagesLock() lockconfig.ImagesLock

func (*ImageRefs) LocalizeToRepo

func (i *ImageRefs) LocalizeToRepo(relativeToRepo string)

func (*ImageRefs) MarkAsBundle

func (i *ImageRefs) MarkAsBundle(image string, isBundle bool)

func (*ImageRefs) UpdateRelativeToRepo

func (i *ImageRefs) UpdateRelativeToRepo(imgRetriever ImagesMetadata, relativeToRepo string) (bool, error)

type ImagesLockReader

type ImagesLockReader interface {
	Read(img regv1.Image) (lockconfig.ImagesLock, error)
}

type ImagesMetadata

type ImagesMetadata interface {
	Get(regname.Reference) (*regremote.Descriptor, error)
	Image(regname.Reference) (regv1.Image, error)
	Digest(regname.Reference) (regv1.Hash, error)
	FirstImageExists(digests []string) (string, error)
}

type ImagesMetadataWriter

type ImagesMetadataWriter interface {
	ImagesMetadata
	WriteImage(regname.Reference, regv1.Image) error
}

type InfoLog

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

func (InfoLog) Write

func (l InfoLog) Write(data []byte) (int, error)

type LocationImageReader

type LocationImageReader interface {
	Read(img regv1.Image) (ImageLocationsConfig, error)
}

type LocationsConfig

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

func (LocationsConfig) Config

func (l LocationsConfig) Config() (ImageLocationsConfig, error)

type LocationsConfigs

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

func NewLocations

func NewLocations(ui util.UIWithLevels) *LocationsConfigs

NewLocations constructor for creating a LocationsConfigs

func NewLocationsWithReader

func NewLocationsWithReader(reader LocationImageReader, ui util.UIWithLevels) *LocationsConfigs

NewLocationsWithReader constructor for LocationsConfigs

func (LocationsConfigs) Fetch

func (r LocationsConfigs) Fetch(registry ImagesMetadata, bundleRef name.Digest) (ImageLocationsConfig, error)

func (LocationsConfigs) Save

func (r LocationsConfigs) Save(reg ImagesMetadataWriter, bundleRef name.Digest, config ImageLocationsConfig, ui ui.UI) error

type LocationsNotFound

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

func (LocationsNotFound) Error

func (n LocationsNotFound) Error() string