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
Credits
Foreword
About the Author
About the Reviewer
www.PacktPub.com
Preface
Index

Using Salt's local client


Runners were originally designed to run on the Master, to combine multiple jobs across Minions into one complete task. In order to communicate with those Minions, a runner needs to use local_client. Unlike other components, this is not built directly into runners; you need to initialize the client yourself. Let's set up a quick example:

import salt.client
client = salt.client.get_local_client(__opts__['conf_file'])
minions = client.cmd('*', 'test.ping', timeout=__opts__['timeout'])

These three lines form the basis of setting up and using the local client. First, we import the salt.client library. Then, we instantiate a client object, which is used to communicate to Salt. When creating that client object, you do need to tell it where to find Salt's configuration file. Luckily, this is something we get for free in the __opts__ dictionary, and we're unlikely to need to change it, so that line in your code will probably always look exactly like what we've done here.

The...