Skip to content

Commit 34d8e92

Browse files
committed
Merge pull request #44 from StackStorm/feature/update-docs
Docs cleanup for #42
2 parents 36f63dc + b51ad34 commit 34d8e92

File tree

2 files changed

+18
-41
lines changed

2 files changed

+18
-41
lines changed

README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ With over [50+ integrations](https://github.com/StackStorm/st2contrib/tree/maste
55
Aka IFTTT orchestration for Ops.
66

77
[![Circle CI Build Status](https://circleci.com/gh/StackStorm/ansible-st2/tree/master.svg?style=shield)](https://circleci.com/gh/StackStorm/ansible-st2/tree/master)
8+
[![Repository deb/rpm](https://img.shields.io/badge/Repository-deb/rpm-blue.svg)](https://packagecloud.io/StackStorm/stable/)
89

910
## Supported platforms
10-
* Ubuntu 12.04
1111
* Ubuntu 14.04
1212

1313
## Requirements
@@ -29,9 +29,8 @@ Below is the list of variables you can redefine in your playbook to customize st
2929

3030
| Variable | Default | Description |
3131
| --------------------- | ------------- | ----- |
32-
| `st2_version` | `stable` | StackStorm version to install. Latest `stable`, `unstable` to get automatic updates or pin it to numeric version like `0.12.1`.
33-
| `st2_revision` | `current` | StackStorm revision to install. `current` to get latest build (autoupdating) or pin it to numeric build like `6`.
34-
| `st2_action_runners` | `ansible_processor_vcpus` | Number of action runner workers to start. Defaults to number of machine vCPUs, but not less than 2.
32+
| `st2_version` | `stable` | StackStorm version to install. Use latest `stable` to get automatic updates or pin it to numeric version like `1.4.0`.
33+
| `st2_revision` | `1` | StackStorm revision to install. Used only with pinned `st2_version`.
3534
| `st2_system_user` | `stanley` | System user on whose behalf st2 would work, including remote/local action runners.
3635
| `st2_system_user_in_sudoers` | `yes`| Add `st2_system_user` to the sudoers (recommended for most `st2` features to work).
3736
| `st2_auth_username` | `testu` | Username used by StackStorm standalone authentication.
@@ -41,32 +40,28 @@ Below is the list of variables you can redefine in your playbook to customize st
4140
| `mistral_db_password` | `StackStorm` | PostgreSQL DB password for Mistral.
4241

4342
## Examples
44-
Install `stable` StackStorm with all its components on local machine:
43+
Install latest `stable` StackStorm with all its components on local machine:
4544
```sh
4645
ansible-playbook playbooks/st2express.yaml -i 'localhost,' --connection=local
4746
```
4847

4948
> Note that keeping `stable` version is useful to update StackStorm by re-running playbook, since it will reinstall st2 if there is new version available.
50-
This is default behavior. If you don't want updates - consider pinning version numbers.
49+
This is default behavior. If you don't want updates - consider pinning version-revision numbers.
5150

5251
Install specific numeric version of st2 with pinned revision number as well:
5352
```sh
54-
ansible-playbook playbooks/st2express.yaml --extra-vars='st2_version=0.12.2 st2_revision=6'
55-
```
56-
or latest unstable (development branch):
57-
```sh
58-
ansible-playbook playbooks/st2express.yaml --extra-vars='st2_version=unstable'
53+
ansible-playbook playbooks/st2express.yaml --extra-vars='st2_version=1.4.0 st2_revision=8'
5954
```
6055

6156
## Other Installers
62-
For your best experience there are different convenient ways to install and explore StackStorm engine.
63-
* [All-in-one Installer](http://docs.stackstorm.com/install/all_in_one.html) - preferred way (especially for production). Graphical installer, more secure, better tested and robust.
64-
* [Chef](https://supermarket.chef.io/cookbooks/stackstorm)
65-
* [Puppet](https://forge.puppetlabs.com/stackstorm/st2)
66-
* [Bash](http://docs.stackstorm.com/install/index.html#installation)
67-
* [Vagrant](https://github.com/StackStorm/st2workroom/)
57+
You might be interested in other OS flavors to explore StackStorm engine:
58+
* [Ubuntu/Debian](https://docs.stackstorm.com/install/deb.html)
59+
* [RHEL7/CentOS7](https://docs.stackstorm.com/install/rhel7.html)
60+
* [RHEL6/CentOS7](https://docs.stackstorm.com/install/rhel6.html)
6861

6962
## Help
7063
If you're in stuck, our community always ready to help, feel free to:
71-
* Ask questions on [IRC: #stackStorm on freenode.net](http://webchat.freenode.net/?channels=stackstorm) or our [public Slack channel](https://stackstorm.typeform.com/to/K76GRP)
72-
* Report bug, provide feature request or just give us a ✮ star at [GitHub st2](https://github.com/StackStorm/st2)
64+
* Ask questions in our [public Slack channel](https://stackstorm.com/community-signup)
65+
* [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
66+
67+
Your contribution is more than welcome!

roles/st2/defaults/main.yml

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,15 @@
11
---
2-
# Required memory for st2 installation in MB
3-
st2_required_memory: 2000
4-
# MongoDB requires at least 3379MB available in /var/lib/mongo/journal
5-
st2_required_space: 3500
6-
7-
# 'stable', 'unstable' to get latest version or numeric like '0.12.1'
2+
# 'stable' to get latest version or numeric like '1.4.0'
83
st2_version: stable
9-
# 'current' to get latest revision or numberic like '6'
10-
st2_revision: current
4+
# used only if 'st2_version' is numeric
5+
st2_revision: 1
116

127
st2_system_user: stanley
138
st2_ssh_key_file: /home/{{ st2_system_user }}/.ssh/{{ st2_system_user }}_rsa
149

15-
st2_packages:
16-
- st2common
17-
- st2actions
18-
- st2api
19-
- st2auth
20-
- st2client
21-
- st2debug
22-
- st2reactor
23-
24-
# Number of action runners to register. Defaults to number of vCPUs, but not less than 2
25-
st2_action_runners: "{{ [ansible_processor_vcpus, 2] | max }}"
26-
2710
enable_auth: true
2811
st2_auth_username: testu
2912
st2_auth_password: testp
3013

31-
# Set to no if you do not want the st2_system_user to be added in
32-
# the sudoers file.
14+
# Set to no if you do not want the st2_system_user to be added in the sudoers file
3315
st2_system_user_in_sudoers: yes

0 commit comments

Comments
 (0)