Documentation ¶
Index ¶
- Constants
- func IsNotBundleError(err error) bool
- type Author
- type Bundle
- func (o *Bundle) AllImagesLockRefs(concurrency int, logger util.LoggerWithLevels) ([]*Bundle, ImageRefs, error)
- func (o *Bundle) Digest() string
- func (o *Bundle) DigestRef() string
- func (o *Bundle) FetchAllImagesRefs(concurrency int, ui Logger, sigFetcher SignatureFetcher) ([]*Bundle, error)
- func (o *Bundle) ImagesRefs() []ImageRef
- func (o *Bundle) IsBundle() (bool, error)
- func (o *Bundle) NestedBundles() []GraphNode
- func (o *Bundle) NoteCopy(processedImages *imageset.ProcessedImages, reg ImagesMetadataWriter, ...) error
- func (o *Bundle) Pull(outputPath string, logger Logger, pullNestedBundles bool) (bool, error)
- func (o *Bundle) Repo() string
- func (o *Bundle) Tag() string
- func (o *Bundle) UpdateImageRefs(bundles []*Bundle) error
- type Content
- type Contents
- type DescribeOpts
- type Description
- type GraphNode
- type ImageInfo
- 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 ImageType
- type ImagesLockReader
- type ImagesMetadata
- type ImagesMetadataWriter
- type LocationImageReader
- type LocationsConfig
- type LocationsConfigs
- func (r *LocationsConfigs) Fetch(registry ImagesMetadata, bundleRef name.Digest) (ImageLocationsConfig, error)
- func (r LocationsConfigs) LocationsImageDigest(registry ImagesMetadata, bundleRef name.Digest) (name.Digest, error)
- func (r LocationsConfigs) Save(reg ImagesMetadataWriter, bundleRef name.Digest, config ImageLocationsConfig, ...) error
- type LocationsNotFound
- type Logger
- type Metadata
- type NotFoundLocationsConfig
- type SignatureFetcher
- type Website
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"
)
Variables ¶
This section is empty.
Functions ¶
func IsNotBundleError ¶
Types ¶
type Bundle ¶
type Bundle struct {
// contains filtered or unexported fields
}
Bundle struct that represents a bundle
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) AllImagesLockRefs ¶ added in v0.26.0
func (o *Bundle) AllImagesLockRefs(concurrency int, logger util.LoggerWithLevels) ([]*Bundle, ImageRefs, error)
AllImagesLockRefs returns a flat list of nested bundles and every image reference for a specific bundle
func (*Bundle) FetchAllImagesRefs ¶ added in v0.26.0
func (o *Bundle) FetchAllImagesRefs(concurrency int, ui Logger, sigFetcher SignatureFetcher) ([]*Bundle, error)
FetchAllImagesRefs returns a flat list of nested bundles and every image reference for a specific bundle
func (*Bundle) ImagesRefs ¶ added in v0.26.0
ImagesRefs Retrieve the references for the Images of this particular bundle
func (*Bundle) NestedBundles ¶ added in v0.31.0
NestedBundles Provides information about the Graph of nested bundles associated with the current bundle
func (*Bundle) NoteCopy ¶
func (o *Bundle) NoteCopy(processedImages *imageset.ProcessedImages, reg ImagesMetadataWriter, ui util.LoggerWithLevels) error
NoteCopy writes an image-location representing the bundle / images that have been copied
func (*Bundle) Pull ¶
Pull Downloads bundle image to disk and checks if it can update the ImagesLock file
func (*Bundle) UpdateImageRefs ¶ added in v0.23.0
UpdateImageRefs updates the bundle cached images without talking to the registry
type Content ¶ added in v0.26.0
type Content struct { Bundles map[string]Description `json:"bundles,omitempty"` Images map[string]ImageInfo `json:"images,omitempty"` }
Content Contents present in a Bundle
type Contents ¶
type Contents struct {
// contains filtered or unexported fields
}
func NewContents ¶
func (Contents) PresentsAsBundle ¶
PresentsAsBundle checks if the provided folders have the needed structure to be a bundle
type DescribeOpts ¶ added in v0.26.0
DescribeOpts Options used when calling the Describe function
type Description ¶ added in v0.26.0
type Description struct { Image string `json:"image"` Origin string `json:"origin"` Annotations map[string]string `json:"annotations,omitempty"` Metadata Metadata `json:"metadata,omitempty"` Content Content `json:"content"` }
Description Metadata and Contents of a Bundle
func Describe ¶ added in v0.26.0
func Describe(bundleImage string, opts DescribeOpts, registryOpts registry.Opts) (Description, error)
Describe Given a Bundle URL fetch the information about the contents of the Bundle and Nested Bundles
func DescribeWithRegistryAndSignatureFetcher ¶ added in v0.26.0
func DescribeWithRegistryAndSignatureFetcher(bundleImage string, opts DescribeOpts, reg ImagesMetadata, sigFetcher SignatureFetcher) (Description, error)
DescribeWithRegistryAndSignatureFetcher Given a Bundle URL fetch the information about the contents of the Bundle and Nested Bundles
type ImageInfo ¶ added in v0.26.0
type ImageInfo struct { Image string `json:"image"` Origin string `json:"origin"` Annotations map[string]string `json:"annotations,omitempty"` ImageType ImageType `json:"imageType"` }
ImageInfo URLs where the image can be found as well as annotations provided in the Images Lock
type ImageLocation ¶
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 Copiable bool ImageType ImageType }
func NewBundleImageRef ¶ added in v0.26.0
func NewBundleImageRef(imgRef lockconfig.ImageRef) ImageRef
NewBundleImageRef Constructs a new ImageRef for Bundle
func NewContentImageRef ¶ added in v0.26.0
func NewContentImageRef(imgRef lockconfig.ImageRef) ImageRef
NewContentImageRef Constructs a new ImageRef for Image
func NewImageRefWithType ¶ added in v0.26.0
func NewImageRefWithType(imgRef lockconfig.ImageRef, imageType ImageType) ImageRef
NewImageRefWithType Constructs a new ImageRef based on the ImageType
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)
NewImageRefsFromImagesLock Create a new ImageRefs from the provided lockconfig.ImagesLock and ImageLocationsConfig
func (*ImageRefs) AddImagesRef ¶
func (ImageRefs) ImagesLock ¶
func (i ImageRefs) ImagesLock() lockconfig.ImagesLock
func (*ImageRefs) LocalizeToRepo ¶
func (*ImageRefs) MarkAsBundle ¶
func (*ImageRefs) UpdateRelativeToRepo ¶
func (i *ImageRefs) UpdateRelativeToRepo(imgRetriever ImagesMetadata, relativeToRepo string) (bool, error)
type ImageType ¶ added in v0.26.0
type ImageType string
ImageType defines the type of Image. This is an evolving list that might grow with time
const ( // BundleImage Image that represents a Bundle BundleImage ImageType = "Bundle" // ContentImage Image that is part of the Bundle ContentImage ImageType = "Image" // SignatureImage Image that contains a signature SignatureImage ImageType = "Signature" // InternalImage Image that contains a signature InternalImage ImageType = "Internal" )
type ImagesLockReader ¶
type ImagesLockReader interface {
Read(img regv1.Image) (lockconfig.ImagesLock, error)
}
type ImagesMetadata ¶
type ImagesMetadataWriter ¶
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.LoggerWithLevels) *LocationsConfigs
NewLocations constructor for creating a LocationsConfigs
func NewLocationsWithReader ¶
func NewLocationsWithReader(reader LocationImageReader, ui util.LoggerWithLevels) *LocationsConfigs
NewLocationsWithReader constructor for LocationsConfigs
func (*LocationsConfigs) Fetch ¶
func (r *LocationsConfigs) Fetch(registry ImagesMetadata, bundleRef name.Digest) (ImageLocationsConfig, error)
Fetch Retrieve the ImageLocationsConfig for a particular Bundle
func (LocationsConfigs) LocationsImageDigest ¶ added in v0.26.0
func (r LocationsConfigs) LocationsImageDigest(registry ImagesMetadata, bundleRef name.Digest) (name.Digest, error)
LocationsImageDigest Retrieve the Locations OCI Image Digest
func (LocationsConfigs) Save ¶
func (r LocationsConfigs) Save(reg ImagesMetadataWriter, bundleRef name.Digest, config ImageLocationsConfig, logger Logger) error
Save the locations information for the bundle in the registry This function will create an OCI Image that contains the Location information of all the images that are part of the Bundle
type LocationsNotFound ¶
type LocationsNotFound struct {
// contains filtered or unexported fields
}
func (LocationsNotFound) Error ¶
func (n LocationsNotFound) Error() string
type Logger ¶ added in v0.26.0
type Logger interface { Errorf(msg string, args ...interface{}) Warnf(msg string, args ...interface{}) Debugf(msg string, args ...interface{}) Tracef(msg string, args ...interface{}) Logf(msg string, args ...interface{}) }
Logger Interface used for logging
type Metadata ¶ added in v0.26.0
type Metadata struct { Metadata map[string]string `json:"metadata,omitempty"` Authors []Author `json:"authors,omitempty"` Websites []Website `json:"websites,omitempty"` }
Metadata Extra metadata present in a Bundle
type NotFoundLocationsConfig ¶ added in v0.23.1
type NotFoundLocationsConfig struct{}
NotFoundLocationsConfig Noop Locations Configuration retrieval
func (NotFoundLocationsConfig) Config ¶ added in v0.23.1
func (l NotFoundLocationsConfig) Config() (ImageLocationsConfig, error)
Config Returns a LocationsNotFound error
type SignatureFetcher ¶ added in v0.26.0
type SignatureFetcher interface {
FetchForImageRefs(images []lockconfig.ImageRef) ([]lockconfig.ImageRef, error)
}
SignatureFetcher Interface to retrieve signatures associated with Images