PuppetDB

Common data types for PuppetDB.

Documentation

dummyPuppetDB :: Monad m => PuppetDBAPI m

A dummy implementation of PuppetDBAPI, that will return empty responses.

getDefaultDB :: PDBType -> IO (Either PrettyError (PuppetDBAPI IO))

Given a PDBType, will try return a sane default implementation.

pdbConnect :: Manager -> String -> IO (Either PrettyError (PuppetDBAPI IO))

Given an URL (ie. http://localhost:8080), will return an incomplete PuppetDBAPI.

loadTestDB :: FilePath -> IO (Either PrettyError (PuppetDBAPI IO))

Initializes the test DB using a file to back its content

generateWireCatalog :: NodeName -> FinalCatalog -> EdgeMap -> WireCatalog

Turns a FinalCatalog and EdgeMap into a document that can be serialized and fed to puppet apply.

puppetDBFacts :: NodeName -> PuppetDBAPI IO -> IO (HashMap Text PValue)

data PDBType

The supported PuppetDB implementations.

Constructors

PDBRemote

Your standard PuppetDB, queried through the HTTP interface.

PDBDummy

A stupid stub, this is the default choice.

PDBTest

A slow but handy PuppetDB implementation that is backed by a YAML file.

Instances

Eq PDBType

Defined in PuppetDB.Core

Methods

(==) :: PDBType -> PDBType -> Bool

(/=) :: PDBType -> PDBType -> Bool

Read PDBType

Defined in PuppetDB.Core

Methods

readsPrec :: Int -> ReadS PDBType

readList :: ReadS [PDBType]

readPrec :: ReadPrec PDBType

readListPrec :: ReadPrec [PDBType]

data NodeInfo

Constructors

NodeInfo

Fields

• _nodeInfoName :: !NodeName
• _nodeInfoDeactivated :: !Bool
• _nodeInfoCatalogT :: !(Maybe UTCTime)
• _nodeInfoFactsT :: !(Maybe UTCTime)
• _nodeInfoReportT :: !(Maybe UTCTime)

Instances

ToJSON NodeInfo

Defined in PuppetDB.Core

Methods

toJSON :: NodeInfo -> Value

toEncoding :: NodeInfo -> Encoding

toJSONList :: [NodeInfo] -> Value

toEncodingList :: [NodeInfo] -> Encoding

FromJSON NodeInfo

Defined in PuppetDB.Core

Methods

parseJSON :: Value -> Parser NodeInfo

parseJSONList :: Value -> Parser [NodeInfo]

HasNodeInfo NodeInfo

Defined in PuppetDB.Core

Methods

nodeInfo :: Lens' NodeInfo NodeInfo

nodeInfoCatalogT :: Lens' NodeInfo (Maybe UTCTime)

nodeInfoDeactivated :: Lens' NodeInfo Bool

nodeInfoFactsT :: Lens' NodeInfo (Maybe UTCTime)

nodeInfoName :: Lens' NodeInfo NodeName

nodeInfoReportT :: Lens' NodeInfo (Maybe UTCTime)

class HasNodeInfo c where

Minimal complete definition

nodeInfo

Methods

nodeInfo :: Lens' c NodeInfo

nodeInfoCatalogT :: Lens' c (Maybe UTCTime)

nodeInfoDeactivated :: Lens' c Bool

nodeInfoFactsT :: Lens' c (Maybe UTCTime)

nodeInfoName :: Lens' c NodeName

nodeInfoReportT :: Lens' c (Maybe UTCTime)

Instances

HasNodeInfo NodeInfo

Defined in PuppetDB.Core

Methods

nodeInfo :: Lens' NodeInfo NodeInfo

nodeInfoCatalogT :: Lens' NodeInfo (Maybe UTCTime)

nodeInfoDeactivated :: Lens' NodeInfo Bool

nodeInfoFactsT :: Lens' NodeInfo (Maybe UTCTime)

nodeInfoName :: Lens' NodeInfo NodeName

nodeInfoReportT :: Lens' NodeInfo (Maybe UTCTime)

data Query a

Pretty straightforward way to define the various PuppetDB queries

Constructors

QEqual a Text

QG a Integer

QL a Integer

QGE a Integer

QLE a Integer

QMatch Text Text

QAnd [Query a]

QOr [Query a]

QNot (Query a)

QEmpty

Instances

ToJSON a => ToJSON (Query a)

Defined in PuppetDB.Core

Methods

toJSON :: Query a -> Value

toEncoding :: Query a -> Encoding

toJSONList :: [Query a] -> Value

toEncodingList :: [Query a] -> Encoding

FromJSON a => FromJSON (Query a)

Defined in PuppetDB.Core

Methods

parseJSON :: Value -> Parser (Query a)

parseJSONList :: Value -> Parser [Query a]

ToJSON a => ToHttpApiData (Query a)

Defined in PuppetDB.Core

Methods

toUrlPiece :: Query a -> Text

toEncodedUrlPiece :: Query a -> Builder

toHeader :: Query a -> ByteString

toQueryParam :: Query a -> Text

data FactField

Fields for the fact endpoint

Constructors

FName

FValue

FCertname

Instances

ToJSON FactField

Defined in PuppetDB.Core

Methods

toJSON :: FactField -> Value

toEncoding :: FactField -> Encoding

toJSONList :: [FactField] -> Value

toEncodingList :: [FactField] -> Encoding

FromJSON FactField

Defined in PuppetDB.Core

Methods

parseJSON :: Value -> Parser FactField

parseJSONList :: Value -> Parser [FactField]

data NodeField

Fields for the node endpoint

Constructors

NName

NFact Text

Instances

ToJSON NodeField

Defined in PuppetDB.Core

Methods

toJSON :: NodeField -> Value

toEncoding :: NodeField -> Encoding

toJSONList :: [NodeField] -> Value

toEncodingList :: [NodeField] -> Encoding

FromJSON NodeField

Defined in PuppetDB.Core

Methods

parseJSON :: Value -> Parser NodeField

parseJSONList :: Value -> Parser [NodeField]

data ResourceField

Fields for the resource endpoint

Constructors

RTag

RCertname

RParameter Text

RType

RTitle

RExported

RFile

RLine

Instances

ToJSON ResourceField

Defined in PuppetDB.Core

Methods

toJSON :: ResourceField -> Value

toEncoding :: ResourceField -> Encoding

toJSONList :: [ResourceField] -> Value

toEncodingList :: [ResourceField] -> Encoding

FromJSON ResourceField

Defined in PuppetDB.Core

Methods

parseJSON :: Value -> Parser ResourceField

parseJSONList :: Value -> Parser [ResourceField]

data PuppetDBAPI m

Constructors

PuppetDBAPI

Fields

• pdbInformation :: m Doc
• replaceCatalog :: WireCatalog -> ExceptT PrettyError m ()

  http://docs.puppetlabs.com/puppetdb/1.5/api/commands.html#replace-catalog-version-3

• replaceFacts :: [(NodeName, Facts)] -> ExceptT PrettyError m ()

  http://docs.puppetlabs.com/puppetdb/1.5/api/commands.html#replace-facts-version-1

• deactivateNode :: NodeName -> ExceptT PrettyError m ()

  http://docs.puppetlabs.com/puppetdb/1.5/api/commands.html#deactivate-node-version-1

• getPDBFacts :: Query FactField -> ExceptT PrettyError m [FactInfo]

  http://docs.puppetlabs.com/puppetdb/1.5/api/query/v3/facts.html#get-v3facts

• getResources :: Query ResourceField -> ExceptT PrettyError m [Resource]

  http://docs.puppetlabs.com/puppetdb/1.5/api/query/v3/resources.html#get-v3resources

• getNodes :: Query NodeField -> ExceptT PrettyError m [NodeInfo]
• commitDB :: ExceptT PrettyError m ()

  This is only here to tell the test PuppetDB to save its content to disk.

• getResourcesOfNode :: NodeName -> Query ResourceField -> ExceptT PrettyError m [Resource]