B9.DiskImageBuilder

Effectful functions that create and convert disk image files.

Documentation

materializeImageSource :: ImageSource -> Image -> B9 ()

Create an image from an image source. The destination image must have a compatible image type and filesystem. The directory of the image MUST be present and the image file itself MUST NOT alredy exist.

substImageTarget :: [(String, String)] -> ImageTarget -> ImageTarget

Replace $... variables inside an ImageTarget

preferredDestImageTypes :: ImageSource -> B9 [ImageType]

Return all valid image types sorted by preference.

preferredSourceImageTypes :: ImageDestination -> [ImageType]

Return all supported source ImageTypes compatible to a ImageDestinaion in the preferred order.

resolveImageSource :: ImageSource -> B9 Image

Resolve an ImageSource to an Image. The ImageSource might not exist, as is the case for EmptyImage.

createDestinationImage :: Image -> ImageDestination -> B9 ()

Convert some Image, e.g. a temporary image used during the build phase to the final destination.

resizeImage :: ImageResize -> Image -> B9 ()

Resize an image, including the file system inside the image.

importImage :: Image -> Image -> B9 ()

Import a disk image from some external source into the build directory if necessary convert the image.

exportImage :: Image -> Image -> B9 ()

Export a disk image from the build directory; if necessary convert the image.

exportAndRemoveImage :: Image -> Image -> B9 ()

Export a disk image from the build directory; if necessary convert the image.

convertImage :: Image -> Image -> B9 ()

Convert an image in the build directory to another format and return the new image.

shareImage :: Image -> SharedImageName -> B9 SharedImage

Publish an sharedImage made from an image and image meta data to the configured repository

ensureAbsoluteImageDirExists :: Image -> B9 Image

Create the parent directories for the file that contains the Image. If the path to the image file is relative, prepend _buildDirRoot from the B9Config.

pushSharedImageLatestVersion :: SharedImageName -> B9 ()

Publish the latest version of a shared image identified by name to the selected repository from the cache.

lookupSharedImages :: (Repository -> Bool) -> (SharedImage -> Bool) -> B9 [(Repository, SharedImage)]

Find shared images and the associated repos from two predicates. The result is the concatenated result of the sorted shared images satisfying imgPred.

getSharedImages :: B9 [(Repository, [SharedImage])]

Return a list of all existing sharedImages from cached repositories.

getSharedImagesCacheDir :: B9 FilePath

Return the path to the sub directory in the cache that contains files of shared images.

getSelectedRepos :: B9 [RemoteRepo]

Return either all remote repos or just the single selected repo.

pullRemoteRepos :: B9 ()

Pull metadata files from all remote repositories.

pullLatestImage :: SharedImageName -> B9 (Maybe SharedImageBuildId)

Pull the latest version of an image, either from the selected remote repo or from the repo that has the latest version.