8c1848b897 | ||
---|---|---|
debian | ||
doc | ||
privdata | ||
src | ||
.gitignore | ||
CHANGELOG | ||
LICENSE | ||
Makefile | ||
README.md | ||
Setup.hs | ||
config-joey.hs | ||
config-simple.hs | ||
config.hs | ||
propellor.cabal |
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
-
Get propellor installed
cabal install propellor
orapt-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. -
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. -
Edit
~/.propellor/config.hs
, and add a host you want to manage. You can start by not adding any properties, or only a few. -
Pick a host and 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 (maybe start with a few simple properties), and re-run step 7. Repeat until happy and move on to the next host. :) -
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
andgit push
changes that affect any number of hosts. -
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.