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

Managing the Master with the wheel modules


The wheel system is designed to provide an API to the Master, which is accessible via programs that give external access to the Master, such as Salt API.

One of the first things that you'll find when writing wheel modules is that there is no command-line program available for testing wheel modules directly. Wheel modules generally include functionality that would be available via some other means, were you logged directly in to the Master, but are still useful when manual access is not an option.

For instance, possibly the most commonly used wheel module is key, which allows a programmatic way to manage Minion keys without using the key command. Because wheel modules are available to the reactor system, you can write reactor modules that can automatically accept or delete keys for Minions based on predefined conditions.

Wrapping a wheel around runners

For our example module, we'll put together a wheel module that returns a small amount of data concerning...