Skip to content

Commit 31bd6d1

Browse files
committed
Markdown linting README.md
1 parent 46c29e5 commit 31bd6d1

File tree

1 file changed

+52
-19
lines changed

1 file changed

+52
-19
lines changed

README.md

Lines changed: 52 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,49 @@
11
# Ansible-st2
2+
23
Ansible playbooks to deploy [StackStorm](https://github.com/stackstorm/st2).
3-
> [StackStorm](http://stackstorm.com/) is event-driven automation platform written in Python.
4-
With over [50+ integrations](https://github.com/StackStorm/st2contrib/tree/master/packs) 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.
5-
Aka IFTTT orchestration for Ops.
64

5+
> [StackStorm](http://stackstorm.com/) is event-driven automation platform
6+
> written in Python.
7+
> With over [50+ integrations](https://github.com/StackStorm/st2contrib/tree/master/packs)
8+
> like GitHub, Docker, Nagios, NewRelic, AWS, Ansible it allows you to wire
9+
> together your existing infrastructure into complex Workflows with
10+
> auto-remediation and many more. Aka IFTTT orchestration for Ops.
711
812
[![Build Status](https://github.com/StackStorm/ansible-st2/actions/workflows/build.yaml/badge.svg)](https://github.com/StackStorm/ansible-st2/actions/workflows/build.yaml)
913
[![Repository deb/rpm](https://img.shields.io/badge/Repository-deb/rpm-blue.svg)](https://packagecloud.io/StackStorm/stable/)
1014
[![Join our community Slack](https://stackstorm-community.herokuapp.com/badge.svg)](https://stackstorm.com/community-signup)
1115

1216
## Supported platforms
17+
1318
* Ubuntu Bionic (18.04)
1419
* Ubuntu Focal (20.04)
1520
* RHEL7 / CentOS7
1621
* RHEL8 / CentOS8
1722

1823
> If you're using the provided Vagrantfile, note that it uses Bionic by default.
1924
20-
> In order to access StackStorm Web UI, please don't forget to ensure that http/https ports are opened in your firewall system.
25+
<!-- https://github.com/DavidAnson/markdownlint/issues/263 -->
26+
[](ignored)
27+
28+
> In order to access StackStorm Web UI, please don't forget to ensure that
29+
> http/https ports are opened in your firewall system.
2130
2231
## Requirements
23-
At least 2GB of memory and 3.5GB of disk space is required, since StackStorm is shipped with RabbitMQ, Mongo, Redis and nginx.
32+
33+
At least 2GB of memory and 3.5GB of disk space is required, since StackStorm is
34+
shipped with RabbitMQ, Mongo, Redis and nginx.
2435

2536
## Installation
37+
2638
```sh
2739
# stackstorm
2840
ansible-playbook stackstorm.yml
2941
```
3042

3143
## Variables
32-
Below is the list of variables you can redefine in your playbook to customize st2 deployment:
44+
45+
Below is the list of variables you can redefine in your playbook to customize
46+
st2 deployment:
3347

3448
| Variable | Default | Description |
3549
| ------------------------ | ------------- | ------------ |
@@ -65,22 +79,29 @@ Below is the list of variables you can redefine in your playbook to customize st
6579
| `st2chatops_version` | `latest` | st2chatops version to install. Use `latest` to get automatic updates or pin it to numeric version like `2.2.0`.
6680

6781
## Examples
82+
6883
Install latest `stable` StackStorm with all its components on local machine:
84+
6985
```sh
7086
ansible-playbook stackstorm.yml -i 'localhost,' --connection=local
7187
```
7288

73-
> Note that keeping `latest` version is useful to update StackStorm by re-running playbook, since it will reinstall st2 if there is new version available.
74-
This is default behavior. If you don't want updates - consider pinning version-revision numbers.
89+
> Note that keeping `latest` version is useful to update StackStorm by
90+
> re-running playbook, since it will reinstall st2 if there is new version available.
91+
92+
This is default behavior. If you don't want updates - consider pinning
93+
version-revision numbers.
7594

7695
Install specific numeric version of st2 with pinned revision number as well:
96+
7797
```sh
7898
ansible-playbook stackstorm.yml --extra-vars='st2_version=2.2.0 st2_revision=8'
7999
```
80100

81-
## Installing behind a proxy.
101+
## Installing behind a proxy
82102

83-
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
103+
If you are installing from behind a proxy, you can use environment variables
104+
`http_proxy`, `https_proxy`, and `no_proxy` in the playbook. For the
84105
st2smoketests, you will need to disable proxy for localhost.
85106

86107
```yaml
@@ -91,32 +112,40 @@ st2smoketests, you will need to disable proxy for localhost.
91112
```
92113
93114
## Developing
115+
94116
There are a few requirements when developing on `ansible-st2`.
95117

96118
These are the platforms we must support (must pass end-to-end testing):
97-
- Ubuntu Bionic
98-
- Ubuntu Focal
99-
- CentOS7
100-
- CentOS8
101-
- RHEL7 (via AWS)
102-
- RHEL8 (via AWS)
103119

104-
Must also support Ansible Idempotence (Eg. Ansible-playbook re-run should end with the following results: `changed=0.*failed=0`)
120+
* Ubuntu Bionic
121+
* Ubuntu Focal
122+
* CentOS7
123+
* CentOS8
124+
* RHEL7 (via AWS)
125+
* RHEL8 (via AWS)
126+
127+
Must also support Ansible Idempotence (Eg. Ansible-playbook re-run should end
128+
with the following results: `changed=0.*failed=0`)
129+
130+
For development purposes there is [Vagrantfile](Vagrantfile) available. The
131+
following command will setup ubuntu18 box (`ubuntu/bionic64`) by default:
105132

106-
For development purposes there is [Vagrantfile](Vagrantfile) available. The following command will setup ubuntu18 box (`ubuntu/bionic64`) by default:
107133
```sh
108134
vagrant up
109135
```
110136

111137
Other distros:
138+
112139
```sh
113140
vagrant up ubuntu20
114141
vagrant up centos7
115142
vagrant up centos8
116143
```
117144

118145
## Other Installers
146+
119147
You might be interested in other methods to deploy StackStorm engine:
148+
120149
* Configuration Management
121150
* [Puppet Module](https://github.com/stackstorm/puppet-st2)
122151

@@ -127,8 +156,12 @@ You might be interested in other methods to deploy StackStorm engine:
127156
* [RHEL7/CentOS7](https://docs.stackstorm.com/install/rhel7.html)
128157

129158
## Help
159+
130160
If you're in stuck, our community always ready to help, feel free to:
161+
131162
* Ask questions in our [public Slack channel](https://stackstorm.com/community-signup)
132-
* [Report bug](https://github.com/StackStorm/ansible-st2/issues), provide [feature request](https://github.com/StackStorm/ansible-st2/pulls) or just give us a ✮ star
163+
* [Report bug](https://github.com/StackStorm/ansible-st2/issues), provide
164+
[feature request](https://github.com/StackStorm/ansible-st2/pulls) or just
165+
give us a ✮ star
133166

134167
Your contribution is more than welcome!

0 commit comments

Comments
 (0)