Configs
Go to file
Joey Hess 5f99f78939 add news item for propellor 0.5.0 2014-04-19 17:50:04 -04:00
Propellor When unattendedUpgrades is enabled on an Unstable or Testing system, configure it to allow the upgrades. 2014-04-19 13:17:25 -04:00
Utility merge from git-annex 2014-04-12 13:32:04 -04:00
debian Merge branch 'joeyconfig' 2014-04-19 17:38:23 -04:00
doc add news item for propellor 0.5.0 2014-04-19 17:50:04 -04:00
privdata propellor spin 2014-04-13 21:34:19 -04:00
.gitignore propellor spin 2014-04-04 00:18:51 -04:00
CHANGELOG changelog 2014-04-01 15:07:07 -04:00
GPL cabalized and added a wrapper program 2014-03-30 00:08:02 -04:00
Makefile deps 2014-04-10 17:50:16 -04:00
Propellor.hs new more expressive config.hs WIP 2014-04-10 21:13:56 -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 cleanup 2014-04-19 17:16:13 -04:00
config-simple.hs cleanup 2014-04-19 17:16:13 -04:00
config.hs Revert "change joeyconfig back after merging from master" 2014-04-19 16:18:11 -04:00
propellor.cabal prep release 2014-04-19 17:38:15 -04:00
propellor.hs debianization and a wrapper program for /usr/bin 2014-04-03 01:55:49 -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.

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 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. cd ~/.propellor/; use git to push the repository to a central server (github, or your own git server). Configure that central server as the origin remote of the repository.

  4. If you don't have a gpg private key, generate one: gpg --gen-key

  5. Run: propellor --add-key $KEYID

  6. Edit ~/.propellor/config.hs, and add a host you want to manage. You can start by not adding any properties, or only a few.

  7. Pick a host and run: propellor --spin $HOST

  8. 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 (maybe start with a few simple properties), and re-run step 7. Repeat until happy and move on to the next host. :)

  9. To move beyond manually running propellor --spin against hosts when you change their properties, add a property to your hosts like: Cron.runPropellor "30 * * * *"

    Now they'll automatically update every 30 minutes, and you can git commit -S and git push changes that affect any number of hosts.

  10. Write some neat new properties and send patches to propellor@joeyh.name!

debugging

Set PROPELLOR_DEBUG=1 to make propellor print out all the commands it runs and any other debug messages that Properties choose to emit.