util

Documentation

Index

• Variables
• func AddVolumePathToWhitelist(path string)
• func CacheHasher() func(string) (string, error)
• func CheckWhitelist(path string) bool
• func ConfigureLogging(logLevel string) error
• func ContainsWildcards(paths []string) bool
• func CopyDir(src, dest, buildcontext string) ([]string, error)
• func CopyFile(src, dest, buildcontext string) (bool, error)
• func CopySymlink(src, dest, buildcontext string) (bool, error)
• func CreateFile(path string, reader io.Reader, perm os.FileMode, uid uint32, gid uint32) error
• func CreateTargetTarfile(tarpath string) (*os.File, error)
• func DeleteFilesystem() error
• func DestinationFilepath(src, dest, cwd string) (string, error)
• func DetectFilesystemWhitelist(path string) error
• func DownloadFileToDest(rawurl, dest string) error
• func ExtractFile(dest string, hdr *tar.Header, tr io.Reader) error
• func FilepathExists(path string) bool
• func GetBucketAndItem(context string) (string, string)
• func GetExcludedFiles(dockerfilepath string, buildcontext string) error
• func GetFSFromImage(root string, img v1.Image, extract ExtractFunction) ([]string, error)
• func GetUserFromUsername(userStr string, groupStr string) (string, string, error)
• func HasFilepathPrefix(path, prefix string, prefixMatchOnly bool) bool
• func Hasher() func(string) (string, error)
• func IsDestDir(path string) bool
• func IsFileLocalTarArchive(src string) bool
• func IsInWhitelist(path string) bool
• func IsSrcRemoteFileURL(rawurl string) bool
• func IsSrcsValid(srcsAndDest instructions.SourcesAndDest, resolvedSources []string, root string) error
• func MtimeHasher() func(string) (string, error)
• func ParentDirectories(path string) []string
• func ParentDirectoriesWithoutLeadingSlash(path string) []string
• func RelativeFiles(fp string, root string) ([]string, error)
• func ResolveEnvAndWildcards(sd instructions.SourcesAndDest, buildcontext string, envs []string) ([]string, string, error)
• func ResolveEnvironmentReplacement(value string, envs []string, isFilepath bool) (string, error)
• func ResolveEnvironmentReplacementList(values, envs []string, isFilepath bool) ([]string, error)
• func ResolveSources(srcs []string, root string) ([]string, error)
• func RetrieveSourceImage(stage config.KanikoStage, opts *config.KanikoOptions) (v1.Image, error)
• func SHA256(r io.Reader) (string, error)
• func URLDestinationFilepath(rawurl, dest, cwd string, envs []string) (string, error)
• func UnpackCompressedTar(path, dir string) error
• func UnpackLocalTarArchive(path, dest string) ([]string, error)
• func UpdateConfigEnv(newEnvs []instructions.KeyValuePair, config *v1.Config, ...) error
• func ValidAzureBlobStorageHost(context string) bool
• func Volumes() []string
• type ExtractFunction
• type Tar
  • func NewTar(f io.Writer) Tar
  • func (t *Tar) AddFileToTar(p string) error
  • func (t *Tar) Close()
  • func (t *Tar) Whiteout(p string) error
• type WhitelistEntry

Variables

var (
	// RetrieveRemoteImage downloads an image from a remote location
	RetrieveRemoteImage = remoteImage
)

Functions

func AddVolumePathToWhitelist

func AddVolumePathToWhitelist(path string)

AddVolumePath adds the given path to the volume whitelist.

func CacheHasher

func CacheHasher() func(string) (string, error)

CacheHasher takes into account everything the regular hasher does except for mtime

func CheckWhitelist

func CheckWhitelist(path string) bool

func ConfigureLogging

func ConfigureLogging(logLevel string) error

ConfigureLogging sets the logrus logging level and forces logs to be colorful (!)

func ContainsWildcards

func ContainsWildcards(paths []string) bool

ContainsWildcards returns true if any entry in paths contains wildcards

func CopyDir

func CopyDir(src, dest, buildcontext string) ([]string, error)

CopyDir copies the file or directory at src to dest It returns a list of files it copied over

func CopyFile

func CopyFile(src, dest, buildcontext string) (bool, error)

CopyFile copies the file at src to dest

func CopySymlink

func CopySymlink(src, dest, buildcontext string) (bool, error)

CopySymlink copies the symlink at src to dest

func CreateFile

func CreateFile(path string, reader io.Reader, perm os.FileMode, uid uint32, gid uint32) error

CreateFile creates a file at path and copies over contents from the reader

func CreateTargetTarfile

func CreateTargetTarfile(tarpath string) (*os.File, error)

CreateTargetTarfile creates target tar file for downloading the context file. Make directory if directory does not exist

func DeleteFilesystem

func DeleteFilesystem() error

DeleteFilesystem deletes the extracted image file system

func DestinationFilepath

func DestinationFilepath(src, dest, cwd string) (string, error)

DestinationFilepath returns the destination filepath from the build context to the image filesystem If source is a file:

If dest is a dir, copy it to /dest/relpath
If dest is a file, copy directly to dest

If source is a dir:

Assume dest is also a dir, and copy to dest/relpath

If dest is not an absolute filepath, add /cwd to the beginning

func DetectFilesystemWhitelist

func DetectFilesystemWhitelist(path string) error

Get whitelist from roots of mounted files Each line of /proc/self/mountinfo is in the form: 36 35 98:0 /mnt1 /mnt2 rw,noatime master:1 - ext3 /dev/root rw,errors=continue (1)(2)(3) (4) (5) (6) (7) (8) (9) (10) (11) Where (5) is the mount point relative to the process's root From: https://www.kernel.org/doc/Documentation/filesystems/proc.txt

func DownloadFileToDest

func DownloadFileToDest(rawurl, dest string) error

DownloadFileToDest downloads the file at rawurl to the given dest for the ADD command From add command docs:

1. If <src> is a remote file URL: - destination will have permissions of 0600 - If remote file has HTTP Last-Modified header, we set the mtime of the file to that timestamp

func ExtractFile

func ExtractFile(dest string, hdr *tar.Header, tr io.Reader) error

func FilepathExists

func FilepathExists(path string) bool

FilepathExists returns true if the path exists

func GetBucketAndItem

func GetBucketAndItem(context string) (string, string)

func GetExcludedFiles

func GetExcludedFiles(dockerfilepath string, buildcontext string) error

GetExcludedFiles gets a list of files to exclude from the .dockerignore

func GetFSFromImage

func GetFSFromImage(root string, img v1.Image, extract ExtractFunction) ([]string, error)

GetFSFromImage extracts the layers of img to root It returns a list of all files extracted

func GetUserFromUsername

func GetUserFromUsername(userStr string, groupStr string) (string, string, error)

func HasFilepathPrefix

func HasFilepathPrefix(path, prefix string, prefixMatchOnly bool) bool

HasFilepathPrefix checks if the given file path begins with prefix

func Hasher

func Hasher() func(string) (string, error)

Hasher returns a hash function, used in snapshotting to determine if a file has changed

func IsDestDir

func IsDestDir(path string) bool

func IsFileLocalTarArchive

func IsFileLocalTarArchive(src string) bool

IsFileLocalTarArchive returns true if the file is a local tar archive

func IsInWhitelist

func IsInWhitelist(path string) bool

func IsSrcRemoteFileURL

func IsSrcRemoteFileURL(rawurl string) bool

func IsSrcsValid

func IsSrcsValid(srcsAndDest instructions.SourcesAndDest, resolvedSources []string, root string) error

func MtimeHasher

func MtimeHasher() func(string) (string, error)

MtimeHasher returns a hash function, which only looks at mtime to determine if a file has changed. Note that the mtime can lag, so it's possible that a file will have changed but the mtime may look the same.

func ParentDirectories

func ParentDirectories(path string) []string

ParentDirectories returns a list of paths to all parent directories Ex. /some/temp/dir -> [/, /some, /some/temp, /some/temp/dir]

func ParentDirectoriesWithoutLeadingSlash

func ParentDirectoriesWithoutLeadingSlash(path string) []string

ParentDirectoriesWithoutLeadingSlash returns a list of paths to all parent directories all subdirectories do not contain a leading / Ex. /some/temp/dir -> [/, some, some/temp, some/temp/dir]

func RelativeFiles

func RelativeFiles(fp string, root string) ([]string, error)

RelativeFiles returns a list of all files at the filepath relative to root

func ResolveEnvAndWildcards

func ResolveEnvAndWildcards(sd instructions.SourcesAndDest, buildcontext string, envs []string) ([]string, string, error)

func ResolveEnvironmentReplacement

func ResolveEnvironmentReplacement(value string, envs []string, isFilepath bool) (string, error)

ResolveEnvironmentReplacement resolves replacing env variables in some text from envs It takes in a string representation of the command, the value to be resolved, and a list of envs (config.Env) Ex: value = $foo/newdir, envs = [foo=/foodir], then this should return /foodir/newdir The dockerfile/shell package handles processing env values It handles escape characters and supports expansion from the config.Env array Shlex handles some of the following use cases (these and more are tested in integration tests) ""a'b'c"" -> "a'b'c" "Rex\ The\ Dog \" -> "Rex The Dog" "a\"b" -> "a"b"

func ResolveEnvironmentReplacementList

func ResolveEnvironmentReplacementList(values, envs []string, isFilepath bool) ([]string, error)

ResolveEnvironmentReplacementList resolves a list of values by calling resolveEnvironmentReplacement

func ResolveSources

func ResolveSources(srcs []string, root string) ([]string, error)

ResolveSources resolves the given sources if the sources contains wildcards It returns a list of resolved sources

func RetrieveSourceImage

func RetrieveSourceImage(stage config.KanikoStage, opts *config.KanikoOptions) (v1.Image, error)

RetrieveSourceImage returns the base image of the stage at index

func SHA256

func SHA256(r io.Reader) (string, error)

SHA256 returns the shasum of the contents of r

func URLDestinationFilepath

func URLDestinationFilepath(rawurl, dest, cwd string, envs []string) (string, error)

URLDestinationFilepath gives the destination a file from a remote URL should be saved to

func UnpackCompressedTar

func UnpackCompressedTar(path, dir string) error

UnpackCompressedTar unpacks the compressed tar at path to dir

func UnpackLocalTarArchive

func UnpackLocalTarArchive(path, dest string) ([]string, error)

UnpackLocalTarArchive unpacks the tar archive at path to the directory dest Returns the files extracted from the tar archive

func UpdateConfigEnv

func UpdateConfigEnv(newEnvs []instructions.KeyValuePair, config *v1.Config, replacementEnvs []string) error

func ValidAzureBlobStorageHost

func ValidAzureBlobStorageHost(context string) bool

Validate if the host url provided is with correct suffix for AzureCloud, AzureChinaCloud, AzureGermanCloud and AzureUSGovernment RegEX for supported suffix defined in constants.AzureBlobStorageHostRegEx

func Volumes

func Volumes() []string

Types

type ExtractFunction

type ExtractFunction func(string, *tar.Header, io.Reader) error

type Tar

type Tar struct {
	// contains filtered or unexported fields
}

Tar knows how to write files to a tar file.

func NewTar

func NewTar(f io.Writer) Tar

NewTar will create an instance of Tar that can write files to the writer at f.

func (*Tar) AddFileToTar

func (t *Tar) AddFileToTar(p string) error

AddFileToTar adds the file at path p to the tar

func (*Tar) Close

func (t *Tar) Close()

Close will close any open streams used by Tar.

func (*Tar) Whiteout

func (t *Tar) Whiteout(p string) error

type WhitelistEntry

type WhitelistEntry struct {
	Path            string
	PrefixMatchOnly bool
}