carvelhelpers

Documentation

Overview

Package carvelhelpers implements wrapper functions to use carvel tooling

Index

• func CarvelPackageProcessor(pkgDir, _ string, valuesFiles ...string) ([]byte, error)
• func DownloadImageAndSaveFilesToDir(imageWithTag, destinationDir string) error
• func GetFilesMapFromImage(imageWithTag string) (map[string][]byte, error)
• func GetImageDigest(imageWithTag string) (string, string, error)
• func ProcessCarvelPackage(image string, valuesFiles ...string) ([]byte, error)
• func ProcessYTTPackage(configDirs ...string) ([]byte, error)
• func ResolveImagesInPackage(files []string) ([]byte, error)
• type ImageOperationOptions
  • func (i *ImageOperationOptions) CopyImageFromTar(sourceTarFile, destImageRepo string) error
  • func (i *ImageOperationOptions) CopyImageToTar(sourceImageName, destTarFile string) error
  • func (i *ImageOperationOptions) DownloadImageAndSaveFilesToDir(imageWithTag, destinationDir string) error
  • func (i *ImageOperationOptions) GetFileDigestFromImage(imageWithTag, fileName string) (string, error)
  • func (i *ImageOperationOptions) GetFilesMapFromImage(imageWithTag string) (map[string][]byte, error)
  • func (i *ImageOperationOptions) GetImageDigest(imageWithTag string) (string, string, error)
  • func (i *ImageOperationOptions) PushImage(imageWithTag string, filePaths []string) error
  • func (i *ImageOperationOptions) ResolveImage(imageWithTag string) error
• type ImageOperationsImpl
  • func NewImageOperationsImpl() ImageOperationsImpl
• type NoopUI
  • func (ui NoopUI) DebugWriter() io.Writer
  • func (ui NoopUI) Debugf(_ string, _ ...interface{})
  • func (ui NoopUI) Printf(_ string, _ ...interface{})
  • func (ui NoopUI) Warnf(_ string, _ ...interface{})

Functions

func CarvelPackageProcessor

func CarvelPackageProcessor(pkgDir, _ string, valuesFiles ...string) ([]byte, error)

CarvelPackageProcessor processes a carvel package and returns a configuration YAML file

func DownloadImageAndSaveFilesToDir

func DownloadImageAndSaveFilesToDir(imageWithTag, destinationDir string) error

DownloadImageAndSaveFilesToDir reads a plain OCI image and saves its files to the specified location.

func GetFilesMapFromImage

func GetFilesMapFromImage(imageWithTag string) (map[string][]byte, error)

GetFilesMapFromImage returns map of files metadata It takes os environment variables for custom repository and proxy configuration into account while downloading image from repository

func GetImageDigest

func GetImageDigest(imageWithTag string) (string, string, error)

GetImageDigest gets digest of the image

func ProcessCarvelPackage

func ProcessCarvelPackage(image string, valuesFiles ...string) ([]byte, error)

ProcessCarvelPackage processes a carvel package and returns a configuration YAML Downloads package to temporary directory and processes the package by implementing equivalent functionality as the command: `ytt -f <path> [-f <values-files>] | kbld -f -`

func ProcessYTTPackage

func ProcessYTTPackage(configDirs ...string) ([]byte, error)

ProcessYTTPackage processes configuration directory with ytt tool Implements similar functionality as `ytt -f <config-dir>`

func ResolveImagesInPackage

func ResolveImagesInPackage(files []string) ([]byte, error)

ResolveImagesInPackage resolves the images using kbld tool Implements similar functionality as `kbld -f <file1> -f <file2>`

Types

type ImageOperationOptions

type ImageOperationOptions struct{}

ImageOperationOptions implements the ImageOperationsImpl interface by using `imgpkg` library

func (*ImageOperationOptions) CopyImageFromTar

func (i *ImageOperationOptions) CopyImageFromTar(sourceTarFile, destImageRepo string) error

CopyImageFromTar publishes the image to destination repository from specified tar file This is equivalent to `imgpkg copy --tar <file> --to-repo <dest-repo>` command

func (*ImageOperationOptions) CopyImageToTar

func (i *ImageOperationOptions) CopyImageToTar(sourceImageName, destTarFile string) error

CopyImageToTar downloads the image as tar file This is equivalent to `imgpkg copy --image <image> --to-tar <tar-file-path>` command

func (*ImageOperationOptions) DownloadImageAndSaveFilesToDir

func (i *ImageOperationOptions) DownloadImageAndSaveFilesToDir(imageWithTag, destinationDir string) error

DownloadImageAndSaveFilesToDir reads a plain OCI image and saves its files to the specified location.

func (*ImageOperationOptions) GetFileDigestFromImage

func (i *ImageOperationOptions) GetFileDigestFromImage(imageWithTag, fileName string) (string, error)

GetFileDigestFromImage invokes `DownloadImageAndSaveFilesToDir` to fetch the image and returns the digest of the specified file

func (*ImageOperationOptions) GetFilesMapFromImage

func (i *ImageOperationOptions) GetFilesMapFromImage(imageWithTag string) (map[string][]byte, error)

GetFilesMapFromImage returns map of files metadata It takes os environment variables for custom repository and proxy configuration into account while downloading image from repository

func (*ImageOperationOptions) GetImageDigest

func (i *ImageOperationOptions) GetImageDigest(imageWithTag string) (string, string, error)

GetImageDigest gets digest of the image

func (*ImageOperationOptions) PushImage

func (i *ImageOperationOptions) PushImage(imageWithTag string, filePaths []string) error

PushImage publishes the image to the specified location

func (*ImageOperationOptions) ResolveImage

func (i *ImageOperationOptions) ResolveImage(imageWithTag string) error

ResolveImage invokes `imgpkg tag resolve -i <image>` command

type ImageOperationsImpl

type ImageOperationsImpl interface {
	// CopyImageToTar downloads the image as tar file
	// This is equivalent to `imgpkg copy --image <image> --to-tar <tar-file-path>` command
	CopyImageToTar(sourceImageName, destTarFile string) error
	// CopyImageFromTar publishes the image to destination repository from specified tar file
	// This is equivalent to `imgpkg copy --tar <file> --to-repo <dest-repo>` command
	CopyImageFromTar(sourceTarFile, destImageRepo string) error
	// DownloadImageAndSaveFilesToDir reads a plain OCI image and saves its
	// files to the specified location.
	DownloadImageAndSaveFilesToDir(imageWithTag, destinationDir string) error
	// GetFilesMapFromImage returns map of files metadata
	// It takes os environment variables for custom repository and proxy
	// configuration into account while downloading image from repository
	GetFilesMapFromImage(imageWithTag string) (map[string][]byte, error)
	// GetImageDigest gets digest of the image
	GetImageDigest(imageWithTag string) (string, string, error)
	// PushImage publishes the image to the specified location
	// This is equivalent to `imgpkg push -i <image> -f <filepath>`
	PushImage(imageWithTag string, filePaths []string) error
	// ResolveImage invokes `imgpkg tag resolve -i <image>` command
	ResolveImage(imageWithTag string) error
	// GetFileDigestFromImage invokes `DownloadImageAndSaveFilesToDir` to fetch the image and returns the digest of the specified file
	GetFileDigestFromImage(imageWithTag, fileName string) (string, error)
}

ImageOperationsImpl defines the helper functions for downloading, copying and processing oci images

func NewImageOperationsImpl

func NewImageOperationsImpl() ImageOperationsImpl

NewImageOperationsImpl creates new ImgpkgWrapper instance

type NoopUI

type NoopUI struct{}

NoopUI implement noop interface for logging used with carvel tooling

func (NoopUI) DebugWriter

func (ui NoopUI) DebugWriter() io.Writer

DebugWriter noop debug writer

func (NoopUI) Debugf

func (ui NoopUI) Debugf(_ string, _ ...interface{})

Debugf noop debug

func (NoopUI) Printf

func (ui NoopUI) Printf(_ string, _ ...interface{})

Printf noop print

func (NoopUI) Warnf

func (ui NoopUI) Warnf(_ string, _ ...interface{})

Warnf noop warn