carvelhelpers

Documentation

Overview

Package carvelhelpers implements wrapper functions to use carvel tooling

Index

• func CarvelPackageProcessor(pkgDir, image string, valuesFiles ...string) ([]byte, error)
• func DownloadImageAndSaveFilesToDir(imageWithTag, destinationDir string) error
• func DownloadImageBundleAndSaveFilesToTempDir(imageWithTag string) (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 NoopUI
  • func (ui NoopUI) DebugWriter() io.Writer
  • func (ui NoopUI) Debugf(str string, args ...interface{})
  • func (ui NoopUI) Printf(str string, args ...interface{})
  • func (ui NoopUI) Warnf(str string, args ...interface{})

Functions

func CarvelPackageProcessor

func CarvelPackageProcessor(pkgDir, image 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 DownloadImageBundleAndSaveFilesToTempDir

func DownloadImageBundleAndSaveFilesToTempDir(imageWithTag string) (string, error)

DownloadImageBundleAndSaveFilesToTempDir reads OCI image and saves file to temp dir returns temp configuration dir with downloaded imgpkg bundle

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 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(str string, args ...interface{})

Debugf noop debug

func (NoopUI) Printf

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

Printf noop print

func (NoopUI) Warnf

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

Warnf noop warn