Configs
Go to file
Joey Hess 0ee04ecc43 GADT properties seem to work (untested)
* Property has been converted to a GADT, and will be Property NoInfo
  or Property HasInfo.
  This was done to make sure that ensureProperty is only used on
  properties that do not have Info.
  Transition guide:
  - Change all "Property" to "Property NoInfo" or "Property WithInfo"
    (The compiler can tell you if you got it wrong!)
  - To construct a RevertableProperty, it is useful to use the new
    (<!>) operator
  - Constructing a list of properties can be problimatic, since
    Property NoInto and Property WithInfo are different types and cannot
    appear in the same list. To deal with this, "props" has been added,
    and can built up a list of properties of different types,
    using the same (&) and (!) operators that are used to build
    up a host's properties.
2015-01-24 22:38:51 -04:00
debian GADT properties seem to work (untested) 2015-01-24 22:38:51 -04:00
doc GADT properties seem to work (untested) 2015-01-24 22:38:51 -04:00
privdata.joey propellor spin 2015-01-15 18:19:44 -04:00
src GADT properties seem to work (untested) 2015-01-24 22:38:51 -04:00
.gitignore update 2014-11-22 22:13:00 -04:00
CHANGELOG changelog 2014-04-01 15:07:07 -04:00
LICENSE update email 2014-11-15 15:03:54 -04:00
Makefile document 2014-11-25 11:38:42 -04:00
README.md add basic front page 2014-04-19 15:45:27 -04:00
Setup.hs fix 2014-03-30 23:39:07 -04:00
config-joey.hs GADT properties seem to work (untested) 2015-01-24 22:38:51 -04:00
config-simple.hs Reboot.atEnd 2014-12-06 13:21:19 -04:00
config.hs change joeyconfig back after merging from master 2014-04-19 16:17:47 -04:00
propellor.cabal GADT properties seem to work (untested) 2015-01-24 22:38:51 -04:00

README.md

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. The git repository contains the full source code to Propellor, along with its config file.

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

  1. Get propellor installed on your development machine (ie, laptop). cabal install propellor or apt-get install propellor
  2. Run propellor for the first time. It will set up a ~/.propellor/ git repository for you.
  3. If you don't have a gpg private key already, generate one: gpg --gen-key
  4. Run: propellor --add-key $KEYID, which will make propellor trust your gpg key, and will sign your ~/.propellor repository using it.
  5. Edit ~/.propellor/config.hs, and add a host you want to manage. You can start by not adding any properties, or only a few.
  6. Run: propellor --spin $HOST
  7. 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. :)
  8. Optionally, set up a centralized git repository so that multiple hosts can be updated with a simple git commit -S; git push
  9. Write some neat new properties and send patches!