Affected by 
Documentation
¶
Index ¶
- Constants
- func CleanCacheMount() error
- func GetBindMount(sys *types.SystemContext, args []string, contextDir string, ...) (specs.Mount, string, string, string, error)
- func GetCacheMount(args []string, additionalMountPoints map[string]internal.StageMountDetails, ...) (specs.Mount, string, *lockfile.LockFile, error)
- func GetTmpfsMount(args []string) (specs.Mount, error)
- func GetVolumes(ctx *types.SystemContext, store storage.Store, mountLabel string, ...) ([]specs.Mount, []string, []string, []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" )
Variables ¶
This section is empty.
Functions ¶
func CleanCacheMount ¶ added in v1.29.0
func CleanCacheMount() error
CleanCacheMount gets the cache parent created by `--mount=type=cache` and removes it.
func GetBindMount ¶
func GetBindMount(sys *types.SystemContext, args []string, contextDir string, store storage.Store, mountLabel string, additionalMountPoints map[string]internal.StageMountDetails, workDir, tmpDir string) (specs.Mount, string, string, string, error)
GetBindMount parses a single bind mount entry from the --mount flag.
Returns a Mount to add to the runtime spec's list of mounts, the ID of the image we mounted if we mounted one, the path of a mounted location if one needs to be unmounted and removed, and the path of an overlay mount if one needs to be cleaned up, or an error.
The caller is expected to, after the command which uses the mount exits, clean up the overlay filesystem (if we provided a path to it), unmount and remove the mountpoint for the mounted filesystem (if we provided the path to its mountpoint), and then unmount the image (if we mounted one).
func GetCacheMount ¶
func GetCacheMount(args []string, additionalMountPoints map[string]internal.StageMountDetails, workDir, tmpDir string) (specs.Mount, string, *lockfile.LockFile, error)
GetCacheMount parses a single cache mount entry from the --mount flag.
Returns a Mount to add to the runtime spec's list of mounts, the path of a mounted filesystem if one needs to be unmounted, and an optional lock that needs to be released, or an error.
The caller is expected to, after the command which uses the mount exits, unmount and remove the mountpoint of the mounted filesystem (if we provided the path to its mountpoint).
func GetTmpfsMount ¶
GetTmpfsMount parses a single tmpfs mount entry from the --mount flag
func GetVolumes ¶ added in v1.25.0
func GetVolumes(ctx *types.SystemContext, store storage.Store, mountLabel string, volumes []string, mounts []string, contextDir, workDir, tmpDir string) ([]specs.Mount, []string, []string, []string, []*lockfile.LockFile, error)
GetVolumes gets the volumes from --volume and --mount flags.
Returns a slice of Mounts to add to the runtime spec's list of mounts, the IDs of any images we mounted, a slice of bind-mounted paths, a slice of overlay directories and a slice of locks that we acquired, or an error.
The caller is expected to, after the command which uses the mounts and volumes exits, clean up the overlay directories, unmount and remove the mountpoints for the bind-mounted paths, unmount any images we mounted, and release the locks we returned if any.
func RevertEscapedColon ¶ added in v1.25.0
RevertEscapedColon converts "\:" to ":"
func SplitStringWithColonEscape ¶ added in v1.25.0
SplitStringWithColonEscape splits string into slice by colon. Backslash-escaped colon (i.e. "\:") will not be regarded as separator
func UnlockLockArray ¶ added in v1.26.9
UnlockLockArray is a helper for cleaning up after GetVolumes and the like.
func ValidateVolumeMountHostDir ¶ added in v1.25.0
ValidateVolumeMountHostDir validates the host path of buildah --volume
Types ¶
This section is empty.
Source Files