Note

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

Welcome to StackStorm’s documentation!

Contents:

• StackStorm Overview
  • About
  • How it works
  • What’s Next?
• Installation
  • Reference Deployment
    • 1. st2 services
    • 2. st2client
    • 3. st2mistral
    • 4. NGINX for WebUI and SSL termination
    • 5. st2chatops - ChatOps components
    • Dependencies
    • Multi-box/HA deployment
  • Ubuntu / Debian
    • Supported versions
    • Sizing the server
    • Minimal installation
    • Configure Authentication
    • Install WebUI and setup SSL termination
    • Setup ChatOps
    • Upgrade to Enterprise Edition
  • RHEL 7 / CentOS 7
    • Supported platforms
    • Sizing the server
    • Minimal installation
    • Configure Authentication
    • Install WebUI and setup SSL termination
    • Setup ChatOps
    • Upgrade to Enterprise Edition
  • RHEL 6 / CentOS 6
    • Supported platforms
    • Sizing the server
    • Minimal installation
    • Configure Authentication
    • Install WebUI and setup SSL termination
    • Setup ChatOps
    • Upgrade to Enterprise Edition
  • StackStorm Enterprise
  • Updates and Upgrades
    • I am using the new packages based installer
    • I am using all-in-one (AIO) installer or st2_deploy script based installer
    • FAQ:
    • I am using version < v1.3 and trying to upgrade to latest versions
  • Migration scripts
    • Version-specific migration scripts
• Configuration
  • Nginx and WSGI
  • Configure MongoDB
  • Configure RabbitMQ
  • Configure SSH
    • SSH Troubleshooting
    • Using SSH config
  • SUDO Access
  • Configure Logging
  • Configure Mistral
  • Authentication
  • Configure ChatOps
  • Configure secrets masking
  • Web UI
    • Deployment
    • Configuration
    • Authentication
  • Windows Runners Configuration
    • Pre-requisites
    • Supported Windows Versions
    • Configuring your Window Server for remote access
    • Additional resources and links
• 101 Video
• Quick Start
  • Explore StackStorm with CLI
  • Authenticate
  • Work with Actions
  • Define a Rule
  • Deploy Rule
  • Deploy Examples
  • Datastore
• Integration Packs
  • What is a Pack?
  • Packs location and discovery
  • Getting a pack
  • Creating a Pack
• Pack Configuration
  • Basic Concepts and Terminology
    • Configuration schema
    • Configuration file
    • Static configuration value
    • Dynamic configuration value
  • Configuration loading and dynamic value resolving
  • Configuring dynamic configuration values using the CLI
    • Configuring a regular (non user-scoped) dynamic configuration value
    • Configuring a user-scoped dynamic configuration value
  • Limitations
    • Dynamic config values
    • User context
• Actions
  • Managing and Running Actions
  • Action Runner
    • Available runners
  • Writing custom actions
    • Action metadata
    • Parameters in actions
    • Action Registration
  • Built-in Parameters
  • Overriding Runner Parameters
  • Common environment variables available to the actions
  • Converting existing scripts into actions
    • 1. Make sure the script conforms to the conventions described above
    • 2. Add a metadata file
    • 2. Update argument parsing in the script
    • Example 1 - existing Bash script with positional arguments
  • Writing custom Python actions
    • Sample Python action
    • Configuration file
    • Logging
    • Action Service
  • Pre-defined actions
• Action Runners
  • Exit Codes
  • Local command runner (local-shell-cmd)
    • Runner parameters
  • Local script runner (local-shell-script)
    • Runner parameters
  • Remote command runner (remote-shell-cmd)
    • Runner parameters
  • Remote script runner (remote-shell-script)
    • Runner parameters
  • Windows command runner (windows-cmd)
    • Runner parameters
  • Windows script runner (windows-script)
    • Runner parameters
  • HTTP runner (http-request)
    • Runner parameters
  • Python runner (python-script)
    • Runner parameters
  • ActionChain runner (action-chain)
    • Runner parameters
  • Mistral runner (mistral-v2)
    • Runner parameters
  • CloudSlang runner (cloudslang)
    • Runner parameters
• Rules
  • Rule Structure
  • Trigger
  • Criteria
  • Critera Comparision
  • Action
  • Variable Interpolation
  • Managing Rules
  • Rule location
  • Testing Rules
  • Timers
    • core.st2.IntervalTimer
    • core.st2.DateTimer
    • core.st2.CronTimer
• Workflows
  • ActionChain
    • Authoring an ActionChain
  • Mistral
    • Basic Workflow
    • Canceling Workflow Execution
    • Rerunning Workflow Execution
    • Publishing variables in Mistral workflows
    • Stitching together a more Complex Workflow
    • More Examples
  • Mistral + YAQL
    • Basics
    • Dictionaries
    • Lists
    • Queries
    • List to Dictionary
    • Other YAQL Functions
    • Testing YAQL Expressions
  • CloudSlang
    • Simple Workflow
• Triggers and Sensors
  • Sensors
  • Triggers
  • Internal triggers
    • Action
    • Key Value Pair
    • Sensor
  • Creating a sensor
  • Sensor service
  • Common operations
    • 1. dispatch(trigger, payload, trace_tag)
    • 2. get_logger(name)
  • Datastore management operations
    • 1. list_values(local=True, prefix=None)
    • 2. get_value(name, local=True)
    • 3. set_value(name, value, ttl=None, local=True)
    • 4. delete_value(name, local=True)
    • API Docs
  • Running your first sensor
  • Debugging a sensor from a pack
  • Examples
• Webhooks
  • What is the difference between sensors and webhooks?
  • Authentication
    • API key-based
    • Token-based
  • Request body
  • Using a generic st2 webhook
  • Registering a custom webhook
  • Listing registered webhooks
• ChatOps
  • What is ChatOps?
  • Architecture
  • StackStorm flavored ChatOps
  • Configuration
    • Package-based install
    • Bring your own Hubot
  • Adding new ChatOps commands
  • Action Aliases
    • Action Alias Structure
    • Supported formats
    • Multiple formats in single alias
    • “Display-representation” format objects
    • Acknowledgment options
    • Result options
    • Plaintext messages (Slack and HipChat)
    • ChatOps
  • Notifications
    • How to setup a notification for a simple action?
    • How to write a rule for notification?
    • Jinja templating in message and data
    • How do I setup notifications in an action chain?
    • How do I setup different notifications for different tasks in the chain?
    • How do I setup notifications for Mistral?
    • How do I skip notifications for tasks in workflow or chain?
    • ChatOps and notifications
  • Pack Deployment
    • Installing packs from st2incubator or st2contrib via ChatOps
    • Deploying Custom packs via ChatOps
    • Automating Custom Pack Deployment
• Policies
  • Concurrency
  • Retry
• Datastore
  • Storing and Retrieving Key Value Pairs from CLI
  • Scoping items stored in datastore
  • Storing and Retrieving from Python Client
  • Referencing Key Value Pair in Rule Definition
  • Securing secrets in key value store (admin only)
  • Storing secrets in key value store
  • Security notes
• History and Audit
  • CLI
  • Logstash
  • Coming soon
• Traces
  • Examples
    • External events
    • Connected flows
  • Tracing Triggers and Executions
    • What is a trace_tag and trace_id?
    • Dispatch a Trigger
    • Webhook
    • Execute an Action
  • Viewing Traces
    • List
    • Get
  • Is everything traced?
• CLI Reference
  • Installation
  • Configuration
    • Configuration file
    • Authentication and auth token caching
  • Using debug mode
  • Using CLI inside scripts
  • Obtaining an authentication token inside scripts
  • Changing the CLI output format
  • Only displaying a particular attribute when retrieving action result
  • Escaping shell variables when using core.local and core.remote actions
  • Specifying parameters with type “array”
  • Specifying parameters with type “object”
  • Reading parameter value from a file
  • Re-running an action
  • Cancel an execution
  • Inheriting all the environment variables which are accessible to the CLI and passing them to runner as env parameter
• Authentication
  • Configuring the Service
  • Auth Backends
  • LDAP (Enterprise Edition)
    • LDAP
  • Running the Service
  • Testing
  • Usage
  • API Keys
    • API Key Usage
    • API key migration
  • Sending authentication token or API key to the API
• Role Based Access Control
  • Terminology
    • User
    • Role
  • System roles
    • Permission grant
    • Available permission types
    • Pack
    • Sensor Type
    • Action
    • Action Alias
    • Rule
    • Execution
    • Webhook
    • User permissions
    • Resource
  • How it works
    • Permission inheritance
    • Permissions and executions which are not triggered via the API
  • Defining roles and assignments
    • Defining roles and permission grants
    • Defining user role assignments
  • Applying RBAC definitions
  • Using RBAC - example
    • User creation
    • Role creation
    • Role assignment
    • Applying RBAC
    • Validation
• Reference
  • Client Libraries and Programming Language Bindings
    • Official Client Libraries
    • JavaScript (client side, backend)
    • Unofficial Client Libraries
    • C# / .net
    • PowerShell module
  • CLI and Python Client
    • Install
    • Endpoint Configuration
    • CLI
    • Python Client
  • REST API Reference
  • Create and Contribute a Pack
    • Anatomy
    • My first pack
    • Pushing a Pack to the Community
    • Contributors License Agreement
  • Jinja Filters
    • Filters with regex support
    • Filters to work with version
  • Partitioning Sensors
    • 1. Default
    • 2. Key-Value Store
    • 3. File
    • 4. Hash
• Troubleshooting
  • Running Self-Verification
  • Rule is not being matched / action is not firing
    • 1. Validate if rule was enforced
    • 2. Validate trigger is emitted
    • 3. Validate if rules for a trigger are being loaded
    • 4. Verifying the rule criteria
    • 5. Verifying that action runner service is running
    • 6. Ask for help!
  • Troubleshooting Sensors
    • 1. Verify sensor is registered
    • 2. Verify virtual environment for pack to which sensor belongs exists
    • 3. Checking st2sensorcontainer service logs
  • SSH troubleshooting
  • Troubleshooting Database Issues
    • Troubleshooting performance and missing index related issues
  • REST API access
    • Unable to access REST APIs
  • Purging old operational data from database
    • 1. Automatic purging via garbage collector service
    • 2. Manual purging using purge scripts
  • Submitting debugging information to StackStorm
    • Reviewing the debug information
  • Customizing the debug information gathered
  • Enabling Debug Mode
  • Ask for help!
• StackStorm behind an HTTP proxy
  • Configuring git
  • Configuring pip
• Development
  • Contributing
  • Setting up a development environment
  • General contribution guidelines
  • Code style guide
  • General coding guidelines
    • Logging
    • Dealing with dates and datetime objects
  • Instantiating model classes
    • Code structure
    • StackStorm/st2 repo
    • st2common
    • st2api
    • st2auth
    • st2actions
    • st2client
    • st2debug
    • st2reactor
    • st2tests
    • Testing
    • Pack Testing
• Changelog
  • 1.5.1 - July 13, 2016
  • 1.5.0 - June 24, 2016
  • 1.4.0 - April 18, 2016
  • 1.3.2 - February 12, 2016
  • 1.3.1 - January 25, 2016
  • 1.3.0 - January 22, 2016
  • 1.2.0 - December 07, 2015
  • 1.1.1 - November 13, 2015
  • 1.1.0 - October 27, 2015
  • 0.13.2 - September 09, 2015
  • 0.13.2 - September 09, 2015
  • 0.13.1 - August 28, 2015
  • 0.13.0 - August 24, 2015
  • 0.12.2 - August 11, 2015
  • 0.12.1 - July 31, 2015
  • 0.12.0 - July 20, 2015
  • 0.11.6 - July 2, 2015
  • 0.11.5 - July 1, 2015
  • 0.11.4 - June 30, 2015
  • 0.11.3 - June 16, 2015
  • 0.11.2 - June 12, 2015
  • 0.11.1 - June 8, 2015
  • 0.11.0 - June 5, 2015
  • v0.9.2 - May 26, 2015
  • v0.9.1 - May 12, 2015
  • v0.9.0 - April 29, 2015
  • v0.8.3 - March 23, 2015
  • v0.8.2 - March 10, 2015
  • v0.8.1 - March 10, 2015
  • v0.8.0 - March 2, 2015
  • v0.7 - January 16, 2015
  • v0.6.0 - December 8, 2014
  • v0.5.1 - November 3rd, 2014
• Upgrade Notes
  • StackStorm in development
  • StackStorm v1.5
  • StackStorm v1.4
  • StackStorm v1.3
  • StackStorm v1.2
    • Upgrading from 1.1
  • StackStorm v1.1
    • Migrating to v1
    • Changes
  • StackStorm v 0.11
  • StackStorm v0.9
• Roadmap