You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Craige McWhirter a2adad7c26
propellor spin
4 years ago
contrib avoid partial commit during merge problem 6 years ago
debian Merge remote-tracking branch 'upstream/master' 4 years ago
doc Merge remote-tracking branch 'upstream/master' 4 years ago
executables separate Hs-Source-Dirs for binaries 6 years ago
privdata Merge remote-tracking branch 'upstream/master' 4 years ago
src propellor spin 4 years ago
.gitignore add /propellor to gitignore 8 years ago
CHANGELOG Revert "switch CHANGELOG to be the real file and debian/changelog the symlink" 7 years ago
LICENSE update email 9 years ago
Makefile Makefile: Update clean. 5 years ago
README.md add basic front page 10 years ago
Setup.hs fix 10 years ago
config-freebsd.hs use stretch in debian stable examples 6 years ago
config-simple.hs convert Architecture to a sumtype 7 years ago
config.hs propellor spin 4 years ago
joeyconfig.hs Merge remote-tracking branch 'upstream/master' 4 years ago
propellor.cabal Merge remote-tracking branch 'upstream/master' 4 years ago
stack.yaml stack.yaml: Updated to lts-9.21. 6 years ago

README.md

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

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 in the file ~/.propellor/config.hs. 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). apt-get install propellor or cabal install propellor or cabal unpack propellor; cd propellor-version; stack install
  2. Run propellor --init ; this will set up a ~/.propellor/ git repository for you.
  3. Edit ~/.propellor/config.hs, and add a host you want to manage. You can start by not adding any properties, or only a few.
  4. Run: propellor --spin $HOST
  5. Now you have a simple propellor deployment to a host. Continue editing ~/.propellor/config.hs to further configure the host, add more hosts etc, and re-run propellor --spin $HOST after each change.
  6. Once you have a lot of hosts, and running propellor --spin HOST for each host becomes tiresome, you can automate that.
  7. Write some neat new properties and send patches!

(Want to get your feet wet with propellor before plunging in? try this)