Documentation
¶
Index ¶
- func Destination(opts *config.KanikoOptions, cacheKey string) (string, error)
- func IsAlreadyCached(err error) bool
- func IsExpired(err error) bool
- func IsNotFound(err error) bool
- func LocalSource(opts *config.CacheOptions, cacheKey string) (v1.Image, error)
- func ParseDockerfile(opts *config.WarmerOptions) ([]string, error)
- func WarmCache(opts *config.WarmerOptions) error
- type AlreadyCachedErr
- type ExpiredErr
- type FetchLocalSource
- type FetchRemoteImage
- type LayerCache
- type LayoutCache
- type NotFoundErr
- type RegistryCache
- type Warmer
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Destination ¶
func Destination(opts *config.KanikoOptions, cacheKey string) (string, error)
Destination returns the repo where the layer should be stored If no cache is specified, one is inferred from the destination provided
func IsAlreadyCached ¶ added in v0.16.0
IsAlreadyCached returns true if the supplied error is of the type AlreadyCachedErr otherwise it returns false.
func IsExpired ¶ added in v0.16.0
IsExpired returns true if the supplied error is of the type ExpiredErr otherwise it returns false.
func IsNotFound ¶ added in v0.16.0
IsNotFound returns true if the supplied error is of the type NotFoundErr otherwise it returns false.
func LocalSource ¶ added in v0.5.0
LocalSource retrieves a source image from a local cache given cacheKey
func ParseDockerfile ¶ added in v1.12.0
func ParseDockerfile(opts *config.WarmerOptions) ([]string, error)
func WarmCache ¶ added in v0.5.0
func WarmCache(opts *config.WarmerOptions) error
WarmCache populates the cache
Types ¶
type AlreadyCachedErr ¶ added in v0.16.0
type AlreadyCachedErr struct {
// contains filtered or unexported fields
}
AlreadyCachedErr is returned when the Docker image requested for caching is already present in the cache.
func (AlreadyCachedErr) Error ¶ added in v0.16.0
func (a AlreadyCachedErr) Error() string
type ExpiredErr ¶ added in v0.16.0
type ExpiredErr struct {
// contains filtered or unexported fields
}
ExpiredErr is returned when the requested Docker image is present in the cache, but is expired according to the supplied TTL.
func (ExpiredErr) Error ¶ added in v0.16.0
func (e ExpiredErr) Error() string
type FetchLocalSource ¶ added in v0.16.0
FetchLocalSource retrieves a Docker image manifest from a local source. github.com/GoogleContainerTools/kaniko/cache.LocalSource can be used as this type.
type FetchRemoteImage ¶ added in v0.16.0
type FetchRemoteImage func(image string, opts config.RegistryOptions, customPlatform string) (v1.Image, error)
FetchRemoteImage retrieves a Docker image manifest from a remote source. github.com/GoogleContainerTools/kaniko/image/remote.RetrieveRemoteImage can be used as this type.
type LayerCache ¶ added in v0.6.0
LayerCache is the layer cache
type LayoutCache ¶ added in v1.9.2
type LayoutCache struct {
Opts *config.KanikoOptions
}
LayoutCache is the OCI image layout cache
func (*LayoutCache) RetrieveLayer ¶ added in v1.9.2
func (lc *LayoutCache) RetrieveLayer(ck string) (v1.Image, error)
type NotFoundErr ¶ added in v0.16.0
type NotFoundErr struct {
// contains filtered or unexported fields
}
NotFoundErr is returned when the requested Docker image is not present in the cache.
func (NotFoundErr) Error ¶ added in v0.16.0
func (e NotFoundErr) Error() string
type RegistryCache ¶ added in v0.6.0
type RegistryCache struct {
Opts *config.KanikoOptions
}
RegistryCache is the registry cache
func (*RegistryCache) RetrieveLayer ¶ added in v0.6.0
func (rc *RegistryCache) RetrieveLayer(ck string) (v1.Image, error)
RetrieveLayer retrieves a layer from the cache given the cache key ck.
type Warmer ¶ added in v0.16.0
type Warmer struct {
Remote FetchRemoteImage
Local FetchLocalSource
TarWriter io.Writer
ManifestWriter io.Writer
}
Warmer is used to prepopulate the cache with a Docker image
func (*Warmer) Warm ¶ added in v0.16.0
Warm retrieves a Docker image and populates the supplied buffer with the image content and manifest or returns an AlreadyCachedErr if the image is present in the cache.
Example ¶
tarBuf := new(bytes.Buffer)
manifestBuf := new(bytes.Buffer)
w := &Warmer{
Remote: remote.RetrieveRemoteImage,
Local: LocalSource,
TarWriter: tarBuf,
ManifestWriter: manifestBuf,
}
options := &config.WarmerOptions{}
digest, err := w.Warm("ubuntu:latest", options)
if err != nil {
if !IsAlreadyCached(err) {
log.Fatal(err)
}
}
log.Printf("digest %v tar len %d\nmanifest:\n%s\n", digest, tarBuf.Len(), manifestBuf.String())
Output:
Source Files