Safe Haskell	None

Propellor.Types

Synopsis

Documentation

data Host Source

Everything Propellor knows about a system: Its properties and attributes.

Constructors

Host [Property] SetAttr

data Attr Source

The attributes of a host. For example, its hostname.

Instances

Eq Attr
Show Attr
MonadReader Attr Propellor

type SetAttr = Attr -> Attr Source

newtype Propellor p Source

Propellor's monad provides read-only access to attributes of the system.

Constructors

Propellor
Fields runWithAttr :: ReaderT Attr IO p

Instances

Monad Propellor
Functor Propellor
Applicative Propellor
MonadCatchIO Propellor
MonadIO Propellor
MonadReader Attr Propellor

data Property Source

The core data type of Propellor, this represents a property that the system should have, and an action to ensure it has the property.

Constructors

Property
Fields propertyDesc :: Desc propertySatisfy :: Propellor Result must be idempotent; may run repeatedly propertyAttr :: SetAttr a property can set an Attr on the host that has the property.

Instances

IsProp Property

data RevertableProperty Source

A property that can be reverted.

Constructors

RevertableProperty Property Property

Instances

IsProp RevertableProperty

class IsProp p whereSource

Methods

describe :: p -> Desc -> pSource

Sets description.

toProp :: p -> Property Source

requires :: p -> Property -> pSource

Indicates that the first property can only be satisfied once the second one is.

setAttr :: p -> SetAttr Source

Instances

IsProp RevertableProperty
IsProp Property

type Desc = String Source

data Result Source

Constructors

NoChange
MadeChange
FailedChange

Instances

Eq Result
Read Result
Show Result
Monoid Result
ActionResult Result

class ActionResult a whereSource

Results of actions, with color.

Methods

getActionResult :: a -> (String, ColorIntensity, Color)Source

Instances

ActionResult Bool
ActionResult Result

data CmdLine Source

Constructors

Run HostName
Spin HostName
Boot HostName
Set HostName PrivDataField
AddKey String
Continue CmdLine
Chain HostName
Docker HostName

Instances

Eq CmdLine
Read CmdLine
Show CmdLine

data PrivDataField Source

Note that removing or changing field names will break the serialized privdata files, so don't do that! It's fine to add new fields.

Constructors

DockerAuthentication
SshPubKey SshKeyType UserName
SshPrivKey SshKeyType UserName
SshAuthorizedKeys UserName
Password UserName
PrivFile FilePath
GpgKey GpgKeyId

Instances

Eq PrivDataField
Ord PrivDataField
Read PrivDataField
Show PrivDataField

type GpgKeyId = String Source

data SshKeyType Source

Constructors

SshRsa
SshDsa
SshEcdsa
SshEd25519

Instances

Eq SshKeyType
Ord SshKeyType
Read SshKeyType
Show SshKeyType

module Propellor.Types.OS

module Propellor.Types.Dns