propellor: property-based host configuration management in haskell

[ bsd2, library, program, utility ] [ Propose Tags ] [ Report a vulnerability ]

Propellor ensures that the system it's run in satisfies a list of properties, taking action as necessary when a property is not yet met.

It is configured using haskell.


[Skip to Readme]

Modules

[Index] [Quick Jump]

Flags

Automatic Flags
NameDescriptionDefault
withtypeerrors

Build with type-errors library for better error messages

Enabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1, 0.1.1, 0.1.2, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.3.0, 0.3.1, 0.4.0, 0.5.0, 0.5.1, 0.5.3, 0.6.0, 0.7.0, 0.8.0, 0.8.1, 0.8.2, 0.8.3, 0.9.0, 0.9.1, 0.9.2, 1.0.0, 1.2.0, 1.2.1, 1.3.2, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0, 2.5.0, 2.6.0, 2.7.0, 2.7.1, 2.7.2, 2.7.3, 2.8.0, 2.8.1, 2.9.0, 2.10.0, 2.11.0, 2.12.0, 2.13.0, 2.14.0, 2.15.0, 2.15.1, 2.15.2, 2.15.3, 2.15.4, 2.16.0, 2.17.0, 2.17.1, 2.17.2, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.0.5, 3.1.0, 3.1.1, 3.1.2, 3.2.0, 3.2.1, 3.2.2, 3.2.3, 3.3.0, 3.3.1, 3.4.0, 3.4.1, 4.0.0, 4.0.1, 4.0.2, 4.0.3, 4.0.4, 4.0.6, 4.1.0, 4.2.0, 4.3.0, 4.3.1, 4.3.2, 4.3.3, 4.3.4, 4.4.0, 4.5.0, 4.5.1, 4.5.2, 4.6.0, 4.6.1, 4.6.2, 4.7.0, 4.7.1, 4.7.2, 4.7.3, 4.7.4, 4.7.5, 4.7.6, 4.7.7, 4.8.0, 4.8.1, 4.9.0, 5.0.0, 5.1.0, 5.2.0, 5.3.0, 5.3.1, 5.3.2, 5.3.3, 5.3.4, 5.3.5, 5.3.6, 5.4.0, 5.4.1, 5.5.0, 5.6.0, 5.6.1, 5.7.0, 5.8.0, 5.9.0, 5.9.1, 5.10.1, 5.10.2, 5.11, 5.12, 5.13, 5.14, 5.14.1, 5.15, 5.16, 5.17
Change log CHANGELOG
Dependencies ansi-terminal, async (>=2.0.0.0), base (>=4.9 && <5), bytestring, containers (>=0.5), directory, exceptions (>=0.6), filepath, hashable, hslogger, IfElse, mtl, network, process, propellor, split (>=0.2.0.0), stm, text, time, transformers, type-errors, unix, unix-compat [details]
License BSD-2-Clause
Copyright 2014-2023 Joey Hess
Author Joey Hess
Maintainer Joey Hess <id@joeyh.name>
Category Utility
Home page https://propellor.branchable.com/
Source repo head: git clone https://git.joeyh.name/git/propellor.git
Uploaded by JoeyHess at 2023-06-10T13:49:52Z
Distributions Debian:5.13, NixOS:5.17
Reverse Dependencies 1 direct, 0 indirect [details]
Executables propellor, propellor-config
Downloads 85224 total (429 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for propellor-5.17

[back to package description]

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, 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)