SaltPad is a GUI and CLI tool to manage SaltStack deployments + orchestration. It's still very young and it's should be considered as Alpha.

A walkthrough using screenshots is available in the screenshots directory.

SaltPad is not yet available on Pypi, so you can clone it here: git@github.com:tinyclues/saltpad.git.

git clone git@github.com:tinyclues/saltpad.git

The Wed GUI use the HTTP Api of SaltStack to interract with the Salt-Master. You should first install the Salt-Api on your Salt-Master. You can find the documentation in the SaltStack documentation.

If you just want to test SaltPad, you can use the Vagrantfile provided in vagrant directory. Just follow README in the same repository and have fun!

The Salt-Api project has been merged into SaltStack in release 2014.7.0 but this merge seems to have introduced some changes in the API and so SaltPad is not compatible with SaltStack 2014.7.0 (yet!). Please use the release 2014.1.Z and install salt-api separately using pip:

pip install salt-api

Then you can launch the API using the following command:

salt-api -d

Or using a wsgi server, see the doc for more informations.

You'll also need to configure the external auth in your salt master. For example in master config:

external_auth:
  pam:
    myusername:
        - .*
        - '@runner'
        - '@wheel'

If your checklist is done, you can now configure SaltPad.

Get into the saltpad directory, copy the file named "local_settings.sample.py" as "local_settings.py". You'll need to edit it. Set your API_URL if your salt-master is not local and generate a secret key if you want to avoid to reconnect each time your restart SaltPad.

Now start SaltPad with this command, note that you should be in the saltpad directory:

saltpad/ $> python app.py
 * Running on http://127.0.0.1:5000/
 * Restarting with reloader

You can also serve the wsgi app with the wsgi server of your choice. The wsgi path is "saltpad.saltpad".

Now go on http://127.0.0.1:5000 in your browser, login using SaltStack external auth and enjoy!

• Get overview of all your minions.
• Get details about each minions, its Salt version.
• Easy launch of state.highstate jobs with or without dry-run mode.
• Manage minions keys.
• Launch jobs.
• Access jobs details easily.
• Save job configuration as templates and launch them with one click on a button.
• Quick debug minion, get all usefull information in one place.

TODO

TODO