Note

The documentation you're currently reading is for version 3.7.0. 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 18.04
  • Ubuntu 20.04
  • RHEL 7 / CentOS 7
  • RHEL 8 / RockyLinux 8 / CentOS 8
  • Vagrant / OVA
  • Docker
  • Ansible Playbooks
  • Puppet Module
  • Kubernetes / HA
  • Extreme Workflow Composer
  • Configuration
  • Upgrades
  • Uninstall
• 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 Runners
  • 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
  • How Sensors are Run
  • Sensor Service
  • Common Operations
  • Datastore Management Operations
  • Running Your First Sensor
  • Examples
  • Debugging a Sensor From a Pack
• Rules
  • Rule Structure
  • Trigger
  • Criteria
  • Criteria Comparison
  • Advanced Comparison
  • Action
  • Variable Interpolation
  • Managing Rules
  • Rule Location
  • Testing Rules
  • Timers
  • Troubleshooting Rule Enforcements
• Workflows
  • Orquesta
  • ActionChain
• Packs
  • What is a Pack?
  • Managing Packs
  • Discovering Packs
  • Installing a Pack
  • Configuring a Pack
  • Overriding Pack Defaults
  • Developing a Pack
  • Advanced Topics
• Webhooks
  • Sensors vs Webhooks
  • Authentication
  • Request Body
  • Registering a Webhook
  • Using a Generic Webhook
  • Listing Registered Webhooks
  • My Webhook Isn’t Working!
  • When Not to Use Webhooks
• Datastore
  • Storing and Retrieving Key-Value Pairs via CLI
  • Storing and Retrieving Numbers, Objects and Arrays via CLI
  • Loading Key-Value Pairs from a File
  • Scoping Datastore Items
  • Setting a Key-Value Pair TTL
  • Storing and Retrieving via Python Client
  • Referencing Key-Value Pairs in Action Definitions
  • Referencing Key-Value Pairs in Rule Definitions
  • Securing Secrets (admin only)
  • Storing Secrets
  • Storing Pre-Encrypted Secrets
  • Security notes
• ChatOps
  • What is ChatOps?
  • Architecture
  • StackStorm-flavored ChatOps
  • Officially Supported Chat Providers
  • Officially Unsupported Chat Providers
  • Configuration
  • Adding New ChatOps Commands
  • Logging
  • Configuration for Microsoft Teams
  • Action Aliases
  • Notifications
  • Pack Deployment

Advanced Topics

• Authentication
  • Configuring the Service
  • Standalone Auth Mode
  • Proxy Auth Mode
  • Auth Backends
  • LDAP
  • Running the Service
  • Testing
  • Usage
  • API Keys
• Role Based Access Control
  • Terminology
  • System Roles
  • How it Works
  • Enabling RBAC
  • Defining Roles and Assignments
  • Applying RBAC Definitions
  • Automatically Granting Roles Based on LDAP Group Membership
  • Restricting Users to Only View Resources They Own or Created
  • Using RBAC Example
• Coordination
• Inquiries
  • core.ask
  • Using core.ask in a Workflow
  • Notifying Users of Inquiries using Rules
  • Responding to an Inquiry
  • Securing Inquiries
  • Garbage Collection for Inquiries
• References and Guides
  • Sharing code between Sensors and Python Actions
  • CLI Reference
  • Pack Configuration
  • Create and Contribute a Pack
  • Pack Management Transition
  • Real-time Action Output Streaming
  • Using a Specific Version of Pack Content When Running an Action
  • Jinja
  • Policies
  • Action Runners
  • Traces
  • Client Libraries and Language Bindings
  • High Availability Deployment
  • REST API Reference
  • System Monitoring
  • Partitioning Sensors
  • History and Audit
  • Secrets Masking
  • Metrics and Instrumentation
• Troubleshooting
  • Running Self-Verification
  • ChatOps Troubleshooting Guide
  • Rule is not Being Matched
  • Sensor Troubleshooting
  • SSH Troubleshooting
  • Database Issues
  • REST API access
  • Tuning Action Runner Dispatcher Pool Size
  • Purging Old Operational Data
  • WebUI Access on Private Networks
  • Enabling Debug Mode
  • Ask for help!
  • Troubleshooting Webhooks
• Development
  • Contributing
  • Setting up a Development Environment
  • General Contribution Guidelines
  • Code Style Guide
  • Pre commit hook
  • Deprecation Policy
  • General Coding Guidelines

Release Notes

• Changelog
• Upgrade Notes
• Roadmap

Other

• Security