-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A tool and library for building virtual machine images.
--   
--   Build virtual machine images for vm-deployments; resize, un-partition,
--   create from scratch or convert disk image files in a variety of
--   formats; assemble and generate all associated files from templates and
--   regular files. VM images can further be modifed through scripts, which
--   are executed in LXC containers into which the vm-images as well as
--   arbitrary directories from the host are mounted. All assembled files
--   can also be accessed by vm build scripts through a special directory
--   mounted in the build container, and/or can be written to directories,
--   ISO- or VFAT-images. The ISO/VFAT images that B9 creates are
--   compatible to 'cloud-init's <a>NoCloud</a> data source; B9 is also
--   very well suited for compiling in a containerized environment. For
--   these applications, the images can be marked as <a>Transient</a> to
--   indicate no further interest in the VM-image itself, and B9 will
--   discard them after the build. B9 will never over-write source files,
--   not even large vm-image files - there is no intended way to modify a
--   source vm-image file 'in-place'. B9 operates in random build
--   directories, which are discarded when the build exists.
@package b9
@version 0.5.2


-- | Utility module to extract a primary partition from an MBR partition on
--   a raw image file.
module B9.MBR
getPartition :: Int -> FilePath -> IO (Word64, Word64)
data PrimaryPartition
PrimaryPartition :: !Word8 -> !CHS -> !Word8 -> !CHS -> !Word32 -> !Word32 -> PrimaryPartition
[primPartStatus] :: PrimaryPartition -> !Word8
[primPartChsStart] :: PrimaryPartition -> !CHS
[primPartPartType] :: PrimaryPartition -> !Word8
[primPartChsEnd] :: PrimaryPartition -> !CHS
[primPartLbaStart] :: PrimaryPartition -> !Word32
[primPartSectors] :: PrimaryPartition -> !Word32
data MBR
MBR :: !PrimaryPartition -> !PrimaryPartition -> !PrimaryPartition -> !PrimaryPartition -> MBR
[mbrPart1] :: MBR -> !PrimaryPartition
[mbrPart2] :: MBR -> !PrimaryPartition
[mbrPart3] :: MBR -> !PrimaryPartition
[mbrPart4] :: MBR -> !PrimaryPartition
data CHS
CHS :: !Word8 -> !Word8 -> !Word8 -> CHS
[chsH] :: CHS -> !Word8
[chs_CUpper2_S] :: CHS -> !Word8
[chs_CLower8] :: CHS -> !Word8
instance GHC.Show.Show B9.MBR.MBR
instance GHC.Show.Show B9.MBR.PrimaryPartition
instance GHC.Show.Show B9.MBR.CHS


-- | Function to find the file offsets of primary partitions in raw disk
--   images. Currently only MBR partitions are supported. See <a>MBR</a>
module B9.PartitionTable
getPartition :: Int -> FilePath -> IO (Word64, Word64, Word64)


-- | Some QuickCheck utility functions.
module B9.QCUtil
arbitraryEnv :: Arbitrary a => Gen [(String, a)]
halfSize :: Gen a -> Gen a
smaller :: Gen a -> Gen a
arbitraryFilePath :: Gen FilePath
arbitraryLetter :: Gen Char
arbitraryLetterUpper :: Gen Char
arbitraryLetterLower :: Gen Char
arbitraryDigit :: Gen Char


-- | Erlang term parser and pretty printer.
module B9.Content.ErlTerms

-- | Parse a subset of valid Erlang terms. It parses no maps and binaries
--   are restricted to either empty binaries or binaries with a string. The
--   input encoding must be restricted to ascii compatible 8-bit characters
--   (e.g. latin-1 or UTF8).
parseErlTerm :: String -> ByteString -> Either String SimpleErlangTerm

-- | Convert an abstract Erlang term to a pretty byte string preserving the
--   encoding.
renderErlTerm :: SimpleErlangTerm -> ByteString

-- | Simplified Erlang term representation.
data SimpleErlangTerm
ErlString :: String -> SimpleErlangTerm
ErlFloat :: Double -> SimpleErlangTerm
ErlNatural :: Integer -> SimpleErlangTerm
ErlAtom :: String -> SimpleErlangTerm
ErlChar :: Char -> SimpleErlangTerm
ErlBinary :: String -> SimpleErlangTerm
ErlList :: [SimpleErlangTerm] -> SimpleErlangTerm
ErlTuple :: [SimpleErlangTerm] -> SimpleErlangTerm
arbitraryErlSimpleAtom :: Gen SimpleErlangTerm
arbitraryErlString :: Gen SimpleErlangTerm
arbitraryErlNumber :: Gen SimpleErlangTerm
arbitraryErlNatural :: Gen SimpleErlangTerm
arbitraryErlFloat :: Gen SimpleErlangTerm
arbitraryErlNameChar :: Gen Char
instance Data.Data.Data B9.Content.ErlTerms.SimpleErlangTerm
instance GHC.Show.Show B9.Content.ErlTerms.SimpleErlangTerm
instance GHC.Read.Read B9.Content.ErlTerms.SimpleErlangTerm
instance GHC.Classes.Ord B9.Content.ErlTerms.SimpleErlangTerm
instance GHC.Classes.Eq B9.Content.ErlTerms.SimpleErlangTerm
instance Test.QuickCheck.Arbitrary.Arbitrary B9.Content.ErlTerms.SimpleErlangTerm


-- | Definition of <a>Script</a> and functions to convert <a>Script</a>s to
--   bash scripts.
module B9.ShellScript

-- | Convert <tt>script</tt> to bash-shell-script written to <tt>file</tt>
--   and make <tt>file</tt> executable.
writeSh :: FilePath -> Script -> IO ()

-- | Check if a script has the same effect as <a>NoOP</a>
emptyScript :: Script -> Bool
data CmdVerbosity
Debug :: CmdVerbosity
Verbose :: CmdVerbosity
OnlyStdErr :: CmdVerbosity
Quiet :: CmdVerbosity
data Cwd
Cwd :: FilePath -> Cwd
NoCwd :: Cwd
data User
User :: String -> User
NoUser :: User
data Script
In :: FilePath -> [Script] -> Script
As :: String -> [Script] -> Script
IgnoreErrors :: Bool -> [Script] -> Script
Verbosity :: CmdVerbosity -> [Script] -> Script
Begin :: [Script] -> Script
Run :: FilePath -> [String] -> Script
NoOP :: Script
instance GHC.Read.Read B9.ShellScript.Cmd
instance GHC.Show.Show B9.ShellScript.Cmd
instance GHC.Read.Read B9.ShellScript.User
instance GHC.Show.Show B9.ShellScript.User
instance GHC.Read.Read B9.ShellScript.Cwd
instance GHC.Show.Show B9.ShellScript.Cwd
instance GHC.Classes.Eq B9.ShellScript.Script
instance Data.Data.Data B9.ShellScript.Script
instance GHC.Read.Read B9.ShellScript.Script
instance GHC.Show.Show B9.ShellScript.Script
instance GHC.Classes.Eq B9.ShellScript.CmdVerbosity
instance Data.Data.Data B9.ShellScript.CmdVerbosity
instance GHC.Read.Read B9.ShellScript.CmdVerbosity
instance GHC.Show.Show B9.ShellScript.CmdVerbosity
instance GHC.Base.Monoid B9.ShellScript.Script


-- | Data types that describe all B9 relevant elements of virtual machine
--   disk images.
module B9.DiskImages

-- | Build target for disk images; the destination, format and size of the
--   image to generate, as well as how to create or obtain the image before
--   a <a>VmScript</a> is executed with the image mounted at a
--   <a>MountPoint</a>.
data ImageTarget
ImageTarget :: ImageDestination -> ImageSource -> MountPoint -> ImageTarget

-- | A mount point or <a>NotMounted</a>
data MountPoint
MountPoint :: FilePath -> MountPoint
NotMounted :: MountPoint

-- | The destination of an image.
data ImageDestination

-- | Create the image and some meta data so that other builds can use them
--   as <a>ImageSource</a>s via <a>From</a>.
Share :: String -> ImageType -> ImageResize -> ImageDestination

-- | <b>DEPRECATED</b> Export a raw image that can directly be booted.
LiveInstallerImage :: String -> FilePath -> ImageResize -> ImageDestination

-- | Write an image file to the path in the first argument., possible
--   resizing it,
LocalFile :: Image -> ImageResize -> ImageDestination

-- | Do not export the image. Usefule if the main objective of the b9 build
--   is not an image file, but rather some artifact produced by executing
--   by a containerize build.
Transient :: ImageDestination

-- | Specification of how the image to build is obtained.
data ImageSource

-- | Create an empty image file having a file system label (first
--   parameter), a file system type (e.g. <a>Ext4</a>) and an
--   <a>ImageSize</a>
EmptyImage :: String -> FileSystem -> ImageType -> ImageSize -> ImageSource

-- | <b>DEPRECATED</b>
CopyOnWrite :: Image -> ImageSource

-- | Clone an existing image file; if the image file contains partitions,
--   select the partition to use, b9 will extract that partition by reading
--   the offset of the partition from the partition table and extract it
--   using <tt>dd</tt>.
SourceImage :: Image -> Partition -> ImageResize -> ImageSource

-- | Use an image previously shared by via <a>Share</a>.
From :: String -> ImageResize -> ImageSource

-- | The partition to extract.
data Partition

-- | There is no partition table on the image
NoPT :: Partition

-- | Extract partition <tt>n</tt> <tt>n</tt> must be in <tt>0..3</tt>
Partition :: Int -> Partition

-- | A vm disk image file consisting of a path to the image file, and the
--   type and file system.
data Image
Image :: FilePath -> ImageType -> FileSystem -> Image
data ImageType
Raw :: ImageType
QCow2 :: ImageType
Vmdk :: ImageType
data FileSystem
NoFileSystem :: FileSystem
Ext4 :: FileSystem
ISO9660 :: FileSystem
VFAT :: FileSystem
data ImageSize
ImageSize :: Int -> SizeUnit -> ImageSize
data SizeUnit
B :: SizeUnit
KB :: SizeUnit
MB :: SizeUnit
GB :: SizeUnit

-- | How to resize an image file.
data ImageResize

-- | Resize the image <b>but not the file system</b>. Note that a file
--   system contained in the image file might be corrupted by this
--   operation. To not only resize the image file but also the fil system
--   contained in it, use <a>Resize</a>.
ResizeImage :: ImageSize -> ImageResize

-- | Resize an image and the contained file system.
Resize :: ImageSize -> ImageResize

-- | Resize an image and the contained file system to the smallest size to
--   fit the contents of the file system.
ShrinkToMinimum :: ImageResize

-- | Do not change the image size.
KeepSize :: ImageResize
type Mounted a = (a, MountPoint)
itImageDestination :: ImageTarget -> ImageDestination
itImageMountPoint :: ImageTarget -> MountPoint
isPartitioned :: Partition -> Bool
getPartition :: Partition -> Int

-- | Return the file name extension of an image file with a specific image
--   format.
imageFileExtension :: ImageType -> String
changeImageFormat :: ImageType -> Image -> Image
changeImageDirectory :: FilePath -> Image -> Image

-- | <a>SharedImage</a> holds all data necessary to identify an image
--   shared. Shared images are stored in <a>Repository</a>s.
data SharedImage
SharedImage :: SharedImageName -> SharedImageDate -> SharedImageBuildId -> ImageType -> FileSystem -> SharedImage

-- | Return the name of a shared image.
siName :: SharedImage -> String

-- | Shared images are orderd by name, build date and build id
newtype SharedImageName
SharedImageName :: String -> SharedImageName
newtype SharedImageDate
SharedImageDate :: String -> SharedImageDate
newtype SharedImageBuildId
SharedImageBuildId :: String -> SharedImageBuildId

-- | Return the disk image of an sharedImage
sharedImageImage :: SharedImage -> Image

-- | Calculate the path to the text file holding the serialized
--   <a>SharedImage</a> relative to the directory of shared images in a
--   repository.
sharedImageFileName :: SharedImage -> FilePath
sharedImagesRootDirectory :: FilePath
sharedImageFileExtension :: String
instance GHC.Show.Show B9.DiskImages.SharedImage
instance GHC.Read.Read B9.DiskImages.SharedImage
instance GHC.Classes.Eq B9.DiskImages.SharedImage
instance GHC.Show.Show B9.DiskImages.SharedImageBuildId
instance GHC.Read.Read B9.DiskImages.SharedImageBuildId
instance GHC.Classes.Ord B9.DiskImages.SharedImageBuildId
instance GHC.Classes.Eq B9.DiskImages.SharedImageBuildId
instance GHC.Show.Show B9.DiskImages.SharedImageDate
instance GHC.Read.Read B9.DiskImages.SharedImageDate
instance GHC.Classes.Ord B9.DiskImages.SharedImageDate
instance GHC.Classes.Eq B9.DiskImages.SharedImageDate
instance GHC.Show.Show B9.DiskImages.SharedImageName
instance GHC.Read.Read B9.DiskImages.SharedImageName
instance GHC.Classes.Ord B9.DiskImages.SharedImageName
instance GHC.Classes.Eq B9.DiskImages.SharedImageName
instance GHC.Classes.Eq B9.DiskImages.ImageTarget
instance Data.Data.Data B9.DiskImages.ImageTarget
instance GHC.Show.Show B9.DiskImages.ImageTarget
instance GHC.Read.Read B9.DiskImages.ImageTarget
instance GHC.Classes.Eq B9.DiskImages.ImageDestination
instance Data.Data.Data B9.DiskImages.ImageDestination
instance GHC.Show.Show B9.DiskImages.ImageDestination
instance GHC.Read.Read B9.DiskImages.ImageDestination
instance GHC.Classes.Eq B9.DiskImages.ImageSource
instance Data.Data.Data B9.DiskImages.ImageSource
instance GHC.Read.Read B9.DiskImages.ImageSource
instance GHC.Show.Show B9.DiskImages.ImageSource
instance Data.Data.Data B9.DiskImages.ImageResize
instance GHC.Read.Read B9.DiskImages.ImageResize
instance GHC.Show.Show B9.DiskImages.ImageResize
instance GHC.Classes.Eq B9.DiskImages.ImageResize
instance Data.Data.Data B9.DiskImages.ImageSize
instance GHC.Read.Read B9.DiskImages.ImageSize
instance GHC.Show.Show B9.DiskImages.ImageSize
instance GHC.Classes.Eq B9.DiskImages.ImageSize
instance Data.Data.Data B9.DiskImages.SizeUnit
instance GHC.Classes.Ord B9.DiskImages.SizeUnit
instance GHC.Read.Read B9.DiskImages.SizeUnit
instance GHC.Show.Show B9.DiskImages.SizeUnit
instance GHC.Classes.Eq B9.DiskImages.SizeUnit
instance Data.Data.Data B9.DiskImages.Image
instance GHC.Read.Read B9.DiskImages.Image
instance GHC.Show.Show B9.DiskImages.Image
instance GHC.Classes.Eq B9.DiskImages.Image
instance Data.Data.Data B9.DiskImages.FileSystem
instance GHC.Read.Read B9.DiskImages.FileSystem
instance GHC.Show.Show B9.DiskImages.FileSystem
instance GHC.Classes.Eq B9.DiskImages.FileSystem
instance GHC.Show.Show B9.DiskImages.ImageType
instance Data.Data.Data B9.DiskImages.ImageType
instance GHC.Read.Read B9.DiskImages.ImageType
instance GHC.Classes.Eq B9.DiskImages.ImageType
instance Data.Data.Data B9.DiskImages.Partition
instance GHC.Read.Read B9.DiskImages.Partition
instance GHC.Show.Show B9.DiskImages.Partition
instance GHC.Classes.Eq B9.DiskImages.Partition
instance GHC.Classes.Eq B9.DiskImages.MountPoint
instance Data.Data.Data B9.DiskImages.MountPoint
instance GHC.Read.Read B9.DiskImages.MountPoint
instance GHC.Show.Show B9.DiskImages.MountPoint
instance GHC.Classes.Ord B9.DiskImages.SharedImage


-- | Data types describing the execution environment of virtual machine
--   builds. <a>ExecEnv</a>, <a>Resources</a> and <a>SharedDirectory</a>
--   describe how <a>B9.LibVirtLXC</a> should configure and execute build
--   scripts, as defined in <a>B9.ShellScript</a> and <a>B9.Vm</a>.
module B9.ExecEnv
data ExecEnv
ExecEnv :: String -> [Mounted Image] -> [SharedDirectory] -> Resources -> ExecEnv
[envName] :: ExecEnv -> String
[envImageMounts] :: ExecEnv -> [Mounted Image]
[envSharedDirectories] :: ExecEnv -> [SharedDirectory]
[envResources] :: ExecEnv -> Resources
data Resources
Resources :: RamSize -> Int -> CPUArch -> Resources
[maxMemory] :: Resources -> RamSize
[cpuCount] :: Resources -> Int
[cpuArch] :: Resources -> CPUArch
noResources :: Resources
data SharedDirectory
SharedDirectory :: FilePath -> MountPoint -> SharedDirectory
SharedDirectoryRO :: FilePath -> MountPoint -> SharedDirectory
SharedSources :: MountPoint -> SharedDirectory
data CPUArch
X86_64 :: CPUArch
I386 :: CPUArch
data RamSize
RamSize :: Int -> SizeUnit -> RamSize
AutomaticRamSize :: RamSize
instance Data.Data.Data B9.ExecEnv.Resources
instance GHC.Show.Show B9.ExecEnv.Resources
instance GHC.Read.Read B9.ExecEnv.Resources
instance Data.Data.Data B9.ExecEnv.RamSize
instance GHC.Classes.Ord B9.ExecEnv.RamSize
instance GHC.Show.Show B9.ExecEnv.RamSize
instance GHC.Read.Read B9.ExecEnv.RamSize
instance GHC.Classes.Eq B9.ExecEnv.RamSize
instance GHC.Classes.Eq B9.ExecEnv.CPUArch
instance Data.Data.Data B9.ExecEnv.CPUArch
instance GHC.Show.Show B9.ExecEnv.CPUArch
instance GHC.Read.Read B9.ExecEnv.CPUArch
instance GHC.Classes.Eq B9.ExecEnv.SharedDirectory
instance Data.Data.Data B9.ExecEnv.SharedDirectory
instance GHC.Show.Show B9.ExecEnv.SharedDirectory
instance GHC.Read.Read B9.ExecEnv.SharedDirectory
instance GHC.Base.Monoid B9.ExecEnv.Resources
instance GHC.Base.Monoid B9.ExecEnv.CPUArch
instance GHC.Base.Monoid B9.ExecEnv.RamSize


-- | Extensions to <a>ConfigFile</a> and utility functions for dealing with
--   configuration in general and reading/writing files.
module B9.ConfigUtils
allOn :: (a -> Maybe Bool) -> a -> a -> Maybe Bool
lastOn :: (a -> Maybe b) -> a -> a -> Maybe b
data SystemPath
Path :: FilePath -> SystemPath
InHomeDir :: FilePath -> SystemPath
InB9UserDir :: FilePath -> SystemPath
InTempDir :: FilePath -> SystemPath
resolve :: MonadIO m => SystemPath -> m FilePath
ensureDir :: MonadIO m => FilePath -> m ()
readIniFile :: MonadIO m => SystemPath -> m ConfigParser
getOptionM :: (Get_C a, Read a) => ConfigParser -> SectionSpec -> OptionSpec -> Maybe a
getOption :: (Get_C a, Monoid a) => ConfigParser -> SectionSpec -> OptionSpec -> a
getOptionOr :: (Get_C a, Read a) => ConfigParser -> SectionSpec -> OptionSpec -> a -> a
data IniFileException
IniFileException :: FilePath -> CPError -> IniFileException
newtype UUID
UUID :: (Word32, Word16, Word16, Word16, Word32, Word16) -> UUID
randomUUID :: MonadIO m => m UUID
tell :: (MonadIO m, Show a) => FilePath -> a -> m ()
consult :: (MonadIO m, Read a) => FilePath -> m a

-- | Get all files from <tt>dir</tt> that is get ONLY files not directories
getDirectoryFiles :: MonadIO m => FilePath -> m [FilePath]
maybeConsult :: (MonadIO m, Read a) => Maybe FilePath -> a -> m a
maybeConsultSystemPath :: (MonadIO m, Read a) => Maybe SystemPath -> a -> m a
instance GHC.Classes.Ord B9.ConfigUtils.UUID
instance GHC.Classes.Eq B9.ConfigUtils.UUID
instance GHC.Show.Show B9.ConfigUtils.UUID
instance GHC.Read.Read B9.ConfigUtils.UUID
instance GHC.Show.Show B9.ConfigUtils.IniFileException
instance GHC.Show.Show B9.ConfigUtils.ReaderException
instance Data.Data.Data B9.ConfigUtils.SystemPath
instance GHC.Show.Show B9.ConfigUtils.SystemPath
instance GHC.Read.Read B9.ConfigUtils.SystemPath
instance GHC.Classes.Eq B9.ConfigUtils.SystemPath
instance GHC.Exception.Exception B9.ConfigUtils.ReaderException
instance GHC.Exception.Exception B9.ConfigUtils.IniFileException
instance Text.Printf.PrintfArg B9.ConfigUtils.UUID


-- | B9 has a concept of <a>SharedImaged</a>. Shared images can be pulled
--   and pushed to/from remote locations via rsync+ssh. B9 also maintains a
--   local cache; the whole thing is supposed to be build-server-safe, that
--   means no two builds shall interfere with each other. This is
--   accomplished by refraining from automatic cache updates from/to remote
--   repositories.
module B9.Repository
data RemoteRepo
RemoteRepo :: String -> FilePath -> SshPrivKey -> SshRemoteHost -> SshRemoteUser -> RemoteRepo
remoteRepoRepoId :: RemoteRepo -> String
newtype RepoCache
RepoCache :: FilePath -> RepoCache
newtype SshPrivKey
SshPrivKey :: FilePath -> SshPrivKey
newtype SshRemoteHost
SshRemoteHost :: (String, Int) -> SshRemoteHost
newtype SshRemoteUser
SshRemoteUser :: String -> SshRemoteUser

-- | Initialize the local repository cache directory.
initRepoCache :: MonadIO m => SystemPath -> m RepoCache

-- | Initialize the repository; load the corresponding settings from the
--   config file, check that the priv key exists and create the
--   correspondig cache directory.
initRemoteRepo :: MonadIO m => RepoCache -> RemoteRepo -> m RemoteRepo

-- | Check for existance of priv-key and make it an absolute path.
remoteRepoCheckSshPrivKey :: MonadIO m => RemoteRepo -> m RemoteRepo

-- | Return the cache directory for a remote repository relative to the
--   root cache dir.
remoteRepoCacheDir :: RepoCache -> String -> FilePath

-- | Return the local repository directory.
localRepoDir :: RepoCache -> FilePath

-- | Persist a repo to a configuration file.
writeRemoteRepoConfig :: RemoteRepo -> ConfigParser -> Either CPError ConfigParser
getConfiguredRemoteRepos :: ConfigParser -> [RemoteRepo]

-- | Load a repository from a configuration file that has been written by
--   <tt>writeRepositoryToB9Config</tt>.
lookupRemoteRepo :: [RemoteRepo] -> String -> Maybe RemoteRepo
instance Data.Data.Data B9.Repository.RemoteRepo
instance GHC.Show.Show B9.Repository.RemoteRepo
instance GHC.Read.Read B9.Repository.RemoteRepo
instance Data.Data.Data B9.Repository.SshRemoteUser
instance GHC.Show.Show B9.Repository.SshRemoteUser
instance GHC.Read.Read B9.Repository.SshRemoteUser
instance Data.Data.Data B9.Repository.SshRemoteHost
instance GHC.Show.Show B9.Repository.SshRemoteHost
instance GHC.Read.Read B9.Repository.SshRemoteHost
instance Data.Data.Data B9.Repository.SshPrivKey
instance GHC.Show.Show B9.Repository.SshPrivKey
instance GHC.Read.Read B9.Repository.SshPrivKey
instance Data.Data.Data B9.Repository.RepoCache
instance GHC.Show.Show B9.Repository.RepoCache
instance GHC.Read.Read B9.Repository.RepoCache


-- | Utility functions based on <a>Template</a> to offer <tt> $var </tt>
--   variable expansion in string throughout a B9 artifact.
module B9.Content.StringTemplate
subst :: [(String, String)] -> String -> String
substE :: [(String, String)] -> String -> Either String String
substEB :: [(String, String)] -> ByteString -> Either String ByteString
substFile :: MonadIO m => [(String, String)] -> FilePath -> FilePath -> m ()
substPath :: [(String, String)] -> SystemPath -> SystemPath
readTemplateFile :: (MonadIO m, MonadReader Environment m) => SourceFile -> m ByteString

-- | A wrapper around a file path and a flag indicating if template
--   variable expansion should be performed when reading the file contents.
data SourceFile
Source :: SourceFileConversion -> FilePath -> SourceFile
data SourceFileConversion
NoConversion :: SourceFileConversion
ExpandVariables :: SourceFileConversion
data Environment
Environment :: [(String, String)] -> Environment
withEnvironment :: [(String, String)] -> ReaderT Environment m a -> m a
instance GHC.Classes.Eq B9.Content.StringTemplate.SourceFile
instance Data.Data.Data B9.Content.StringTemplate.SourceFile
instance GHC.Show.Show B9.Content.StringTemplate.SourceFile
instance GHC.Read.Read B9.Content.StringTemplate.SourceFile
instance GHC.Classes.Eq B9.Content.StringTemplate.SourceFileConversion
instance Data.Data.Data B9.Content.StringTemplate.SourceFileConversion
instance GHC.Show.Show B9.Content.StringTemplate.SourceFileConversion
instance GHC.Read.Read B9.Content.StringTemplate.SourceFileConversion
instance Test.QuickCheck.Arbitrary.Arbitrary B9.Content.StringTemplate.SourceFile


-- | Definition of <a>VmScript</a> an artifact encapsulating several
--   virtual machines disk images that can be mounted in an execution
--   environment like <a>B9.LibVirtLXC</a>. A <a>VmScript</a> is embedded
--   by in an <a>ArtifactGenerator</a>.
module B9.Vm

-- | Describe a virtual machine, i.e. a set up disk images to create and a
--   shell script to put things together.
data VmScript
VmScript :: CPUArch -> [SharedDirectory] -> Script -> VmScript
NoVmScript :: VmScript
substVmScript :: [(String, String)] -> VmScript -> VmScript
instance GHC.Classes.Eq B9.Vm.VmScript
instance Data.Data.Data B9.Vm.VmScript
instance GHC.Show.Show B9.Vm.VmScript
instance GHC.Read.Read B9.Vm.VmScript


-- | B9 produces not only VM-Images but also text documents such as
--   configuration files required by virtual machines. This module is about
--   creating and merging files containing parsable syntactic structures,
--   such as most configuration files do.
--   
--   Imagine you would want to create a cloud-init 'user-data' file from a
--   set of 'user-data' snippets which each are valid 'user-data' files in
--   yaml syntax and e.g. a <tt>writefiles</tt> section. Now the goal is,
--   for b9 to be able to merge these snippets into one, such that all
--   writefiles sections are combined into a single writefile section.
--   Another example is OTP/Erlang sys.config files. This type class is the
--   greatest commonon denominator of types describing a syntax that can be
--   parsed, concatenated e.g. like in the above example and rendered. The
--   actual concatenation operation is the append from Monoid, i.e. like
--   monoid but without the need for an empty element.
module B9.Content.AST

-- | Types of values that can be parsed<i>rendered from</i>to
--   <tt>ByteString</tt>s. This class is used as basis for the
--   <a>ASTish</a> class.
class (Semigroup a) => ConcatableSyntax a
decodeSyntax :: ConcatableSyntax a => FilePath -> ByteString -> Either String a
encodeSyntax :: ConcatableSyntax a => a -> ByteString

-- | Types of values that describe content, that can be created from an
--   <a>AST</a>.
class (ConcatableSyntax a) => ASTish a
fromAST :: (ASTish a, CanRender c, Applicative m, Monad m, MonadIO m, MonadReader Environment m) => AST c a -> m a

-- | Describe how to create structured content that has a tree-like
--   syntactic structure, e.g. yaml, JSON and erlang-proplists. The first
--   parameter defines a <i>context</i> into which the <a>AST</a> is
--   embeded, e.g. B9.Content.Generator.Content'. The second parameter
--   defines a specifix syntax, e.g <a>ErlangPropList</a> that the
--   <a>AST</a> value generates.
data AST c a

-- | Create an object similar to a Json object.
ASTObj :: [(String, AST c a)] -> AST c a

-- | An array.
ASTArr :: [AST c a] -> AST c a

-- | Merge the nested elements, this is a very powerful tool that allows to
--   combine several inputs in a smart and safe way, e.g. by merging the
--   values of the same fields in yaml objects.
ASTMerge :: [AST c a] -> AST c a
ASTEmbed :: c -> AST c a
ASTString :: String -> AST c a
ASTParse :: SourceFile -> AST c a
AST :: a -> AST c a

-- | Types of values that can be <i>rendered</i> into a <tt>ByteString</tt>
class CanRender c
render :: (CanRender c, Functor m, Applicative m, MonadIO m, MonadReader Environment m) => c -> m ByteString
instance (GHC.Classes.Eq c, GHC.Classes.Eq a) => GHC.Classes.Eq (B9.Content.AST.AST c a)
instance (Data.Data.Data c, Data.Data.Data a) => Data.Data.Data (B9.Content.AST.AST c a)
instance (GHC.Show.Show c, GHC.Show.Show a) => GHC.Show.Show (B9.Content.AST.AST c a)
instance (GHC.Read.Read c, GHC.Read.Read a) => GHC.Read.Read (B9.Content.AST.AST c a)
instance B9.Content.AST.ConcatableSyntax Data.ByteString.Internal.ByteString
instance (Test.QuickCheck.Arbitrary.Arbitrary c, Test.QuickCheck.Arbitrary.Arbitrary a) => Test.QuickCheck.Arbitrary.Arbitrary (B9.Content.AST.AST c a)


-- | A wrapper around erlang and yaml syntax with a proplist-like behaviour
--   in the ConcatableSyntax instances
module B9.Content.ErlangPropList

-- | A wrapper type around erlang terms with a Semigroup instance useful
--   for combining sys.config files with OTP-application configurations in
--   a list of the form of a proplist.
data ErlangPropList
ErlangPropList :: SimpleErlangTerm -> ErlangPropList
instance Data.Data.Data B9.Content.ErlangPropList.ErlangPropList
instance GHC.Show.Show B9.Content.ErlangPropList.ErlangPropList
instance GHC.Classes.Eq B9.Content.ErlangPropList.ErlangPropList
instance GHC.Read.Read B9.Content.ErlangPropList.ErlangPropList
instance Test.QuickCheck.Arbitrary.Arbitrary B9.Content.ErlangPropList.ErlangPropList
instance Data.Semigroup.Semigroup B9.Content.ErlangPropList.ErlangPropList
instance B9.Content.AST.ConcatableSyntax B9.Content.ErlangPropList.ErlangPropList
instance B9.Content.AST.ASTish B9.Content.ErlangPropList.ErlangPropList


-- | A wrapper around erlang and yaml syntax with a proplist-like behaviour
--   in the ConcatableSyntax instances
module B9.Content.YamlObject

-- | A wrapper type around yaml values with a Semigroup instance useful for
--   combining yaml documents describing system configuration like e.g.
--   user-data.
data YamlObject
YamlObject :: Value -> YamlObject
instance GHC.Classes.Eq B9.Content.YamlObject.YamlObject
instance GHC.Read.Read B9.Content.YamlObject.YamlObject
instance GHC.Show.Show B9.Content.YamlObject.YamlObject
instance Data.Semigroup.Semigroup B9.Content.YamlObject.YamlObject
instance B9.Content.AST.ConcatableSyntax B9.Content.YamlObject.YamlObject
instance B9.Content.AST.ASTish B9.Content.YamlObject.YamlObject
instance Test.QuickCheck.Arbitrary.Arbitrary B9.Content.YamlObject.YamlObject


-- | The basic data structure that ties together syntax trees making them
--   composable and addressable in B9 artifacts.
module B9.Content.Generator
data Content
RenderErlang :: (AST Content ErlangPropList) -> Content
RenderYaml :: (AST Content YamlObject) -> Content
FromTextFile :: SourceFile -> Content
instance GHC.Classes.Eq B9.Content.Generator.Content
instance GHC.Show.Show B9.Content.Generator.Content
instance GHC.Read.Read B9.Content.Generator.Content
instance Test.QuickCheck.Arbitrary.Arbitrary B9.Content.Generator.Content
instance B9.Content.AST.CanRender B9.Content.Generator.Content


-- | Top-Level data types for B9 build artifacts.
module B9.ArtifactGenerator

-- | Artifacts represent the things B9 can build. A generator specifies
--   howto generate parameterized, multiple artifacts. The general
--   structure is:
--   
--   <pre>
--   Let [ ... bindings ... ]
--       [ Sources
--           [ ... list all input files ... ]
--           [ Artifact ...
--           , Artifact ...
--           , Let [ ... ] [ ... ]
--           ]
--       ]
--   </pre>
--   
--   The reasons why <a>Sources</a> takes a list of
--   <a>ArtifactGenerator</a>s is that 1. this makes the value easier to
--   read/write for humans 2. the sources are static files used in all
--   children (e.g. company logo image) 3. the sources are parameterized by
--   variables that bound to different values for each artifact, e.g. a
--   template network config file which contains the host IP address.
--   
--   To bind such variables use <a>Let</a>, <a>Each</a>, <a>LetX</a> or
--   <a>EachT</a>.
--   
--   String subtitution of these variables is done by
--   <a>B9.Content.StringTemplate</a>. These variables can be used as value
--   in nested <a>Let</a>s, in most file names/paths and in source files
--   added with <a>SourceFile</a>
data ArtifactGenerator

-- | Add sources available to <a>ArtifactAssembly</a>s in nested artifact
--   generators.
Sources :: [ArtifactSource] -> [ArtifactGenerator] -> ArtifactGenerator

-- | Bind variables, variables are avaible in nested generators.
Let :: [(String, String)] -> [ArtifactGenerator] -> ArtifactGenerator

-- | A <a>Let</a> where each variable is assigned to each value; the nested
--   generator is executed for each permutation.
--   
--   <pre>
--   LetX [("x", ["1","2","3"]), ("y", ["a","b"])] [..]
--   </pre>
--   
--   Is equal to:
--   
--   <pre>
--   Let [] [
--     Let [("x", "1"), ("y", "a")] [..]
--     Let [("x", "1"), ("y", "b")] [..]
--     Let [("x", "2"), ("y", "a")] [..]
--     Let [("x", "2"), ("y", "b")] [..]
--     Let [("x", "3"), ("y", "a")] [..]
--     Let [("x", "3"), ("y", "b")] [..]
--   ]
--   </pre>
LetX :: [(String, [String])] -> [ArtifactGenerator] -> ArtifactGenerator

-- | Bind each variable to their first value, then each variable to the
--   second value, etc ... and execute the nested generator in every step.
--   <a>LetX</a> represents a product of all variables, whereas <a>Each</a>
--   represents a sum of variable bindings - <a>Each</a> is more like a
--   <i>zip</i> whereas <a>LetX</a> is more like a list comprehension.
Each :: [(String, [String])] -> [ArtifactGenerator] -> ArtifactGenerator

-- | The transposed verison of <a>Each</a>: Bind the variables in the first
--   list to each a set of values from the second argument; execute the
--   nested generators for each binding
EachT :: [String] -> [[String]] -> [ArtifactGenerator] -> ArtifactGenerator

-- | Generate an artifact defined by an <a>ArtifactAssembly</a>; the
--   assembly can access the files created from the <a>Sources</a> and
--   variables bound by <a>Let</a>ish elements. An artifact has an instance
--   id, that is a unique, human readable string describing the artifact to
--   assemble.
Artifact :: InstanceId -> ArtifactAssembly -> ArtifactGenerator
EmptyArtifact :: ArtifactGenerator

-- | Describe how input files for artifacts to build are obtained. The
--   general structure of each constructor is <b>FromXXX</b>
--   <i>destination</i> <i>source</i>
data ArtifactSource

-- | Copy a <a>SourceFile</a> potentially replacing variabled defined in
--   <a>Let</a>-like parent elements.
FromFile :: FilePath -> SourceFile -> ArtifactSource

-- | Create a file from some <a>Content</a>
FromContent :: FilePath -> Content -> ArtifactSource

-- | Set the unix <i>file permissions</i> to all files generated by the
--   nested list of <a>ArtifactSource</a>s.
SetPermissions :: Int -> Int -> Int -> [ArtifactSource] -> ArtifactSource

-- | Assume a local directory as starting point for all relative source
--   files in the nested <a>ArtifactSource</a>s.
FromDirectory :: FilePath -> [ArtifactSource] -> ArtifactSource

-- | Specify an output directory for all the files generated by the nested
--   <a>ArtifactSource</a>s
IntoDirectory :: FilePath -> [ArtifactSource] -> ArtifactSource

-- | <b>Deprecated</b> Concatenate the files generated by the nested
--   <a>ArtifactSource</a>s. The nested, generated files are not written
--   when they are concatenated.
Concatenation :: FilePath -> [ArtifactSource] -> ArtifactSource

-- | Identify an artifact. <b>Deprecated</b> TODO: B9 does not check if all
--   instances IDs are unique.
newtype InstanceId
IID :: String -> InstanceId
data ArtifactTarget
CloudInitTarget :: CloudInitType -> FilePath -> ArtifactTarget
VmImagesTarget :: ArtifactTarget
data CloudInitType
CI_ISO :: CloudInitType
CI_VFAT :: CloudInitType
CI_DIR :: CloudInitType

-- | Define an <b>output</b> of a build. Assemblies are nested into
--   <a>ArtifactGenerator</a>s. They contain all the files defined by the
--   <a>Sources</a> they are nested into.
data ArtifactAssembly

-- | Generate a <b>cloud-init</b> compatible directory, ISO- or VFAT image,
--   as specified by the list of <a>CloudInitType</a>s. Every item will use
--   the second argument to create an appropriate <i>file name</i>, e.g.
--   for the <a>CI_ISO</a> type the output is <tt>second_param.iso</tt>.
CloudInit :: [CloudInitType] -> FilePath -> ArtifactAssembly

-- | a set of VM-images that were created by executing a build script on
--   them.
VmImages :: [ImageTarget] -> VmScript -> ArtifactAssembly

-- | A type representing the targets assembled by <a>assemble</a> from an
--   <a>ArtifactAssembly</a>. There is a list of <a>ArtifactTarget</a>s
--   because e.g. a single <a>CloudInit</a> can produce upto three output
--   files, a directory, an ISO image and a VFAT image.
data AssembledArtifact
AssembledArtifact :: InstanceId -> [ArtifactTarget] -> AssembledArtifact

-- | The variable containing the instance id. <b>Deprecated</b>
instanceIdKey :: String

-- | The variable containing the buildId that identifies each execution of
--   B9. For more info about variable substitution in source files see
--   <a>StringTemplate</a>
buildIdKey :: String

-- | The variable containing the date and time a build was started. For
--   more info about variable substitution in source files see
--   <a>StringTemplate</a>
buildDateKey :: String
instance GHC.Classes.Eq B9.ArtifactGenerator.ArtifactGenerator
instance GHC.Show.Show B9.ArtifactGenerator.ArtifactGenerator
instance GHC.Read.Read B9.ArtifactGenerator.ArtifactGenerator
instance GHC.Classes.Eq B9.ArtifactGenerator.ArtifactAssembly
instance Data.Data.Data B9.ArtifactGenerator.ArtifactAssembly
instance GHC.Show.Show B9.ArtifactGenerator.ArtifactAssembly
instance GHC.Read.Read B9.ArtifactGenerator.ArtifactAssembly
instance GHC.Classes.Eq B9.ArtifactGenerator.AssembledArtifact
instance Data.Data.Data B9.ArtifactGenerator.AssembledArtifact
instance GHC.Show.Show B9.ArtifactGenerator.AssembledArtifact
instance GHC.Read.Read B9.ArtifactGenerator.AssembledArtifact
instance GHC.Classes.Eq B9.ArtifactGenerator.ArtifactTarget
instance Data.Data.Data B9.ArtifactGenerator.ArtifactTarget
instance GHC.Show.Show B9.ArtifactGenerator.ArtifactTarget
instance GHC.Read.Read B9.ArtifactGenerator.ArtifactTarget
instance GHC.Classes.Eq B9.ArtifactGenerator.CloudInitType
instance Data.Data.Data B9.ArtifactGenerator.CloudInitType
instance GHC.Show.Show B9.ArtifactGenerator.CloudInitType
instance GHC.Read.Read B9.ArtifactGenerator.CloudInitType
instance GHC.Classes.Eq B9.ArtifactGenerator.InstanceId
instance Data.Data.Data B9.ArtifactGenerator.InstanceId
instance GHC.Show.Show B9.ArtifactGenerator.InstanceId
instance GHC.Read.Read B9.ArtifactGenerator.InstanceId
instance GHC.Classes.Eq B9.ArtifactGenerator.ArtifactSource
instance GHC.Show.Show B9.ArtifactGenerator.ArtifactSource
instance GHC.Read.Read B9.ArtifactGenerator.ArtifactSource
instance GHC.Base.Monoid B9.ArtifactGenerator.ArtifactGenerator
instance Test.QuickCheck.Arbitrary.Arbitrary B9.ArtifactGenerator.ArtifactGenerator
instance Test.QuickCheck.Arbitrary.Arbitrary B9.ArtifactGenerator.ArtifactSource
instance Test.QuickCheck.Arbitrary.Arbitrary B9.ArtifactGenerator.InstanceId
instance Test.QuickCheck.Arbitrary.Arbitrary B9.ArtifactGenerator.ArtifactAssembly
instance Test.QuickCheck.Arbitrary.Arbitrary B9.ArtifactGenerator.CloudInitType


-- | Static B9 configuration. Read, write and merge configurable
--   properties. The properties are independent of specific build targets.
module B9.B9Config
data B9Config
B9Config :: Maybe LogLevel -> Maybe FilePath -> Maybe FilePath -> Bool -> ExecEnvType -> Maybe FilePath -> BuildVariables -> Bool -> Maybe SystemPath -> Maybe String -> B9Config
[verbosity] :: B9Config -> Maybe LogLevel
[logFile] :: B9Config -> Maybe FilePath
[buildDirRoot] :: B9Config -> Maybe FilePath
[keepTempDirs] :: B9Config -> Bool
[execEnvType] :: B9Config -> ExecEnvType
[profileFile] :: B9Config -> Maybe FilePath
[envVars] :: B9Config -> BuildVariables
[uniqueBuildDirs] :: B9Config -> Bool
[repositoryCache] :: B9Config -> Maybe SystemPath
[repository] :: B9Config -> Maybe String
defaultB9ConfigFile :: SystemPath
defaultRepositoryCache :: SystemPath
defaultB9Config :: B9Config
getB9ConfigFile :: MonadIO m => Maybe SystemPath -> m FilePath
writeB9Config :: MonadIO m => (Maybe SystemPath) -> ConfigParser -> m ()
writeInitialB9Config :: MonadIO m => (Maybe SystemPath) -> B9Config -> ConfigParser -> m ()
readB9Config :: MonadIO m => (Maybe SystemPath) -> m ConfigParser
parseB9Config :: ConfigParser -> Either String B9Config
data LogLevel
LogTrace :: LogLevel
LogDebug :: LogLevel
LogInfo :: LogLevel
LogError :: LogLevel
LogNothing :: LogLevel
data ExecEnvType
LibVirtLXC :: ExecEnvType
type BuildVariables = [(String, String)]
instance GHC.Show.Show B9.B9Config.B9Config
instance GHC.Read.Read B9.B9Config.LogLevel
instance GHC.Classes.Ord B9.B9Config.LogLevel
instance GHC.Show.Show B9.B9Config.LogLevel
instance GHC.Classes.Eq B9.B9Config.LogLevel
instance GHC.Read.Read B9.B9Config.ExecEnvType
instance GHC.Classes.Ord B9.B9Config.ExecEnvType
instance GHC.Show.Show B9.B9Config.ExecEnvType
instance GHC.Classes.Eq B9.B9Config.ExecEnvType
instance GHC.Base.Monoid B9.B9Config.B9Config


-- | Definition of the B9 monad. It encapsulates logging, very basic
--   command execution profiling, a reader for the <a>B9.B9Config</a> and
--   access to the current build id, the current build directory and the
--   artifact to build.
--   
--   This module is used by the _effectful_ functions in this library.
module B9.B9Monad
data B9 a
run :: ConfigParser -> B9Config -> B9 a -> IO a
traceL :: String -> B9 ()
dbgL :: String -> B9 ()
infoL :: String -> B9 ()
errorL :: String -> B9 ()
getConfigParser :: B9 ConfigParser
getConfig :: B9 B9Config
getBuildId :: B9 FilePath
getBuildDate :: B9 String
getBuildDir :: B9 FilePath
getExecEnvType :: B9 ExecEnvType
getSelectedRemoteRepo :: B9 (Maybe RemoteRepo)
getRemoteRepos :: B9 [RemoteRepo]
getRepoCache :: B9 RepoCache
cmd :: String -> B9 ()
instance Control.Monad.State.Class.MonadState B9.B9Monad.BuildState B9.B9Monad.B9
instance GHC.Base.Monad B9.B9Monad.B9
instance GHC.Base.Applicative B9.B9Monad.B9
instance GHC.Base.Functor B9.B9Monad.B9
instance GHC.Show.Show B9.B9Monad.ProfilingEntry
instance GHC.Classes.Eq B9.B9Monad.ProfilingEntry
instance Control.Monad.IO.Class.MonadIO B9.B9Monad.B9


-- | Effectful functions executing shared image respository operations. See
--   <a>B9.Repository</a>
module B9.RepositoryIO

-- | Find files which are in <tt>subDir</tt> and match <tt>glob</tt> in the
--   repository cache. NOTE: This operates on the repository cache, but
--   does not enforce a repository cache update.
repoSearch :: FilePath -> FilePathGlob -> B9 [(Repository, [FilePath])]

-- | Push a file from the cache to a remote repository
pushToRepo :: RemoteRepo -> FilePath -> FilePath -> B9 ()

-- | Pull a file from a remote repository to cache
pullFromRepo :: RemoteRepo -> FilePath -> FilePath -> B9 ()

-- | Push a file from the cache to a remote repository
pullGlob :: FilePath -> FilePathGlob -> RemoteRepo -> B9 ()
data Repository
Cache :: Repository
Remote :: String -> Repository

-- | Express a pattern for file paths, used when searching repositories.
data FilePathGlob
FileExtension :: String -> FilePathGlob
instance GHC.Show.Show B9.RepositoryIO.Repository
instance GHC.Read.Read B9.RepositoryIO.Repository
instance GHC.Classes.Ord B9.RepositoryIO.Repository
instance GHC.Classes.Eq B9.RepositoryIO.Repository


-- | Effectful functions that create and convert disk image files.
module B9.DiskImageBuilder

-- | Create an image from an image source. The destination image must have
--   a compatible image type and filesyste. The directory of the image MUST
--   be present and the image file itself MUST NOT alredy exist.
materializeImageSource :: ImageSource -> Image -> B9 ()

-- | Replace $... variables inside an <a>ImageTarget</a>
substImageTarget :: [(String, String)] -> ImageTarget -> ImageTarget

-- | Return all valid image types sorted by preference.
preferredDestImageTypes :: ImageSource -> B9 [ImageType]
preferredSourceImageTypes :: ImageDestination -> [ImageType]

-- | Resolve an ImageSource to an <a>Image</a>. Note however that this
--   source will may not exist as is the case for <a>EmptyImage</a>.
resolveImageSource :: ImageSource -> B9 Image
createDestinationImage :: Image -> ImageDestination -> B9 ()

-- | Resize an image, including the file system inside the image.
resizeImage :: ImageResize -> Image -> B9 ()

-- | Import a disk image from some external source into the build directory
--   if necessary convert the image.
importImage :: Image -> Image -> B9 ()

-- | Export a disk image from 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 ()

-- | Convert an image in the build directory to another format and return
--   the new image.
convertImage :: Image -> Image -> B9 ()

-- | Publish an sharedImage made from an image and image meta data to the
--   configured repository
shareImage :: Image -> SharedImageName -> B9 SharedImage
ensureAbsoluteImageDirExists :: Image -> IO Image

-- | Publish the latest version of a shared image identified by name to the
--   selected repository from the cache.
pushSharedImageLatestVersion :: SharedImageName -> B9 ()

-- | Find shared images and the associated repos from two predicates. The
--   result is the concatenated result of the sorted shared images
--   satisfying <tt>imgPred</tt>.
lookupSharedImages :: (Repository -> Bool) -> (SharedImage -> Bool) -> B9 [(Repository, SharedImage)]

-- | Return a list of all existing sharedImages from cached repositories.
getSharedImages :: B9 [(Repository, [SharedImage])]

-- | Pull metadata files from all remote repositories.
pullRemoteRepos :: B9 ()

-- | Pull the latest version of an image, either from the selected remote
--   repo or from the repo that has the latest version.
pullLatestImage :: SharedImageName -> B9 Bool


-- | Implementation of an execution environment that uses "libvirt-lxc".
module B9.LibVirtLXC
runInEnvironment :: ExecEnv -> Script -> B9 Bool
supportedImageTypes :: [ImageType]
setDefaultConfig :: ConfigParser
instance GHC.Show.Show B9.LibVirtLXC.LibVirtLXCConfig
instance GHC.Read.Read B9.LibVirtLXC.LibVirtLXCConfig
instance GHC.Show.Show B9.LibVirtLXC.LXCGuestCapability
instance GHC.Read.Read B9.LibVirtLXC.LXCGuestCapability


-- | Effectful functions to execute and build virtual machine images using
--   an execution environment like e.g. libvirt-lxc.
module B9.VmBuilder
buildWithVm :: InstanceId -> [ImageTarget] -> FilePath -> VmScript -> B9 Bool


-- | Mostly effectful functions to assemble artifacts.
module B9.ArtifactGeneratorImpl

-- | Run an artifact generator to produce the artifacts.
assemble :: ArtifactGenerator -> B9 [AssembledArtifact]

-- | Evaluate an <a>ArtifactGenerator</a> into a list of low-level build
--   instructions that can be built with <a>createAssembledArtifacts</a>.
evalArtifactGenerator :: String -> String -> BuildVariables -> ArtifactGenerator -> Either String [InstanceGenerator [SourceGenerator]]

-- | Parse an artifacto generator inside a <a>CGParser</a> monad.
parseArtifactGenerator :: ArtifactGenerator -> CGParser ()

-- | Execute a <a>CGParser</a> action in an environment that contains a
--   list of <a>ArtifactSource</a>s.
withArtifactSources :: [ArtifactSource] -> CGParser () -> CGParser ()
withBindings :: [(String, String)] -> CGParser () -> CGParser ()
addBindings :: [(String, String)] -> CGEnv -> CGEnv
withXBindings :: [(String, [String])] -> CGParser () -> CGParser ()
eachBindingSetT :: ArtifactGenerator -> [String] -> [[String]] -> CGParser [[(String, String)]]
eachBindingSet :: ArtifactGenerator -> [(String, [String])] -> CGParser [[(String, String)]]
writeInstanceGenerator :: InstanceId -> ArtifactAssembly -> CGParser ()

-- | Monad for creating Instance generators.
newtype CGParser a
CGParser :: WriterT [InstanceGenerator CGEnv] (ReaderT CGEnv (Either CGError)) a -> CGParser a
[runCGParser] :: CGParser a -> WriterT [InstanceGenerator CGEnv] (ReaderT CGEnv (Either CGError)) a
data CGEnv
CGEnv :: [(String, String)] -> [ArtifactSource] -> CGEnv
[agEnv] :: CGEnv -> [(String, String)]
[agSources] :: CGEnv -> [ArtifactSource]
data InstanceGenerator e
IG :: InstanceId -> e -> ArtifactAssembly -> InstanceGenerator e
newtype CGError
CGError :: String -> CGError
cgError :: String -> CGParser a
execCGParser :: CGParser () -> CGEnv -> Either CGError [InstanceGenerator CGEnv]
execIGEnv :: InstanceGenerator CGEnv -> Either String (InstanceGenerator [SourceGenerator])
substAssembly :: [(String, String)] -> ArtifactAssembly -> ArtifactAssembly
toSourceGen :: [(String, String)] -> ArtifactSource -> Either String [SourceGenerator]
createAssembledArtifacts :: [InstanceGenerator [SourceGenerator]] -> B9 [AssembledArtifact]
generateSources :: FilePath -> InstanceGenerator [SourceGenerator] -> B9 (InstanceGenerator FilePath)
createTargets :: InstanceGenerator FilePath -> B9 AssembledArtifact
generateUniqueIID :: InstanceId -> B9 InstanceId
generateSourceTo :: FilePath -> SourceGenerator -> B9 ()
sgReadSourceFile :: [(String, String)] -> SourceFile -> B9 ByteString
sgChangePerm :: FilePath -> SGPerm -> B9 ()

-- | Internal data type simplifying the rather complex source generation by
--   bioling down <a>ArtifactSource</a>s to a flat list of uniform
--   <a>SourceGenerator</a>s.
data SourceGenerator
SGConcat :: [(String, String)] -> SGSource -> SGPerm -> FilePath -> SourceGenerator
data SGSource
SGFiles :: [SourceFile] -> SGSource
SGContent :: Content -> SGSource
data SGType
SGT :: SGType
SGF :: SGType
data SGPerm
SGSetPerm :: (Int, Int, Int) -> SGPerm
KeepPerm :: SGPerm
sgGetFroms :: SourceGenerator -> [SourceFile]
setSGPerm :: Int -> Int -> Int -> SourceGenerator -> Either String SourceGenerator
setSGFromDirectory :: FilePath -> SourceGenerator -> SourceGenerator
setSGToDirectory :: FilePath -> SourceGenerator -> SourceGenerator

-- | Create the actual target, either just a mountpoint, or an ISO or VFAT
--   image.
createTarget :: InstanceId -> FilePath -> ArtifactAssembly -> B9 [ArtifactTarget]
instance GHC.Classes.Eq B9.ArtifactGeneratorImpl.SourceGenerator
instance GHC.Show.Show B9.ArtifactGeneratorImpl.SourceGenerator
instance GHC.Read.Read B9.ArtifactGeneratorImpl.SourceGenerator
instance GHC.Classes.Eq B9.ArtifactGeneratorImpl.SGPerm
instance Data.Data.Data B9.ArtifactGeneratorImpl.SGPerm
instance GHC.Show.Show B9.ArtifactGeneratorImpl.SGPerm
instance GHC.Read.Read B9.ArtifactGeneratorImpl.SGPerm
instance GHC.Classes.Eq B9.ArtifactGeneratorImpl.SGType
instance Data.Data.Data B9.ArtifactGeneratorImpl.SGType
instance GHC.Show.Show B9.ArtifactGeneratorImpl.SGType
instance GHC.Read.Read B9.ArtifactGeneratorImpl.SGType
instance GHC.Classes.Eq B9.ArtifactGeneratorImpl.SGSource
instance GHC.Show.Show B9.ArtifactGeneratorImpl.SGSource
instance GHC.Read.Read B9.ArtifactGeneratorImpl.SGSource
instance Control.Monad.Error.Class.MonadError B9.ArtifactGeneratorImpl.CGError B9.ArtifactGeneratorImpl.CGParser
instance Control.Monad.Writer.Class.MonadWriter [B9.ArtifactGeneratorImpl.InstanceGenerator B9.ArtifactGeneratorImpl.CGEnv] B9.ArtifactGeneratorImpl.CGParser
instance Control.Monad.Reader.Class.MonadReader B9.ArtifactGeneratorImpl.CGEnv B9.ArtifactGeneratorImpl.CGParser
instance GHC.Base.Monad B9.ArtifactGeneratorImpl.CGParser
instance GHC.Base.Applicative B9.ArtifactGeneratorImpl.CGParser
instance GHC.Base.Functor B9.ArtifactGeneratorImpl.CGParser
instance Control.Monad.Trans.Error.Error B9.ArtifactGeneratorImpl.CGError
instance GHC.Classes.Eq B9.ArtifactGeneratorImpl.CGError
instance Data.Data.Data B9.ArtifactGeneratorImpl.CGError
instance GHC.Show.Show B9.ArtifactGeneratorImpl.CGError
instance GHC.Read.Read B9.ArtifactGeneratorImpl.CGError
instance GHC.Classes.Eq e => GHC.Classes.Eq (B9.ArtifactGeneratorImpl.InstanceGenerator e)
instance Data.Data.Data e => Data.Data.Data (B9.ArtifactGeneratorImpl.InstanceGenerator e)
instance GHC.Show.Show e => GHC.Show.Show (B9.ArtifactGeneratorImpl.InstanceGenerator e)
instance GHC.Read.Read e => GHC.Read.Read (B9.ArtifactGeneratorImpl.InstanceGenerator e)
instance GHC.Classes.Eq B9.ArtifactGeneratorImpl.CGEnv
instance GHC.Show.Show B9.ArtifactGeneratorImpl.CGEnv
instance GHC.Read.Read B9.ArtifactGeneratorImpl.CGEnv


-- | Highest-level build functions and and B9-re-exports.
module B9.Builder
buildArtifacts :: ArtifactGenerator -> ConfigParser -> B9Config -> IO Bool


-- | B9 is a library and build tool with primitive operations to run a
--   build script inside a virtual machine and to create and convert
--   virtual machine image files as well as related ISO and VFAT disk
--   images for e.g. cloud-init configuration sources.
--   
--   This module re-exports the modules needed to build a tool around the
--   library, e.g. see <tt>src/cli/Main.hs</tt> as an example.
--   
--   <a>B9.ArtifactGenerator</a> is the module containing the basic data
--   structure used to describe a B9 build.
module B9

-- | Merge <tt>existingConfig</tt> with the configuration from the main b9
--   config file. If the file does not exists, a new config file with the
--   given configuration will be written. The return value is a parser for
--   the config file. Returning the raw config file parser allows modules
--   unkown to <a>B9Config</a> to add their own values to the shared config
--   file.
configure :: MonadIO m => Maybe SystemPath -> B9Config -> m ConfigParser

-- | Return the cabal package version of the B9 library.
b9_version :: Version