Ansible Collection - cognifloyd.st2_installer (st2_installer.ansible)

Ansible Collection for installing StackStorm (ST2)

This is not an official part of the StackStorm project.

StackStorm is event-driven automation platform written in Python. With over 50+ integrations like GitHub, Docker, Nagios, NewRelic, AWS, Ansible it allows you to wire together your existing infrastructure into complex Workflows with auto-remediation and many more. Aka IFTTT orchestration for Ops.

Goals for this collection

These goals are mix of things to acomplish and guidelines on the scope of this project.

• Reach feature parity with other st2 installers.
• Speed up development (as compared with StackStorm/ansible-st2).
• Participate in the wider ansible community; Use and contribute to 3rd party collections and roles wherever possible.
• Make the installer a proper Ansible collection.
• Support upgrading st2 installations.
• Make it easier to scale-up StackStorm installations. As the installation scales up, the roles should facilitate moving components into HA setups.
• Use molecule to test the roles (molecule is a standard testing tool in the ansible community).
• Use pulp_installer is a good example of how to structure a collection like this.

Relationship with StackStorm/ansible-st2

This collection replaces StackStorm/ansible-st2. ansible-st2 is missing many of the features of the other st2 installation methods, especially security features like securing mongodb and rabbitmq installations. It is difficult to add features when so many parts of StackStorm's internal infrastructure dogfood (use) ansible-st2. So, the safest way to add these features, as well as turning the installer into a proper ansible collection for ansible 2.9+, was to fork ansible-st2.

Supported platforms

• Ubuntu Bionic (18.04)
• Ubuntu Focal (20.04)
• RHEL7 / CentOS7
• RHEL8 / CentOS8

In order to access StackStorm Web UI, please don't forget to ensure that http/https ports are opened in your firewall system.

Requirements

At least 2GB of memory and 3.5GB of disk space is required, since StackStorm is shipped with RabbitMQ, Mongo, Redis and nginx.

Installation

ansible-galaxy collection install cognifloyd.st2_installer

Variables

Below is the list of variables you can redefine in your playbook to customize st2 deployment:

Installing behind a proxy.

If you are installing from behind a proxy, you can use environment variables http_proxy, https_proxy, and no_proxy in the playbook. For the st2smoketests, you will need to disable proxy for localhost.

  environment:
    http_proxy: http://proxy.example.net:3128
    https_proxy: http://proxy.example.net:3128
    no_proxy: 127.0.0.1,localhost

Developing

There are a few requirements when developing on st2_installer.ansible.

These are the platforms we must support (must pass end-to-end testing):

• Ubuntu Bionic
• Ubuntu Focal
• CentOS7
• CentOS8
• RHEL7 (via AWS)
• RHEL8 (via AWS)

Must also support Ansible Idempotence (Eg. Ansible-playbook re-run should end with the following results: changed=0.*failed=0)

Other Installers

You might be interested in other methods to deploy StackStorm engine:

• Configuration Management

  • Puppet Module
  • Official Ansible Roles

• Manual Instructions

  • Ubuntu 18.04
  • Ubuntu 20.04
  • RHEL8/CentOS8
  • RHEL7/CentOS7

Help

If you're in stuck, our community always ready to help, feel free to:

• Report bug, provide feature request or just give us a ✮ star

Your contribution is more than welcome!