Safe Haskell	None

Propellor.Types

Synopsis

Documentation

data Host Source

Everything Propellor knows about a system: Its hostname, properties and other info.

Constructors

Host
Fields hostName :: HostName hostProperties :: [Property] hostInfo :: Info

Instances

Show Host
MonadReader Host Propellor

data Info Source

Information about a host.

Instances

Eq Info
Show Info
Monoid Info

newtype Propellor p Source

Propellor's monad provides read-only access to info about the host it's running on.

Constructors

Propellor
Fields runWithHost :: ReaderT Host IO p

Instances

Monad Propellor
Functor Propellor
Applicative Propellor
MonadCatchIO Propellor
MonadIO Propellor
MonadReader Host 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 propertyInfo :: Info a property can add info to the host.

Instances

Show Property
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.

getInfo :: p -> Info Source

Instances

IsProp RevertableProperty
IsProp Property

type Desc = StringSource

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 PrivDataField Context
Dump PrivDataField Context
Edit PrivDataField Context
ListFields
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

Instances

Eq PrivDataField
Ord PrivDataField
Read PrivDataField
Show PrivDataField

type PrivData = StringSource

newtype Context Source

Context in which a PrivDataField is used.

Often this will be a domain name. For example, Context www.example.com could be used for the SSL cert for the web server serving that domain. Multiple hosts might use that privdata.

Constructors

Context String

Instances

Eq Context
Ord Context
Read Context
Show Context

anyContext :: Context Source

Use when a PrivDataField is not dependent on any paricular context.

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