StackStorm (aka "IFTTT for Ops") is event-driven automation for auto-remediation, security responses, troubleshooting, deployments, and more. Includes rules engine, workflow, 2000+ integrations (see https://exchange.stackstorm.org), ChatOps, etc. Installer at https://docs.stackstorm.com/install/index.html. Questions? https://forum.stackstorm.com/.
Switch branches/tags
Clone or download
warrenvw Merge pull request #4350 from StackStorm/typo/adherence
Fix typo in test output schema function
Latest commit 95ac4f3 Sep 25, 2018
Permalink
Failed to load latest commit information.
.circle Apply sudoers fix for local 'circleci' user Jul 11, 2017
.circleci Rename and relocate the circle.yml file Aug 29, 2018
.github Simplified issue template Jun 8, 2018
conf Adding output_path to runners. Adding testing for action schema. Sep 14, 2018
contrib Merge branch 'master' into typo/adherence Sep 24, 2018
dev_docs Cleanup pecan and jsexpose Feb 20, 2017
instructables Removed reference to AIO Jun 29, 2016
lint-configs Update flake8 config, use better variable name. Nov 28, 2017
logs Fix: Add a logs directory Jul 14, 2014
pylint_plugins Various fixes and work-arounds for issues detected by new version of May 3, 2018
scripts Install runners when processing requirements for travis Sep 11, 2018
st2actions Merge branch 'master' into action_registration_speed_up Sep 24, 2018
st2api Merge branch 'master' into trigger_sort Sep 24, 2018
st2auth Don't submit request and response metrics for paths / endpoints such as Sep 13, 2018
st2client Update version to 3.0dev Sep 24, 2018
st2common Update version to 3.0dev Sep 24, 2018
st2debug Re-generate dist_utils.py files. Jun 28, 2018
st2exporter Re-generate dist_utils.py files. Jun 28, 2018
st2reactor Fix invalid function .call - we already call monotonic() function when Sep 24, 2018
st2stream Don't submit request and response metrics for paths / endpoints such as Sep 13, 2018
st2tests Adding output schema check for python and orquesta runner Sep 16, 2018
tools Allow for deviation of 10% before warning. Aug 16, 2018
.agignore Add fields 'position' and 'locked' for params. Sep 30, 2014
.codecov.yml Increase codecov spammy threshold in % Feb 15, 2017
.coveragerc Use .coveragerc to control covered files, and omit certain files from… Jun 14, 2018
.flake8 Adding flake8/pylint rc files into search path Nov 10, 2016
.gitignore Update .gitignore Jul 25, 2018
.gitmodules Replace submodule pack with a different pack. Apr 11, 2018
.pylintrc Adding flake8/pylint rc files into search path Nov 10, 2016
.scrutinizer.yml Update scrutinizer Jan 8, 2016
.travis.yml Remove duplicated apt-get update from travis.yml. Sep 3, 2018
CHANGELOG.rst Merge branch 'master' into trigger_sort Sep 24, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jul 24, 2017
CONTRIBUTING.rst Fix typo in CONTRIBUTING.rst Oct 31, 2016
LICENSE Change README, add LICENSE. Oct 31, 2014
Makefile Make sure we pass --config-file option to the script. Sep 24, 2018
README.md Update readme Jul 10, 2018
fixed-requirements.txt Merge branch 'master' into deps_upgrade_v290 Sep 10, 2018
requirements.txt Update orquesta revision in requirements.txt Sep 12, 2018
setup.cfg Set loglevel for nosetests to INFO Mar 24, 2017
stackstorm_logo.png Cosmetic changes to README.md Nov 7, 2014
test-requirements.txt Use 1.9.3. Aug 6, 2018
tox.ini Fix orquesta runner path in ci-py3-unit Sep 11, 2018

README.md

StackStorm

StackStorm is a platform for integration and automation across services and tools, taking actions in response to events. Learn more at www.stackstorm.com.

Tests Build Status Packages Build Status Codecov Scrutinizer Code Quality Python 2.7 CII Best Practices Join our community Slack Forum


TL;DR

StackStorm Overview

StackStorm 5 min Intro Video

About

StackStorm is a platform for integration and automation across services and tools. It ties together your existing infrastructure and application environment so you can more easily automate that environment -- with a particular focus on taking actions in response to events.

StackStorm helps automate common operational patterns. Some examples are:

  • Facilitated Troubleshooting - triggering on system failures captured by Nagios, Sensu, New Relic and other monitoring, running a series of diagnostic checks on physical nodes, OpenStack or Amazon instances, and application components, and posting results to a shared communication context, like HipChat or JIRA.
  • Automated remediation - identifying and verifying hardware failure on OpenStack compute node, properly evacuating instances and emailing VM about potential downtime, but if anything goes wrong - freezing the workflow and calling PagerDuty to wake up a human.
  • Continuous deployment - build and test with Jenkins, provision a new AWS cluster, turn on some traffic with the load balancer, and roll-forth or roll-back based on NewRelic app performance data.

StackStorm helps you compose these and other operational patterns as rules and workflows or actions; and these rules and workflows - the content within the StackStorm platform - are stored as code which means they support the same approach to collaboration that you use today for code development and can be shared with the broader open source community via StackStorm.com/community for example.

How it works

stackstorm component diagram

StackStorm architecture diagram

StackStorm plugs into the environment via the extensible set of adapters: sensors and actions.

  • Sensors are python plugins for inbound integration that watch for events from external systems and fire a StackStorm trigger when an event happens.

  • Triggers are StackStorm representations of external events. There are generic triggers (e.g. timers, webhooks) and integration triggers (e.g. Sensu alert, JIRA issue updated). A new trigger type can be defined by writing a sensor plugin.

  • Actions are StackStorm outbound integrations. There are generic actions (ssh, REST call), integrations (OpenStack, Docker, Puppet), or custom actions. Actions are either python plugins, or any scripts, consumed into StackStorm by adding a few lines of metadata. Actions can be invoked directly by user via CLI or API, or used and called as part of automations - rules and workflows.

  • Rules map triggers to actions (or to workflows), applying matching criterias and mapping trigger payload to action inputs.

  • Workflows stitch actions together into “uber-actions”, defining the order, transition conditions, and passing the data. Most automations are more than one-step and thus need more than one action. Workflows, just like “atomic” actions, are available in action library, can be invoked manually or triggered by rules.

  • Packs are the units of content deployment. They simplify the management and sharing of StackStorm pluggable content by grouping integrations (triggers and actions) and automations (rules and workflows). A growing number of packs is available on StackStorm community. User can create their own packs, share them on Github, or submit to StackStorm community repo.

  • Audit trail of action executions, manual or automated, is recorded and stored with full details of triggering context and execution results. It is is also captured in audit logs for integrating with external logging and analytical tools: LogStash, Splunk, statsd, syslog.

StackStorm is a service with modular architecture. It comprises loosely coupled service components that communicate over the message bus, and scales horizontally to deliver automation at scale. StackStorm has a full REST API, CLI client for admins and users to operate it locally or remotely, and Python client bindings for developer’s convenience. Web UI is coming soon.

StackStorm is new and under active development. We are opening it early to engage community, get feedback, and refine directions, and welcome contributions.

Documentation

Additional documentation describing installation proceduces, action/rule/workflow authoring, and how to setup and use triggers/sensors can be found at StackStorm Docs.

Hacking / Contributing

To set up dev environment and run StackStorm from sources, follow these instructions.

For information on how to contribute, style guide, coding conventions and more, please visit the Development section in our documentation.

Copyright, License, and Contributors Agreement

Copyright 2014-2018 StackStorm, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

By contributing you agree that these contributions are your own (or approved by your employer) and you grant a full, complete, irrevocable copyright license to all users and developers of the project, present and future, pursuant to the license of the project.