Book Image

Extending SaltStack

Book Image

Extending SaltStack

Overview of this book

Salt already ships with a very powerful set of tools, but that doesn't mean that they all suit your needs perfectly. By adding your own modules and enhancing existing ones, you can bring the functionality that you need to increase your productivity. Extending SaltStack follows a tutorial-based approach to explain different types of modules, from fundamentals to complete and full-functioning modules. Starting with the Loader system that drives Salt, this book will guide you through the most common types of modules. First you will learn how to write execution modules. Then you will extend the configuration using the grain, pillar, and SDB modules. Next up will be state modules and then the renderers that can be used with them. This will be followed with returner and output modules, which increase your options to manage return data. After that, there will be modules for external file servers, clouds, beacons, and finally external authentication and wheel modules to manage the master. With this guide in hand, you will be prepared to create, troubleshoot, and manage the most common types of Salt modules and take your infrastructure to new heights!
Table of Contents (21 chapters)
Extending SaltStack
About the Author
About the Reviewer

Writing outputter modules

When the salt command is used, any return data that is received during the wait period will be displayed to the user. Outputter modules are used in this case to display that data to the console (or more accurately, to STDOUT), usually in a format that is somewhat user-friendly.

Pickling our output

Because Salt already ships with a json outputter, we'll take advantage of the fact that output data is technically going to STDOUT, and put together an outputter that uses a serializer (pickle) that may dump binary data:

Pickle outputter

This file should be saved as salt/output/
from __future__ import absolute_import
import pickle

def output(data):
    Dump out data in pickle format
    return pickle.dumps(data)

This outputter is about as simple as it gets. The only required function is called output(), and it accepts a dictionary. It doesn't matter what the dictionary is called, so long as the function has one defined.

The pickle library...