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

Forming a state module


State modules are more structured than most other kinds of modules, but as you'll soon see, that actually makes them easier to write.

Determining state

There is a set of operations that a state module must take in order to perform its job, and as those operations are done, there is certain data that is stored. Let's start off with a pseudo piece of code, and explain each component in turn:

def __virtual__():
    '''
    Only load if the necesaary modules available in __salt__
    '''
    if 'module.function' in __salt__:
        return True
    return False


def somestate(name):
    '''
    Achieve the desired state

    nane
        The name of the item to achieve statefulness
    '''
    ret = {'name': name,
           'changes': {},
           'result': None,
           'comment': ''}
    if <item is already in the desired state>:
        ret['result'] = True
        ret['comment'] = 'The item is already in the desired state'
        return ret
    if __opts__...