nacos
an easy-to-use dynamic service discovery, configuration and service management platform for building AI cloud native applications.
- 34k
- Java
- Apache-2.0
- 2 d ago
Puppet Module to install and configure StackStorm, IFTTT for Ops
Repo StackStorm/puppet-st2, read from GitHub 11 h ago. StackStorm has not joined Take My Repo.
StackStorm/puppet-st2 is a public repo on GitHub by StackStorm. Puppet Module to install and configure StackStorm, IFTTT for Ops. It declares the Apache-2.0 license on GitHub. It is written mainly in Puppet, has 22 stars and last changed on 2023-08-23. Nobody has reviewed it on Take My Repo yet, which says nothing about its quality. Read from GitHub on 2026-11-21.
In the maintainer's words. Shown from GitHub; Take My Repo does not keep a copy.
Module to manage StackStorm with Puppet.
The st2 module configures the existing into a complete and dedicated StackStorm node with the following components:
This module, similar to normal StackStorm installs, expects to be run on a blank system without any existing configurations. The only hard requirements are on the Operating System and machine specs. See Limitations and the official StackStorm system requirements.
This module installs and configures all of the components required for StackStorm.
In order to not repeat others work, we've utilized many existing modules from the
forge. We manage the module dependenies using a Puppetfile for each OS we support.
These Puppetfile can be used both with r10k
and librarian-puppet.
For a full installation on a single node, a profile already exists to get you setup and going with minimal effort. Simply:
puppet module install stackstorm-st2
puppet apply -e "include st2::profile::fullinstall"
This module uses Puppet Strings as the documentation standard. An live version is available online at puppetmodule.info/m/stackstorm-st2. A markdown version is available directly in this repo in REFERENCE.md.
This module aims to provide sane default configurations, but also stay out of your way in the event you need something more custom. To accomplish this, this module uses the Roles/Profiles pattern. Included in this module are several modules that come with sane defaults that you can use directly or use to compose your own site-specific profile for StackStorm installation.
Configuration can be done directly via code composition, or set via Hiera data bindings. A few notable parameters to take note of:
st2::version - Version of ST2 to install. This will be set as the ensure
value on the st2 packages. The default is present resulting in the most
up to date packages being installed initially. If you would like to hard code
to an older version you can specify that here (ex: 2.6.0).
Note Setting this to latest is NOT recommended. It will cause the
StackStorm packages to be automatically updated without the proper upgrade steps
being taken (proper steps detailed here: https://docs.stackstorm.com/install/upgrades.html)
st2::python_version - Version to Python to use. The default is 'system' and the
system python package will be installed, whatever version that is for your OS.
To explicitly install Python 3.8 specify '3.8' if on RHEL/CentOS 7.
If on Ubuntu 16.04 specify 'python3.8'.
Notes
'rhel-7-server-optional-rpms'
will need to be enabled prior to running this module.# CentOS/RHEL 7
class { 'st2':
python_version => '3.8',
}
# Ubuntu 18.04/20.04
class { 'st2':
python_version => 'python3.8',
}
contain st2::profile::fullinstall
All other classes are documented with Puppetdoc. Please refer to specific classes for use and configuration.
st2::profile::client - Profile to install all client libraries for st2st2::profile::fullinstall - Full installation of StackStorm and dependenciesst2::profile::mistral - Install of OpenStack Mistralst2::profile::mongodb - st2 configured MongoDB installationst2::profile::nodejs - st2 configured NodeJS installationst2::profile::python - Python installed and configured for st2st2::profile::rabbitmq - st2 configured RabbitMQ installationst2::profile::redis - st2 configured Redis installationst2::proflle::server - st2 server componentsst2::profile::web - st2 web componentsst2::profile::chatops - st2 chatops componentsst2::profile::metrics - st2 set up metricsStackStorm packs can be installed and configured directly from Puppet. This
can be done via the st2::pack and st2::pack::config defined types.
Installation/Configuration via modules:
# install pack from the exchange
st2::pack { 'linux': }
# install pack from a git URL
st2::pack { 'private':
repo_url => 'https://private.domain.tld/git/stackstorm-private.git',
}
# install pack and apply configuration
st2::pack { 'slack':
config => {
'post_message_action' => {
'webhook_url' => 'XXX',
},
},
}
Installation/Configuration via Hiera:
st2::packs:
linux:
ensure: present
private:
ensure: present
repo_url: https://private.domain.tld/git/stackstorm-private.git
slack:
ensure: present
config:
post_message_action:
webhook_url: XXX
StackStorm uses a pluggable authentication system where auth is delegated to
an external service called a "backend". The st2auth service can be configured
to use various backends (only one active). For more information on StackStorm
authentication see the
authentication documentation
page.
The following backends are currently available:
flat_file - Authenticates against an htpasswd file (default) linkkeystone - Authenticates against an OpenStack Keystone service linkldap - Authenticates against an LDAP server such as OpenLDAP or Active Directory
linkmongodb - Authenticates against a collection named users in MongoDB linkpam - Authenticates against the PAM Linux service linkBy default the flat_file backend is used. To change this you can configure it
when instantiating the st2 class in a manifest file:
class { 'st2':
auth_backend => 'ldap',
}
Or in Hiera:
st2::auth_backend: ldap
Each backend has their own custom configuration settings. The settings can be
found by looking at the backend class in the manifests/st2/auth/ directory.
These parameters map 1-for-1 to the configuration options defined in each
backends GitHub page (links above). Backend configurations are passed in as a hash
using the auth_backend_config option. This option can be changed when instantiating
the st2 class in a manifest file:
class { 'st2':
auth_backend => 'ldap',
auth_backend_config => {
host => 'ldap.domain.tld',
bind_dn => 'cn=ldap_stackstorm,ou=service accounts,dc=domain,dc=tld',
base_dn => 'dc=domain,dc=tld',
scope => 'subtree',
id_attr => 'username',
bind_pw => 'some_password',
group_dns => ['"cn=stackstorm_users,ou=groups,dc=domain,dc=tld"'],
account_pattern => 'userPrincipalName={username}',
},
}
Or in Hiera:
st2::auth_backend: "ldap"
st2::auth_backend_config:
host: "ldaps.domain.tld"
use_tls: false
use_ssl: true
port: 636
bind_dn: 'cn=ldap_stackstorm,ou=service accounts,dc=domain,dc=tld'
bind_pw: 'some_password'
chase_referrals: false
base_dn: 'dc=domain,dc=tld'
group_dns:
- '"cn=stackstorm_users,ou=groups,dc=domain,dc=tld"'
scope: "subtree"
id_attr: "username"
account_pattern: "userPrincipalName={username}"
Configuration via Hiera:
# character to trigger the bot that the message is a command
# example: !help
st2::chatops_hubot_alias: "'!'"
# name of the bot in chat, sometimes requires special characters like @
st2::chatops_hubot_name: '"@RosieRobot"'
# API key generated by: st2 apikey create
st2::chatops_api_key: '"xxxxyyyyy123abc"'
# Public URL used by ChatOps to offer links to execution details via the WebUI.
st2::chatops_web_url: '"stackstorm.domain.tld"'
# install and configure hubot adapter (rocketchat, nodejs module installed by nodejs)
st2::chatops_adapter:
hubot-adapter:
package: 'hubot-rocketchat'
source: 'git+ssh://git@git.company.com:npm/hubot-rocketchat#master'
# adapter configuration (hash)
st2::chatops_adapter_conf:
HUBOT_ADAPTER: rocketchat
ROCKETCHAT_URL: "https://chat.company.com:443"
ROCKETCHAT_ROOM: 'stackstorm'
LISTEN_ON_ALL_PUBLIC: true
ROCKETCHAT_USER: st2
ROCKETCHAT_PASSWORD: secret123
ROCKETCHAT_AUTH: password
RESPOND_TO_DM: true
This module supports scaling out workflowengine, scheduler, rulesengine, and notifier services per the ST2 Documentation.
This would be something that you might consider doing if you have alot of rules running or if you have alot of workflows running in parrallel and/or you have alot of nested workflows and have a server that can be higher on CPU and Memory to allow more processes to run at the same time.
Configuration all services:
class { 'st2':
python_version => '3.8',
workflowengine_num => 4,
scheduler_num => 2,
rulesengine_num => 1,
notifier_num => 1,
}
Or configure individual:
class { 'st2::workflowengine':
workflowengine_num => 4,
}
It is now possible to use StackStorm API Keys to authenticate the st2 commands that are executed during puppet runs, thus replacing the need for username/password and auth token based auth for those commands.
To configure, first generate an API key using:
$ st2 apikey create -m '{"used_by": "puppet-st2-cli"}'
Then add the generated API Key to your puppet config:
class { 'st2':
cli_apikey => 'myapikey'
}
OR in Hiera
st2::cli_apikey: myapikey
Then proceed to using pack and/or k/v functionality normally. When the commands are executed, they will now pass the apikey as auth instead of generated an auth token from the supplied cli_username and cli_password.
This module provides several tasks for interacting with StackStorm. These tasks
are modeled after the st2 CLI command, names of the tasks and parameters reflect this.
Under the hood, the tasks invoke the st2 CLI command so they must be executed on
a node where StackStorm is installed.
st2::key_decrypt - Decrypts an encrypted key/value pairst2::key_get - Retrieves the value for a key from the datastorest2::key_load - Loads a list of key/value pairs into the datastorest2::pack_install - Installs a list of packsst2::pack_list - Get a list of installed packsst2::pack_register: Registers a list of packs based from paths on the filesystemst2::pack_remove - Removes a list of packsst2::rule_disable: Disables a rulest2::rule_list: Lists all rules, or just the rules in a given packst2::run: Runs a StackStorm actionTasks that interact with the st2 CLI command require authentication with the StackStorm
instance. There are three options for authentication:
API keys are the recommended way for systems to authenticate with StackStorm. To do this via a task, you would first create an API key in StackStorm:
$ st2 apikey create -m '{"used_by": "bolt"}'
Copy the API key parameter in the output, and then use it when invoking one of
the tasks in this module via the api_key parameter:
Usage via command line:
bolt task run st2::key_get key="testkey" api_key='xyz123'
Usage in a plan:
$res = run_task('st2::key_get', $stackstorm_target,
key => 'testkey',
api_key => $api_key)
Auth tokens can be used by bolt to communicate with StackStorm. First, the user
needs to create an auth token, then pass it in via the auth_token parameter
$ st2 auth myuser
Copy the auth token in the output, and then use it when invoking one of the tasks in this module:
Usage via command line:
bolt task run st2::key_get key="testkey" auth_token='xyz123'
Usage in a plan:
$res = run_task('st2::key_get', $stackstorm_target,
key => 'testkey',
auth_token => $auth_token)
Finally bolt can accept username/passwords to communicate with StackStorm.
Usage via command line:
bolt task run st2::key_get key="testkey" username="myuser" password="xyz123"
Usage in a plan:
$res = run_task('st2::key_get', $stackstorm_target,
key => 'testkey',
username => $username,
password => $password)
This module provides the ability to set up the metrics endpoints to expose different metrics built into StackStorm as documented here: https://docs.stackstorm.com/reference/metrics.html
There is also an addition metric that can be auto created which exposes the basic health for NGINX called a basic status page.
class { 'st2':
python_version => '3.8',
metrics_include => true,
nginx_basicstatus_enabled => true,
}
Once these metrics are setup and enabled it gives the ability to scrape those metrics with an outside source like telegraf or prometheus or any other scraping tool.
Support for Mistral has been dropped as of StackStorm 3.3.0.
As of version 1.8 this module no longer supports Mistral (and subsequently PostgreSQL)
Neither Mistral nor Postgresql will be installed or managed by this module.
Support for Ubuntu 16.04 has been dropped as of StackStorm 3.5.0
As of version 2.3 this module no longer supports Ubuntu 16.04
Support for CentOS 6 has been dropped as of StackStorm 3.3.0.
As of version 1.8 this module no longer supports CentOS 6, so changes will not be tested against this platform.
Puppet 5 reaches End of Life on 2021-12-31. As of version 2.0 use of Puppet 5 with this module
is officially deprecated.
metadata.json.Puppet 4 reached End of Life on 2018-12-31. As of version 1.4 use of Puppet 4 with this module
is officially deprecated.
1.5.0 this module no longer tests against Puppet 4 in its build matrix.metadata.json.This module no longer supports Puppet 3 as of version 1.1
By default this module does NOT handle upgrades of StackStorm. It is the responsiblity of the end user to upgrade StackStorm according to the upgrade documenation.
In a future release a Puppet task may be included to perform these update on demand using bolt.
Contributions to this module are more than welcome! If you have a problem with the module or would like to see a new feature, please raise an issue. If you are amazing, find a bug or implement a new feature and want to add it to the module, please submit a Pull Request.
If you're in stuck, our community always ready to help, feel free to:
#puppetYour contribution is more than welcome!
StackStorm/puppet-st2 is a public repo on GitHub by StackStorm. Puppet Module to install and configure StackStorm, IFTTT for Ops.
It declares the Apache-2.0 license on GitHub.
Its maker tagged it for Linux. That is declared by the maker; Take My Repo has not tested it.
Open "Take it" on its page: Take My Repo writes an install plan for your machine and hands it to your AI agent (Claude Code, Codex or Cursor), which asks you before each step. Take My Repo has not tested it on any machine.
Its last change on GitHub was on 2023-08-23. GitHub counts 20 open issues and pull requests. Take My Repo does not judge from that whether it is maintained.
Nobody has reviewed it on Take My Repo yet, which says nothing about its quality.

an easy-to-use dynamic service discovery, configuration and service management platform for building AI cloud native applications.
This puppet module provides numerous security-related configurations, providing all-round base protection.
Fair-code workflow automation platform with native AI capabilities. Combine visual building with custom code, self-host or cloud, 400+ integrations.
Apollo is a reliable configuration management system suitable for microservice configuration management scenarios.

StackStorm (aka "IFTTT for Ops") is event-driven automation for auto-remediation, incident responses, troubleshooting, deployments, and more for DevOps and SREs. Includes rules engine, workflow, 160 integration packs with 6000+ actions (see https://exchange.stackstorm.org) and ChatOps. Installer at https://docs.stackstorm.com/install/index.html

K8s Helm Chart that codifies StackStorm (aka "IFTTT for Ops" https://stackstorm.com/) Highly Availability fleet as a simple to use reproducible infrastructure-as-code app
Orquesta is a graph based workflow engine for StackStorm. Questions? https://github.com/StackStorm/st2/discussions
This page is also available as structured data, with the same sources and dates.
/api/v1/resources/gh/StackStorm/puppet-st2Take My Repo has not tested this on your machine. Requirements come from the project's own documentation.