Documentation ¶
Index ¶
- Constants
- func IsNotBundleError(err error) bool
- type 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
- type ImageLocation
- type ImageLocationsConfig
- type ImageRef
- type ImageRefLocationsConfig
- type ImageRefs
- 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
- type LocationImageReader
- type LocationsConfig
- type LocationsConfigs
- type LocationsNotFound
Constants ¶
View Source
const ( ImgpkgDir = ".imgpkg" BundlesDir = "bundles" ImagesLockFile = "images.yml" )
View Source
const ( LocationFilepath = "image-locations.yml" ImageLocationsKind = "ImageLocations" LocationAPIVersion = "imgpkg.carvel.dev/v1alpha1" )
View Source
const (
BundleConfigLabel = "dev.carvel.imgpkg.bundle"
)
Variables ¶
This section is empty.
Functions ¶
func IsNotBundleError ¶
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 ¶ added in v0.6.0
func NewBundleWithReader(ref string, imagesMetadata ImagesMetadata, imagesLockReader ImagesLockReader) *Bundle
func (*Bundle) AllImagesRefs ¶ added in v0.9.0
AllImagesRefs returns a flat list of nested bundles and every image reference for a specific bundle
func (*Bundle) NoteCopy ¶ added in v0.9.0
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
type Contents ¶
type Contents struct {
// contains filtered or unexported fields
}
func NewContents ¶
func (Contents) PresentsAsBundle ¶
type ImageLocation ¶ added in v0.9.0
type ImageLocationsConfig ¶ added in v0.9.0
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 ¶ added in v0.9.0
func NewLocationConfigFromBytes(data []byte) (ImageLocationsConfig, error)
func NewLocationConfigFromPath ¶ added in v0.9.0
func NewLocationConfigFromPath(path string) (ImageLocationsConfig, error)
func (ImageLocationsConfig) AsBytes ¶ added in v0.9.0
func (c ImageLocationsConfig) AsBytes() ([]byte, error)
func (ImageLocationsConfig) Validate ¶ added in v0.9.0
func (c ImageLocationsConfig) Validate() error
func (ImageLocationsConfig) WriteToPath ¶ added in v0.9.0
func (c ImageLocationsConfig) WriteToPath(path string) error
type ImageRef ¶ added in v0.9.0
type ImageRef struct { lockconfig.ImageRef IsBundle *bool }
func NewImageRef ¶ added in v0.9.0
func NewImageRef(imgRef lockconfig.ImageRef, isBundle bool) ImageRef
type ImageRefLocationsConfig ¶ added in v0.13.0
type ImageRefLocationsConfig interface {
Config() (ImageLocationsConfig, error)
}
type ImageRefs ¶ added in v0.9.0
type ImageRefs struct {
// contains filtered or unexported fields
}
func NewImageRefs ¶ added in v0.12.0
func NewImageRefs() ImageRefs
func NewImageRefsFromImagesLock ¶ added in v0.13.0
func NewImageRefsFromImagesLock(imagesLock lockconfig.ImagesLock, imageRefsLocationConfig ImageRefLocationsConfig) (ImageRefs, error)
func (*ImageRefs) AddImagesRef ¶ added in v0.9.0
func (ImageRefs) ImagesLock ¶ added in v0.13.0
func (i ImageRefs) ImagesLock() lockconfig.ImagesLock
func (*ImageRefs) LocalizeToRepo ¶ added in v0.13.0
func (*ImageRefs) MarkAsBundle ¶ added in v0.12.0
func (*ImageRefs) UpdateRelativeToRepo ¶ added in v0.13.0
func (i *ImageRefs) UpdateRelativeToRepo(imgRetriever ImagesMetadata, relativeToRepo string) (bool, error)
type ImagesLockReader ¶ added in v0.6.0
type ImagesLockReader interface {
Read(img regv1.Image) (lockconfig.ImagesLock, error)
}
type ImagesMetadata ¶ added in v0.15.0
type ImagesMetadataWriter ¶ added in v0.6.0
type LocationImageReader ¶ added in v0.9.0
type LocationImageReader interface {
Read(img regv1.Image) (ImageLocationsConfig, error)
}
type LocationsConfig ¶ added in v0.12.0
type LocationsConfig struct {
// contains filtered or unexported fields
}
func (LocationsConfig) Config ¶ added in v0.12.0
func (l LocationsConfig) Config() (ImageLocationsConfig, error)
type LocationsConfigs ¶ added in v0.12.0
type LocationsConfigs struct {
// contains filtered or unexported fields
}
func NewLocations ¶ added in v0.9.0
func NewLocations(ui util.UIWithLevels) *LocationsConfigs
NewLocations constructor for creating a LocationsConfigs
func NewLocationsWithReader ¶ added in v0.9.0
func NewLocationsWithReader(reader LocationImageReader, ui util.UIWithLevels) *LocationsConfigs
NewLocationsWithReader constructor for LocationsConfigs
func (LocationsConfigs) Fetch ¶ added in v0.12.0
func (r LocationsConfigs) Fetch(registry ImagesMetadata, bundleRef name.Digest) (ImageLocationsConfig, error)
func (LocationsConfigs) Save ¶ added in v0.12.0
func (r LocationsConfigs) Save(reg ImagesMetadataWriter, bundleRef name.Digest, config ImageLocationsConfig, ui ui.UI) error
type LocationsNotFound ¶ added in v0.9.0
type LocationsNotFound struct {
// contains filtered or unexported fields
}
func (LocationsNotFound) Error ¶ added in v0.9.0
func (n LocationsNotFound) Error() string
Source Files ¶
Click to show internal directories.
Click to hide internal directories.