Note

The documentation you're currently reading is for version 2.2.1. Click here to view documentation for the latest stable version.

StackStorm Documentation

Contents:

Getting Started

• StackStorm Overview
  • About
  • How it Works
  • What’s Next?
• Install and Configure
  • Reference Deployment Overview
  • System Requirements
  • Ubuntu 14.04 / 16.04
  • RHEL 7 / CentOS 7
  • RHEL 6 / CentOS 6
  • Ansible Playbooks
  • Brocade Workflow Composer
  • Configuration
  • Upgrades
• Quick Start
  • Explore StackStorm with CLI
  • Authenticate
  • Work with Actions
  • Define a Rule
  • Deploy a Rule
  • Deploy Examples
  • Datastore

Automation Basics

• Actions
  • Managing and Running Actions
  • Action Runner
  • Writing Custom Actions
  • Built-in Parameters
  • Overriding Runner Parameters
  • Environment Variables Available to Actions
  • Converting Existing Scripts into Actions
  • Writing Custom Python Actions
  • Pre-defined Actions
• Sensors and Triggers
  • Sensors
  • Triggers
  • Internal Triggers
  • Creating a Sensor
  • Sensor Service
  • Common Operations
  • Datastore Management Operations
  • Running Your First Sensor
  • Debugging a Sensor From a Pack
  • Examples
• Rules
  • Rule Structure
  • Trigger
  • Criteria
  • Critera Comparison
  • Action
  • Variable Interpolation
  • Managing Rules
  • Rule Location
  • Testing Rules
  • Timers
• Workflows
  • ActionChain
  • Mistral
  • Mistral + YAQL
  • Mistral + Jinja
  • CloudSlang
• Packs
  • What is a Pack?
  • Managing Packs
  • Discovering Packs
  • Installing a Pack
  • Configuring a Pack
  • Developing a Pack
  • Advanced Topics
• Webhooks
  • Sensors vs Webhooks
  • Authentication
  • Request Body
  • Registering a Webhook
  • Using a Generic Webhook
  • Listing Registered Webhooks
• Datastore
  • Storing and Retrieving Key Value Pairs via CLI
  • Scoping Datastore Items
  • Storing and Retrieving via Python Client
  • Referencing Key Value Pair in Rule Definition
  • Securing Secrets (admin only)
  • Storing Secrets
  • Security notes
• ChatOps
  • What is ChatOps?
  • Architecture
  • StackStorm-flavored ChatOps
  • Configuration
  • Adding new ChatOps commands
  • Action Aliases
  • Notifications
  • Pack Deployment

Advanced Topics

• Authentication
  • Configuring the Service
  • Auth Backends
  • LDAP (Enterprise Edition)
  • Running the Service
  • Testing
  • Usage
  • API Keys
• Role Based Access Control
  • Terminology
  • System roles
  • How it Works
  • Defining Roles and Assignments
  • Applying RBAC Definitions
  • Using RBAC Example
• References and Guides
  • CLI Reference
  • Pack Configuration
  • Create and Contribute a Pack
  • Pack Management Transition
  • Jinja
  • Policies
  • Action Runners
  • Traces
  • Client Libraries and Programming Language Bindings
  • StackStorm behind an HTTP proxy
  • High Availability Deployment
  • REST API Reference
  • Partitioning Sensors
  • History and Audit
• Troubleshooting
  • Running Self-Verification
  • ChatOps Troubleshooting Guide
  • Rule is not being matched / action is not firing
  • Sensor Troubleshooting
  • Mistral Issues
  • SSH Troubleshooting
  • Database Issues
  • REST API access
  • Tuning action runner dispatcher pool size
  • Purging Old Operational Data
  • WebUI Access on Private Networks
  • Submitting Debugging Information
  • Enabling Debug Mode
  • Ask for help!
• Development
  • Contributing
  • Setting up a Development Environment
  • General Contribution Guidelines
  • Code style guide
  • General coding guidelines
  • Instantiating model classes

Release Notes

• Changelog
• Upgrade Notes
• Roadmap