Mastering StackStorm: A Complete Guide to Packs, Sensors, and Automation Workflows

StackStorm Overview

StackStorm is an automation platform that integrates services and tools, linking existing infrastructure and application environments so users can automate calls and focus on the operations that need to be performed.

Core Components

Sensors : Listen for and receive external system events; currently only Python files are supported.

Trigger : Represents an external event, acting as a bridge between sensors and rules; defined by the user.

Rule : Maps triggers to actions, recording criteria and passing trigger data to action inputs.

Action : The executable step, which can be a Python script or a command.

Workflow : An ordered collection of actions, executed according to predefined rules; supports Orquesta and Mistral formats.

Pack Structure

Packs are the smallest deployment units in StackStorm, containing actions, workflows, rules, sensors, and configuration files. Each component resides in its own directory with a configuration file and an execution file.

Packs Management

To list installed packs, run:

<code>st2 pack list</code>

Packs are stored under /opt/stackstorm/packs/<your_pack> . Installation can be performed from StackStorm Exchange, a specific commit, a version tag, or a URL, for example:

<code># Install a specific commit
st2 pack install cloudflare=776b9a4

# Install a specific version
st2 pack install cloudflare=0.1.0

# Install from a URL
st2 pack install https://github.com/emedvedev/chatops_tutorial=testing</code>

Installing a Local Pack

To install a locally developed pack, first push the pack to a Git repository, then execute:

<code>st2 pack install file:///path/to/your/pack</code>

The installation involves four steps: downloading the pack, previewing for errors, installing dependencies listed in requirements.txt , and registering the pack’s components in MongoDB.

Uninstalling a Pack

Uninstall a pack with:

<code>st2 pack remove &lt;packname&gt;</code>

This removes the pack’s registration information from MongoDB and deletes the pack files.

Registering a Pack

After installing a pack, register it manually by copying its .yaml files to /opt/stackstorm/configs/ , setting permissions to 775, and reloading the configuration:

<code>sudo st2ctl reload --register-configs</code>

Pack Development Files

A pack includes four essential files besides its modules:

requirements.txt : Lists Python dependencies and versions.

pack.yaml : Defines basic pack information such as name, version, description, and author.

<packname>.yaml : Contains default parameters for the pack; the filename matches the pack name defined in pack.yaml .

config.schema.yaml : Describes each parameter’s name, type (string, integer, number, list, object), and whether it is required or secret.