propellor: property-based host configuration management in haskell

[ bsd2, library, program, utility ] [ Propose Tags ] [ Report a vulnerability ]

Propellor ensures that the system it's run in satisfies a list of properties, taking action as necessary when a property is not yet met.

It is configured using haskell.

[Skip to Readme]

Modules

[Last Documentation]

Propellor
- Propellor.Base
- Propellor.CmdLine
- Propellor.Debug
- Propellor.Engine
- Propellor.Exception
- Propellor.Info
- Propellor.Location
- Propellor.Message
- Propellor.PrivData
- Propellor.PropAccum
- Propellor.Property
  - Propellor.Property.Aiccu
  - Propellor.Property.Apache
  - Propellor.Property.Apt
  - Propellor.Property.Chroot
  - Propellor.Property.Cmd
  - Propellor.Property.Concurrent
  - Propellor.Property.Conductor
  - Propellor.Property.ConfFile
  - Propellor.Property.Cron
  - Propellor.Property.DebianMirror
  - Propellor.Property.Debootstrap
  - Propellor.Property.DiskImage
    - Propellor.Property.DiskImage.PartSpec
  - Propellor.Property.Dns
  - Propellor.Property.DnsSec
  - Propellor.Property.Docker
  - Propellor.Property.Fail2Ban
  - Propellor.Property.File
  - Propellor.Property.Firewall
  - Propellor.Property.Git
  - Propellor.Property.Gpg
  - Propellor.Property.Group
  - Propellor.Property.Grub
  - HostingProvider
    - Propellor.Property.HostingProvider.CloudAtCost
    - Propellor.Property.HostingProvider.DigitalOcean
    - Propellor.Property.HostingProvider.Linode
  - Propellor.Property.Hostname
  - Propellor.Property.Journald
  - Propellor.Property.Kerberos
  - Propellor.Property.LightDM
  - Propellor.Property.List
  - Propellor.Property.Locale
  - Propellor.Property.Logcheck
  - Propellor.Property.Mount
  - Propellor.Property.Network
  - Propellor.Property.Nginx
  - Propellor.Property.OS
  - Propellor.Property.Obnam
  - Propellor.Property.OpenId
  - Propellor.Property.Parted
  - Propellor.Property.Partition
  - Propellor.Property.Postfix
  - Propellor.Property.PropellorRepo
  - Propellor.Property.Prosody
  - Propellor.Property.Reboot
  - Propellor.Property.Rsync
  - Propellor.Property.Scheduled
  - Propellor.Property.Service
  - SiteSpecific
    - Propellor.Property.SiteSpecific.Branchable
    - Propellor.Property.SiteSpecific.GitAnnexBuilder
    - Propellor.Property.SiteSpecific.GitHome
    - Propellor.Property.SiteSpecific.IABak
    - Propellor.Property.SiteSpecific.JoeySites
  - Propellor.Property.Ssh
  - Propellor.Property.Sudo
  - Propellor.Property.Systemd
    - Propellor.Property.Systemd.Core
  - Propellor.Property.Tor
  - Propellor.Property.Unbound
  - Propellor.Property.User
  - Propellor.Property.Uwsgi
- Propellor.Types
  - Propellor.Types.Chroot
  - Propellor.Types.CmdLine
  - Propellor.Types.Container
  - Propellor.Types.Dns
  - Propellor.Types.Docker
  - Propellor.Types.Empty
  - Propellor.Types.Info
  - Propellor.Types.OS
  - Propellor.Types.PrivData
  - Propellor.Types.Result
  - Propellor.Types.ResultCheck
- Propellor.Utilities

Downloads

propellor-2.15.1.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

JoeyHess

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	0.1, 0.1.1, 0.1.2, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.3.0, 0.3.1, 0.4.0, 0.5.0, 0.5.1, 0.5.3, 0.6.0, 0.7.0, 0.8.0, 0.8.1, 0.8.2, 0.8.3, 0.9.0, 0.9.1, 0.9.2, 1.0.0, 1.2.0, 1.2.1, 1.3.2, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0, 2.5.0, 2.6.0, 2.7.0, 2.7.1, 2.7.2, 2.7.3, 2.8.0, 2.8.1, 2.9.0, 2.10.0, 2.11.0, 2.12.0, 2.13.0, 2.14.0, 2.15.0, 2.15.1, 2.15.2, 2.15.3, 2.15.4, 2.16.0, 2.17.0, 2.17.1, 2.17.2, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.0.5, 3.1.0, 3.1.1, 3.1.2, 3.2.0, 3.2.1, 3.2.2, 3.2.3, 3.3.0, 3.3.1, 3.4.0, 3.4.1, 4.0.0, 4.0.1, 4.0.2, 4.0.3, 4.0.4, 4.0.6, 4.1.0, 4.2.0, 4.3.0, 4.3.1, 4.3.2, 4.3.3, 4.3.4, 4.4.0, 4.5.0, 4.5.1, 4.5.2, 4.6.0, 4.6.1, 4.6.2, 4.7.0, 4.7.1, 4.7.2, 4.7.3, 4.7.4, 4.7.5, 4.7.6, 4.7.7, 4.8.0, 4.8.1, 4.9.0, 5.0.0, 5.1.0, 5.2.0, 5.3.0, 5.3.1, 5.3.2, 5.3.3, 5.3.4, 5.3.5, 5.3.6, 5.4.0, 5.4.1, 5.5.0, 5.6.0, 5.6.1, 5.7.0, 5.8.0, 5.9.0, 5.9.1, 5.10.1, 5.10.2, 5.11, 5.12, 5.13, 5.14, 5.14.1, 5.15, 5.16, 5.17
Change log	CHANGELOG
Dependencies	ansi-terminal, async, base (>=4.5 && <5), bytestring, containers (>=0.5), directory, exceptions (>=0.6), filepath, hslogger, IfElse, MissingH, mtl, network, process, stm, text, time, transformers, unix, unix-compat [details]
License	BSD-3-Clause
Copyright	2014 Joey Hess
Author	Joey Hess
Maintainer	Joey Hess <id@joeyh.name>
Category	Utility
Home page	https://propellor.branchable.com/
Source repo	head: git clone git://git.joeyh.name/propellor.git
Uploaded	by JoeyHess at 2015-12-19T21:06:03Z
Distributions	Debian:5.13, NixOS:5.17
Reverse Dependencies	1 direct, 0 indirect [details]
Executables	propellor-config, propellor
Downloads	85607 total (234 in the last 30 days)
Rating	2.0 (votes: 1) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs not available [build log] All reported builds failed as of 2016-11-29 [all 2 reports]

Readme for propellor-2.15.1

[back to package description]

Propellor is a configuration management system using Haskell and Git. Each system has a list of properties, which Propellor ensures are satisfied.

Propellor is configured via a git repository, which typically lives in ~/.propellor/ on your development machine. Propellor clones the repository to each host it manages, in a secure way. See components for details.

Properties are defined using Haskell. Edit ~/.propellor/config.hs to get started. There is fairly complete API documentation, which includes many built-in Properties for dealing with Apt and Apache , Cron and Commands , Dns and Docker, etc.

There is no special language as used in puppet, chef, ansible, etc.. just the full power of Haskell. Hopefully that power can be put to good use in making declarative properties that are powerful, nicely idempotent, and easy to adapt to a system's special needs!

If using Haskell to configure Propellor seems intimidating, see configuration for the Haskell newbie.

quick start

Get propellor installed on your development machine (ie, laptop). cabal install propellor or apt-get install propellor
Run propellor for the first time. It will set up a ~/.propellor/ git repository for you.
If you don't have a gpg private key already, generate one: gpg --gen-key
Run: propellor --add-key $KEYID, which will make propellor trust your gpg key, and will sign your ~/.propellor repository using it.
Edit ~/.propellor/config.hs, and add a host you want to manage. You can start by not adding any properties, or only a few.
Run: propellor --spin $HOST
Now you have a simple propellor deployment, but it doesn't do much to the host yet, besides installing propellor.
So, edit ~/.propellor/config.hs to configure the host, add some properties to it, and re-run step 6.
Repeat until happy and move on to the next host. :)
Once you have a lot of hosts, and running propellor --spin HOST for each host becomes tiresome, you can automate that.
Write some neat new properties and send patches!