bruienne/sal repository overview

Sal is a Munki-centric reporting tool written by Graham Gilbert of Pebble IT. Thanks go out to Graham and Pebble IT for giving the go-ahead for this repository. Sal has been prebuilt with an admin user: use admin/admin as login and password. To pull and invoke simply run:

$ docker pull bruienne/sal    
$ docker run -d -p 8080:80 bruienne/sal

This will start Sal on port 8080 on localhost. Port and interface mappings may be modified by the user as needed. To verify Sal is running:

$ docker ps
CONTAINER ID  IMAGE  COMMAND  CREATED  STATUS  PORTS  NAMES
f31599a237c4  bruienne/sal:latest /usr/sbin/httpd -D F  28 minutes ago  Up 28 minutes  0.0.0.0:8080->80/tcp, 8080/tcp drunk_ptolemy

All submitted data is stored in the container, so make sure to offload it somewhere if it'll be needed later before terminating the container. The Dockerfile used to build the container is included. The official Sal Readme follows below.

⁠Sal

Sal is (currently) a multi-tennanted reporting dashboard for Munki⁠ and optionally, information from Facter⁠. It has a plugin system allowing you to easily build widgets to display your custom information from Facter or Munki's conditional items⁠ (or both!).

With Sal, you are able to allow access to reports on certain sets of machines to certain people - for example, giving a manager access to the reports on the machines in their department.

⁠Getting Started

First off, you're going to need to get the Server and then the Client installed. Instructions can be found here⁠.

Once you've got clients reporting in, you're probably going to want to customise what you see on the various screens. Here is a full list⁠ of the various options that can be set in sal/settings.py.

After re-ordering and hiding plugins from some screens, you might even want to make your own plugins. At the moment, you'll need to base yours off of the included ones, and my repository of optional ones⁠. I owe you a blog post and some documentation on that, but trust me, it's easy if you know python, and completely possible if you don't.

⁠Discussion

Discussion on the use and development of Sal is available on the Google Group⁠.

⁠Why Sal?

It's the Internet's fault! I asked on Twitter what I should call it, and Peter Bukowinski (@pmbuko⁠) suggested the name⁠, based on a Monkey puppet called Sal Minella⁠.

⁠Thank yous

First off, thanks to Greg Neagle and the rest of the Munki Project. This started off using quite a lot of Munki Web Admin's code (and still contains portions of it). Munki is an amazing product, and managing OS X at any scale would be miserable without it.

Thanks to Puppet Labs for basically giving away the crown jewels for nothing.

And finally, thanks to my lovely employers, pebble.it⁠ for letting me release this. They could just as easily have told me that this was staying in house, but they believe in open source as much as I do (did I mention they were lovely?).