You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-19Lines changed: 27 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,14 @@
2
2
3
3
**StackStorm** is a platform for integration and automation across services and tools, taking actions in response to events. Learn more at [www.stackstorm.com](http://www.stackstorm.com/product).
4
4
5
-
[](https://travis-ci.org/StackStorm/st2)[](https://circleci.com/gh/StackStorm/st2)[](https://codecov.io/github/StackStorm/st2?branch=master)[](https://bestpractices.coreinfrastructure.org/projects/1833)[](https://stackstorm.com/community-signup)[](https://forum.stackstorm.com/)
5
+
[](https://travis-ci.org/StackStorm/st2)
@@ -27,51 +34,51 @@ StackStorm is a platform for integration and automation across services and tool
27
34
28
35
StackStorm helps automate common operational patterns. Some examples are:
29
36
30
-
***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.
37
+
***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 Slack or JIRA.
31
38
***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.
32
39
***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.
33
40
34
-
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.
41
+
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 Exchange](https://exchange.stackstorm.com).
35
42
36
43
### Who is using StackStorm?
37
44
38
45
See the list of known StackStorm [ADOPTERS.md](/ADOPTERS.md) and [Thought Leaders](https://stackstorm.com/stackstorm-thought-leaders/).
StackStorm plugs into the environment via the extensible set of adapters: sensors and actions.
53
+
StackStorm plugs into the environment via an extensible set of adapters: sensors and actions.
47
54
48
-
***Sensors** are python plugins for inbound integration that watch for events from external systems and fire a StackStorm trigger when an event happens.
55
+
***Sensors** are Python plugins for inbound integration that watch for events from external systems and fire a StackStorm trigger when an event happens.
49
56
50
-
***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.
57
+
***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.
51
58
52
-
***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 CLIor API, or used and called as part of automations - rules and workflows.
59
+
***Actions** are StackStorm outbound integrations. There are generic actions (SSH, HTTP request), 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, API, or the web UI, or used and called as part of automations - rules and workflows.
53
60
54
-
***Rules** map triggers to actions (or to workflows), applying matching criterias and mapping trigger payload to action inputs.
61
+
***Rules** map triggers to actions (or to workflows), applying matching criterias and map trigger payload data to action inputs.
55
62
56
-
***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.
63
+
***Workflows** stitch actions together into "uber-actions", defining the order, transition conditions, and passing context data from one action to the next. Most automations are multi-step (eg: more than one action). Workflows, just like "atomic" actions, are available in the action library, and can be invoked manually or triggered by rules.
57
64
58
-
***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.
65
+
***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 the StackStorm Exchange. Users can create their own packs, share them on GitHub, or submit them to the StackStorm Exchange organization.
59
66
60
-
***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.
67
+
***Audit trail**is the historical list of action executions, manual or automated, and 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, or syslog.
61
68
62
-
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 clientfor admins and users to operate it locally or remotely, and Python client bindings for developer’s convenience. Web UI is coming soon.
69
+
StackStorm is a service with modular architecture. It is comprised of loosely coupled microservice components that communicate over a message bus, and scales horizontally to deliver automation at scale. StackStorm has a full REST API, CLI client, and web UI for admins and users to operate it locally or remotely, as well as Python client bindings for developer convenience.
63
70
64
-
StackStorm is new and under active development. We are opening it early to engage community, get feedback, and refine directions, and welcome contributions.
71
+
StackStorm is an established project and remains actively developed by a broad community.
65
72
66
73
## Documentation
67
74
68
-
Additional documentation describing installation proceduces, action/rule/workflow authoring, and how to setup and use triggers/sensors can be found at [StackStorm Docs](https://docs.stackstorm.com).
75
+
Additional documentation, including installation proceduces, action/rule/workflow authoring, and how to setup and use triggers/sensors can be found at [https://docs.stackstorm.com](https://docs.stackstorm.com).
69
76
70
77
## Hacking / Contributing
71
78
72
-
To set up dev environment and run StackStorm from sources, follow [these instructions](https://docs.stackstorm.com/development/sources.html).
79
+
To set up a development environment and run StackStorm from sources, follow [these instructions](https://docs.stackstorm.com/development/sources.html).
73
80
74
-
For information on how to contribute, style guide, coding conventions and more,
81
+
For information on how to contribute, our style guide, coding conventions and more,
75
82
please visit the [Development section](https://docs.stackstorm.com/development/index.html)
76
83
in our documentation.
77
84
@@ -85,9 +92,10 @@ in 48 hours or less. If further action is necessary, you may receive additional
85
92
86
93
For more information, please refer to https://docs.stackstorm.com/latest/security.html
87
94
88
-
## Copyright, License, and Contributors Agreement
95
+
## Copyright, License, and Contributor Agreement
89
96
90
97
Copyright 2020 The StackStorm Authors.
98
+
Copyright 2019 Extreme Networks, Inc.
91
99
Copyright 2014-2018 StackStorm, Inc.
92
100
93
101
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](LICENSE) file, or at:
0 commit comments