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

Troubleshooting renderers


Because renderers are so often used to manage SLS files, it is often easiest to troubleshoot them using the state compiler, as we have been doing already in this chapter.

First, generate a small SLS file that contains the specific elements which you need to test. This will either be a data file in the format that a serialization engine uses, or a text-based file that results in a data-serialization file format. If you are writing a templating renderer, it is often easiest to just use YAML.

The state execution module contains a number of functions that exist primarily for troubleshooting. We used state.show_sls in our examples, with --out yaml, because it displays the output in a format that we're already used to in our SLS files. However, some other useful functions are:

  • state.show_low_sls: Shows data from a single SLS file, after it has been converted to low data by the State compiler. Low data is often easier to visualize when writing state modules.

  • state.show_highstate...