Configs
Go to file
Joey Hess afee550e70 Property tree
Properties now form a tree, instead of the flat list used before.

This simplifies propigation of Info from the Properties used inside a
container to the outer host; the Property that docks the container on the
host can just have as child properties all the inner Properties, and their
Info can then be gathered recursively. (Although in practice it still needs
to be filtered, since not all Info should propigate out of a container.)

Note that there is no change to how Properties are actually satisfied.
Just because a Property lists some child properties, this does not mean
they always have their propertySatisfy actions run. It's still up to the
parent property to run those actions.

That's necessary so that a container's properties can be satisfied inside
it, not outside. It also allows property combinators to
add the combined Properties to their childProperties list, even if,
like onChange, they don't always run the child properties at all.

Testing: I tested that the exact same Info is calculated before and after
this change, for every Host in my config file.
2015-01-18 18:46:38 -04:00
debian Property tree 2015-01-18 18:46:38 -04:00
doc close 2015-01-04 17:16:43 -04:00
privdata.joey propellor spin 2015-01-15 18:19:44 -04:00
src Property tree 2015-01-18 18:46:38 -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 propellor spin 2015-01-15 21:00:54 -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 prep release 2015-01-15 14:03:36 -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!