Safe Haskell	None
Language	Haskell2010

B9.B9Config

Description

Static B9 configuration. Read, write and merge configurable properties. The properties are independent of specific build targets.

Synopsis

data B9Config = B9Config {
- _verbosity :: Maybe LogLevel
- _logFile :: Maybe FilePath
- _projectRoot :: Maybe FilePath
- _keepTempDirs :: Bool
- _uniqueBuildDirs :: Bool
- _repositoryCache :: Maybe SystemPath
- _repository :: Maybe String
- _interactive :: Bool
- _maxLocalSharedImageRevisions :: Maybe Int
- _systemdNspawnConfigs :: Maybe SystemdNspawnConfig
- _podmanConfigs :: Maybe PodmanConfig
- _dockerConfigs :: Maybe DockerConfig
- _libVirtLXCConfigs :: Maybe LibVirtLXCConfig
- _remoteRepos :: [RemoteRepo]
- _defaultTimeout :: Maybe Timeout
- _timeoutFactor :: Maybe Int
}
newtype Timeout = TimeoutMicros Int
runB9ConfigReader :: HasCallStack => B9Config -> Eff (B9ConfigReader ': e) a -> Eff e a
type B9ConfigReader = Reader B9Config
getB9Config :: Member B9ConfigReader e => Eff e B9Config
getConfig :: Member B9ConfigReader e => Eff e B9Config
getLogVerbosity :: Member B9ConfigReader e => Eff e (Maybe LogLevel)
getProjectRoot :: Member B9ConfigReader e => Eff e FilePath
getRemoteRepos :: Member B9ConfigReader e => Eff e [RemoteRepo]
isInteractive :: Member B9ConfigReader e => Eff e Bool
type B9ConfigWriter = Writer (Endo B9Config)
verbosity :: Lens' B9Config (Maybe LogLevel)
logFile :: Lens' B9Config (Maybe FilePath)
projectRoot :: Lens' B9Config (Maybe FilePath)
keepTempDirs :: Lens' B9Config Bool
uniqueBuildDirs :: Lens' B9Config Bool
repositoryCache :: Lens' B9Config (Maybe SystemPath)
repository :: Lens' B9Config (Maybe String)
interactive :: Lens' B9Config Bool
defaultTimeout :: Lens' B9Config (Maybe Timeout)
libVirtLXCConfigs :: Lens' B9Config (Maybe LibVirtLXCConfig)
dockerConfigs :: Lens' B9Config (Maybe DockerConfig)
podmanConfigs :: Lens' B9Config (Maybe PodmanConfig)
systemdNspawnConfigs :: Lens' B9Config (Maybe SystemdNspawnConfig)
remoteRepos :: Lens' B9Config [RemoteRepo]
timeoutFactor :: Lens' B9Config (Maybe Int)
maxLocalSharedImageRevisionsK :: String
maxLocalSharedImageRevisions :: Lens' B9Config (Maybe Int)
data B9ConfigOverride = B9ConfigOverride {
- _customB9ConfigPath :: Maybe SystemPath
- _customB9Config :: Endo B9Config
- _customEnvironment :: Environment
- _customDefaulB9ConfigPath :: Maybe SystemPath
}
noB9ConfigOverride :: B9ConfigOverride
type B9ConfigAction a = Eff '[B9ConfigWriter, B9ConfigReader, EnvironmentReader, Lift IO] a
runB9ConfigActionWithOverrides :: HasCallStack => B9ConfigAction a -> B9ConfigOverride -> IO a
runB9ConfigAction :: HasCallStack => B9ConfigAction a -> IO a
localB9Config :: Member B9ConfigReader e => (B9Config -> B9Config) -> Eff e a -> Eff e a
modifyPermanentConfig :: (HasCallStack, Member B9ConfigWriter e) => Endo B9Config -> Eff e ()
customB9Config :: Lens' B9ConfigOverride (Endo B9Config)
customB9ConfigPath :: Lens' B9ConfigOverride (Maybe SystemPath)
customEnvironment :: Lens' B9ConfigOverride Environment
customDefaulB9ConfigPath :: Lens' B9ConfigOverride (Maybe SystemPath)
overrideB9ConfigPath :: SystemPath -> B9ConfigOverride -> B9ConfigOverride
overrideDefaultB9ConfigPath :: SystemPath -> B9ConfigOverride -> B9ConfigOverride
overrideB9Config :: (B9Config -> B9Config) -> B9ConfigOverride -> B9ConfigOverride
overrideWorkingDirectory :: FilePath -> B9ConfigOverride -> B9ConfigOverride
overrideDefaultTimeout :: Maybe Timeout -> B9ConfigOverride -> B9ConfigOverride
overrideTimeoutFactor :: Maybe Int -> B9ConfigOverride -> B9ConfigOverride
overrideVerbosity :: LogLevel -> B9ConfigOverride -> B9ConfigOverride
overrideKeepBuildDirs :: Bool -> B9ConfigOverride -> B9ConfigOverride
defaultB9ConfigFile :: SystemPath
defaultRepositoryCache :: SystemPath
defaultB9Config :: B9Config
openOrCreateB9Config :: (HasCallStack, MonadIO m) => FilePath -> m CPDocument
writeB9CPDocument :: (HasCallStack, MonadIO m) => Maybe SystemPath -> CPDocument -> m ()
readB9Config :: (HasCallStack, MonadIO m) => Maybe SystemPath -> m CPDocument
parseB9Config :: HasCallStack => CPDocument -> Either CPError B9Config
modifyCPDocument :: CPDocument -> Endo B9Config -> Either CPError CPDocument
b9ConfigToCPDocument :: HasCallStack => B9Config -> Either CPError CPDocument
data LogLevel
- = LogTrace
- | LogDebug
- | LogInfo
- | LogError
- | LogNothing
data Environment
module B9.B9Config.SystemdNspawn
module B9.B9Config.Repository
module B9.B9Config.Podman
module B9.B9Config.LibVirtLXC
module B9.B9Config.Docker
module B9.B9Config.Container

Documentation

data B9Config Source #

Constructors

B9Config

Fields

_verbosity :: Maybe LogLevel
_logFile :: Maybe FilePath
_projectRoot :: Maybe FilePath
_keepTempDirs :: Bool
_uniqueBuildDirs :: Bool
_repositoryCache :: Maybe SystemPath
_repository :: Maybe String
_interactive :: Bool
_maxLocalSharedImageRevisions :: Maybe Int
_systemdNspawnConfigs :: Maybe SystemdNspawnConfig
_podmanConfigs :: Maybe PodmanConfig
_dockerConfigs :: Maybe DockerConfig
_libVirtLXCConfigs :: Maybe LibVirtLXCConfig
_remoteRepos :: [RemoteRepo]
_defaultTimeout :: Maybe Timeout
_timeoutFactor :: Maybe Int

Instances

Eq B9Config Source #
Instance details Defined in B9.B9Config Methods (==) :: B9Config -> B9Config -> Bool # (/=) :: B9Config -> B9Config -> Bool #
Show B9Config Source #
Instance details Defined in B9.B9Config Methods showsPrec :: Int -> B9Config -> ShowS # show :: B9Config -> String # showList :: [B9Config] -> ShowS #
Semigroup B9Config Source #
Instance details Defined in B9.B9Config Methods (<>) :: B9Config -> B9Config -> B9Config # sconcat :: NonEmpty B9Config -> B9Config # stimes :: Integral b => b -> B9Config -> B9Config #
Monoid B9Config Source #
Instance details Defined in B9.B9Config Methods mempty :: B9Config # mappend :: B9Config -> B9Config -> B9Config # mconcat :: [B9Config] -> B9Config #

newtype Timeout Source #

A way to specify a time intervall for example for the timeouts of system commands.

Since: 1.1.0

Constructors

TimeoutMicros Int

Instances

Eq Timeout Source #
Instance details Defined in B9.B9Config Methods (==) :: Timeout -> Timeout -> Bool # (/=) :: Timeout -> Timeout -> Bool #
Ord Timeout Source #
Instance details Defined in B9.B9Config Methods compare :: Timeout -> Timeout -> Ordering # (<) :: Timeout -> Timeout -> Bool # (<=) :: Timeout -> Timeout -> Bool # (>) :: Timeout -> Timeout -> Bool # (>=) :: Timeout -> Timeout -> Bool # max :: Timeout -> Timeout -> Timeout # min :: Timeout -> Timeout -> Timeout #
Read Timeout Source #
Instance details Defined in B9.B9Config Methods readsPrec :: Int -> ReadS Timeout # readList :: ReadS [Timeout] # readPrec :: ReadPrec Timeout # readListPrec :: ReadPrec [Timeout] #
Show Timeout Source #
Instance details Defined in B9.B9Config Methods showsPrec :: Int -> Timeout -> ShowS # show :: Timeout -> String # showList :: [Timeout] -> ShowS #

runB9ConfigReader :: HasCallStack => B9Config -> Eff (B9ConfigReader ': e) a -> Eff e a Source #

Run a B9ConfigReader.

Since: 0.5.65

type B9ConfigReader = Reader B9Config Source #

Reader for B9Config. See getB9Config and localB9Config.

Since: 0.5.65

getB9Config :: Member B9ConfigReader e => Eff e B9Config Source #

Return the runtime configuration, that should be the configuration merged from all configuration sources. This is the configuration to be used during a VM image build.

Since: 0.5.65

getConfig :: Member B9ConfigReader e => Eff e B9Config Source #

An alias for getB9Config.

@deprecated

Since: 0.5.65

getLogVerbosity :: Member B9ConfigReader e => Eff e (Maybe LogLevel) Source #

Ask for the LogLevel.

Since: 0.5.65

getProjectRoot :: Member B9ConfigReader e => Eff e FilePath Source #

Ask for the project root directory.

Since: 0.5.65

getRemoteRepos :: Member B9ConfigReader e => Eff e [RemoteRepo] Source #

Ask for the RemoteRepos.

Since: 0.5.65

isInteractive :: Member B9ConfigReader e => Eff e Bool Source #

Ask whether stdin of the B9 process should be redirected to the external commands executed during the build.

Since: 0.5.65

type B9ConfigWriter = Writer (Endo B9Config) Source #

Accumulate B9Config changes that go back to the config file. See B9ConfigAction and modifyPermanentConfig.

Since: 0.5.65

verbosity :: Lens' B9Config (Maybe LogLevel) Source #

logFile :: Lens' B9Config (Maybe FilePath) Source #

projectRoot :: Lens' B9Config (Maybe FilePath) Source #

keepTempDirs :: Lens' B9Config Bool Source #

uniqueBuildDirs :: Lens' B9Config Bool Source #

repositoryCache :: Lens' B9Config (Maybe SystemPath) Source #

repository :: Lens' B9Config (Maybe String) Source #

interactive :: Lens' B9Config Bool Source #

defaultTimeout :: Lens' B9Config (Maybe Timeout) Source #

libVirtLXCConfigs :: Lens' B9Config (Maybe LibVirtLXCConfig) Source #

dockerConfigs :: Lens' B9Config (Maybe DockerConfig) Source #

podmanConfigs :: Lens' B9Config (Maybe PodmanConfig) Source #

systemdNspawnConfigs :: Lens' B9Config (Maybe SystemdNspawnConfig) Source #

remoteRepos :: Lens' B9Config [RemoteRepo] Source #

timeoutFactor :: Lens' B9Config (Maybe Int) Source #

maxLocalSharedImageRevisionsK :: String Source #

maxLocalSharedImageRevisions :: Lens' B9Config (Maybe Int) Source #

data B9ConfigOverride Source #

Override b9 configuration items and/or the path of the b9 configuration file. This is useful, i.e. when dealing with command line parameters.

Constructors

B9ConfigOverride
Fields _customB9ConfigPath :: Maybe SystemPath _customB9Config :: Endo B9Config _customEnvironment :: Environment _customDefaulB9ConfigPath :: Maybe SystemPath

Instances

Show B9ConfigOverride Source #
Instance details Defined in B9.B9Config Methods showsPrec :: Int -> B9ConfigOverride -> ShowS # show :: B9ConfigOverride -> String # showList :: [B9ConfigOverride] -> ShowS #

noB9ConfigOverride :: B9ConfigOverride Source #

An empty default B9ConfigOverride value, that will neither apply any additional B9Config nor change the path of the configuration file.

type B9ConfigAction a = Eff '[B9ConfigWriter, B9ConfigReader, EnvironmentReader, Lift IO] a Source #

A monad that gives access to the (transient) B9Config to be used at _runtime_ with getB9Config or localB9Config, and that allows to write permanent B9Config changes back to the configuration file using modifyPermanentConfig. This is the amalgamation of B9ConfigWriter B9ConfigReader and IO.

Since: 0.5.65

runB9ConfigActionWithOverrides :: HasCallStack => B9ConfigAction a -> B9ConfigOverride -> IO a Source #

Execute a B9ConfigAction. It will take a B9ConfigOverride as input. The B9Config in that value is treated as the _runtime_ configuration, and the _customConfigPath is used as the alternative location of the configuration file. The configuration file is read from either the path in _customB9ConfigPath or from defaultB9ConfigFile. Every modification done via modifyPermanentConfig is applied to the **contents** of the configuration file and written back to that file, note that these changes are ONLY reflected in the configuration file and **not** in the _runtime configuration_.

See also runB9ConfigAction, which does not need the B9ConfigOverride parameter.

Since: 0.5.65

runB9ConfigAction :: HasCallStack => B9ConfigAction a -> IO a Source #

Run a B9ConfigAction using noB9ConfigOverride. See runB9ConfigActionWithOverrides for more details.

Since: 0.5.65

localB9Config :: Member B9ConfigReader e => (B9Config -> B9Config) -> Eff e a -> Eff e a Source #

Run an action with an updated runtime configuration.

Since: 0.5.65

modifyPermanentConfig :: (HasCallStack, Member B9ConfigWriter e) => Endo B9Config -> Eff e () Source #

Add a modification to the permanent configuration file.

customB9Config :: Lens' B9ConfigOverride (Endo B9Config) Source #

customB9ConfigPath :: Lens' B9ConfigOverride (Maybe SystemPath) Source #

customEnvironment :: Lens' B9ConfigOverride Environment Source #

customDefaulB9ConfigPath :: Lens' B9ConfigOverride (Maybe SystemPath) Source #

overrideB9ConfigPath :: SystemPath -> B9ConfigOverride -> B9ConfigOverride Source #

Convenience utility to override the B9 configuration file path.

overrideDefaultB9ConfigPath :: SystemPath -> B9ConfigOverride -> B9ConfigOverride Source #

Convenience utility to override the *default* B9 configuration file path.

Since: 1.1.0

overrideB9Config :: (B9Config -> B9Config) -> B9ConfigOverride -> B9ConfigOverride Source #

Modify the runtime configuration.

overrideWorkingDirectory :: FilePath -> B9ConfigOverride -> B9ConfigOverride Source #

Define the current working directory to be used when building.

overrideDefaultTimeout :: Maybe Timeout -> B9ConfigOverride -> B9ConfigOverride Source #

Define the default timeout for external commands.

Since: 1.1.0

overrideTimeoutFactor :: Maybe Int -> B9ConfigOverride -> B9ConfigOverride Source #

Define the timeout factor for external commands.

Since: 1.1.0

overrideVerbosity :: LogLevel -> B9ConfigOverride -> B9ConfigOverride Source #

Overwrite the verbosity settings in the configuration with those given.

overrideKeepBuildDirs :: Bool -> B9ConfigOverride -> B9ConfigOverride Source #

Overwrite the keepTempDirs flag in the configuration with those given.

defaultB9ConfigFile :: SystemPath Source #

defaultRepositoryCache :: SystemPath Source #

defaultB9Config :: B9Config Source #

openOrCreateB9Config :: (HasCallStack, MonadIO m) => FilePath -> m CPDocument Source #

Open the configuration file that contains the B9Config. If the configuration does not exist, write a default configuration file, and create a all missing directories.

writeB9CPDocument :: (HasCallStack, MonadIO m) => Maybe SystemPath -> CPDocument -> m () Source #

Write the configuration in the CPDocument to either the user supplied configuration file path or to defaultB9ConfigFile. Create all missing (parent) directories.

readB9Config :: (HasCallStack, MonadIO m) => Maybe SystemPath -> m CPDocument Source #

parseB9Config :: HasCallStack => CPDocument -> Either CPError B9Config Source #

modifyCPDocument :: CPDocument -> Endo B9Config -> Either CPError CPDocument Source #

Parse a B9Config, modify it, and merge it back to the given CPDocument.

b9ConfigToCPDocument :: HasCallStack => B9Config -> Either CPError CPDocument Source #

Append a config file section for the B9Config to an empty CPDocument.

data LogLevel Source #

Constructors

LogTrace
LogDebug
LogInfo
LogError
LogNothing

Instances

Eq LogLevel Source #
Instance details Defined in B9.B9Config Methods (==) :: LogLevel -> LogLevel -> Bool # (/=) :: LogLevel -> LogLevel -> Bool #
Ord LogLevel Source #
Instance details Defined in B9.B9Config Methods compare :: LogLevel -> LogLevel -> Ordering # (<) :: LogLevel -> LogLevel -> Bool # (<=) :: LogLevel -> LogLevel -> Bool # (>) :: LogLevel -> LogLevel -> Bool # (>=) :: LogLevel -> LogLevel -> Bool # max :: LogLevel -> LogLevel -> LogLevel # min :: LogLevel -> LogLevel -> LogLevel #
Read LogLevel Source #
Instance details Defined in B9.B9Config Methods readsPrec :: Int -> ReadS LogLevel # readList :: ReadS [LogLevel] # readPrec :: ReadPrec LogLevel # readListPrec :: ReadPrec [LogLevel] #
Show LogLevel Source #
Instance details Defined in B9.B9Config Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #

data Environment Source #

A map of textual keys to textual values.

Since: 0.5.62

Instances

Eq Environment Source #
Instance details Defined in B9.Environment Methods (==) :: Environment -> Environment -> Bool # (/=) :: Environment -> Environment -> Bool #
Data Environment Source #
Instance details Defined in B9.Environment Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Environment -> c Environment # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Environment # toConstr :: Environment -> Constr # dataTypeOf :: Environment -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Environment) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Environment) # gmapT :: (forall b. Data b => b -> b) -> Environment -> Environment # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Environment -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Environment -> r # gmapQ :: (forall d. Data d => d -> u) -> Environment -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Environment -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Environment -> m Environment # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Environment -> m Environment # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Environment -> m Environment #
Show Environment Source #
Instance details Defined in B9.Environment Methods showsPrec :: Int -> Environment -> ShowS # show :: Environment -> String # showList :: [Environment] -> ShowS #
Generic Environment Source #
Instance details Defined in B9.Environment Associated Types type Rep Environment :: Type -> Type # Methods from :: Environment -> Rep Environment x # to :: Rep Environment x -> Environment #
Semigroup Environment Source #
Instance details Defined in B9.Environment Methods (<>) :: Environment -> Environment -> Environment # sconcat :: NonEmpty Environment -> Environment # stimes :: Integral b => b -> Environment -> Environment #
Monoid Environment Source #
Instance details Defined in B9.Environment Methods mempty :: Environment # mappend :: Environment -> Environment -> Environment # mconcat :: [Environment] -> Environment #
NFData Environment Source #
Instance details Defined in B9.Environment Methods rnf :: Environment -> () #
type Rep Environment Source #
Instance details Defined in B9.Environment type Rep Environment = D1 (MetaData "Environment" "B9.Environment" "b9-1.1.0-inplace" False) (C1 (MetaCons "MkEnvironment" PrefixI True) (S1 (MetaSel (Just "nextPosition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Just "fromEnvironment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HashMap Text Text))))

module B9.B9Config.SystemdNspawn

module B9.B9Config.Repository

module B9.B9Config.Podman

module B9.B9Config.LibVirtLXC

module B9.B9Config.Docker

module B9.B9Config.Container