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 file servers


File server modules can be tricky to troubleshoot, because so many of the pieces need to be in place before others are usable. But there are some tricks that you can keep in mind.

Start small

I've tried to present the functions that are necessary, in the order that is easiest for writing and troubleshooting. While envs() cannot be called directly, it is easy to write, and can be debugged while working on file_list() and dir_list(). And those two functions are easy to troubleshoot using the cp.list_master and cp.list_master_dirs functions, respectively.

Test on a Minion

While file server modules are designed to be used on the Master, it is possible to test them on a Minion. Be sure to define all of the appropriate configurations in the minion configuration file instead of the master file. Use salt-call --local to issue commands, and regularly wipe both the local cache (in /var/salt/cache/) and any files that were downloaded using cp.get_file.