parse

Documentation

Index

• Constants
• func CleanCacheMount() error
• func GetBindMount(ctx *types.SystemContext, args []string, contextDir string, ...) (specs.Mount, string, error)
• func GetCacheMount(args []string, store storage.Store, imageMountLabel string, ...) (specs.Mount, *lockfile.LockFile, error)
• func GetTmpfsMount(args []string) (specs.Mount, error)
• func GetVolumes(ctx *types.SystemContext, store storage.Store, volumes []string, ...) ([]specs.Mount, []string, []*lockfile.LockFile, error)
• func RevertEscapedColon(source string) string
• func SplitStringWithColonEscape(str string) []string
• func UnlockLockArray(locks []*lockfile.LockFile)
• func ValidateVolumeMountHostDir(hostDir string) error
• func Volume(volume string) (specs.Mount, error)

Constants

const (
	// TypeTmpfs is the type for mounting tmpfs
	TypeTmpfs = "tmpfs"
	// TypeCache is the type for mounting a common persistent cache from host
	TypeCache = "cache"
	// mount=type=cache must create a persistent directory on host so its available for all consecutive builds.
	// Lifecycle of following directory will be inherited from how host machine treats temporary directory
	BuildahCacheDir = "buildah-cache"
	// mount=type=cache allows users to lock a cache store while its being used by another build
	BuildahCacheLockfile = "buildah-cache-lockfile"
	// All the lockfiles are stored in a separate directory inside `BuildahCacheDir`
	// Example `/var/tmp/buildah-cache/<target>/buildah-cache-lockfile`
	BuildahCacheLockfileDir = "buildah-cache-lockfiles"
)

Functions

func CleanCacheMount

func CleanCacheMount() error

CleanCacheMount gets the cache parent created by `--mount=type=cache` and removes it.

func GetBindMount

func GetBindMount(ctx *types.SystemContext, args []string, contextDir string, store storage.Store, imageMountLabel string, additionalMountPoints map[string]internal.StageMountDetails, workDir string) (specs.Mount, string, error)

GetBindMount parses a single bind mount entry from the --mount flag. Returns specifiedMount and a string which contains name of image that we mounted otherwise its empty. Caller is expected to perform unmount of any mounted images

func GetCacheMount

func GetCacheMount(args []string, store storage.Store, imageMountLabel string, additionalMountPoints map[string]internal.StageMountDetails, workDir string) (specs.Mount, *lockfile.LockFile, error)

GetCacheMount parses a single cache mount entry from the --mount flag.

If this function succeeds and returns a non-nil *lockfile.LockFile, the caller must unlock it (when??).

func GetTmpfsMount

func GetTmpfsMount(args []string) (specs.Mount, error)

GetTmpfsMount parses a single tmpfs mount entry from the --mount flag

func GetVolumes

func GetVolumes(ctx *types.SystemContext, store storage.Store, volumes []string, mounts []string, contextDir string, workDir string) ([]specs.Mount, []string, []*lockfile.LockFile, error)

GetVolumes gets the volumes from --volume and --mount

If this function succeeds, the caller must unlock the returned *lockfile.LockFile s if any (when??).

func RevertEscapedColon

func RevertEscapedColon(source string) string

RevertEscapedColon converts "\:" to ":"

func SplitStringWithColonEscape

func SplitStringWithColonEscape(str string) []string

SplitStringWithColonEscape splits string into slice by colon. Backslash-escaped colon (i.e. "\:") will not be regarded as separator

func UnlockLockArray

func UnlockLockArray(locks []*lockfile.LockFile)

UnlockLockArray is a helper for cleaning up after GetVolumes and the like.

func ValidateVolumeMountHostDir

func ValidateVolumeMountHostDir(hostDir string) error

ValidateVolumeMountHostDir validates the host path of buildah --volume

func Volume

func Volume(volume string) (specs.Mount, error)

Volume parses the input of --volume