Skip to content

Commit

Permalink
Merge pull request #44 from StackStorm/feature/update-docs
Browse files Browse the repository at this point in the history
Docs cleanup for #42
  • Loading branch information
armab committed May 6, 2016
2 parents 36f63dc + b51ad34 commit 34d8e92
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 41 deletions.
33 changes: 14 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ With over [50+ integrations](https://github.com/StackStorm/st2contrib/tree/maste
Aka IFTTT orchestration for Ops.

[![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)
[![Repository deb/rpm](https://img.shields.io/badge/Repository-deb/rpm-blue.svg)](https://packagecloud.io/StackStorm/stable/)

## Supported platforms
* Ubuntu 12.04
* Ubuntu 14.04

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

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

## Examples
Install `stable` StackStorm with all its components on local machine:
Install latest `stable` StackStorm with all its components on local machine:
```sh
ansible-playbook playbooks/st2express.yaml -i 'localhost,' --connection=local
```

> 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.
This is default behavior. If you don't want updates - consider pinning version numbers.
This is default behavior. If you don't want updates - consider pinning version-revision numbers.

Install specific numeric version of st2 with pinned revision number as well:
```sh
ansible-playbook playbooks/st2express.yaml --extra-vars='st2_version=0.12.2 st2_revision=6'
```
or latest unstable (development branch):
```sh
ansible-playbook playbooks/st2express.yaml --extra-vars='st2_version=unstable'
ansible-playbook playbooks/st2express.yaml --extra-vars='st2_version=1.4.0 st2_revision=8'
```

## Other Installers
For your best experience there are different convenient ways to install and explore StackStorm engine.
* [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.
* [Chef](https://supermarket.chef.io/cookbooks/stackstorm)
* [Puppet](https://forge.puppetlabs.com/stackstorm/st2)
* [Bash](http://docs.stackstorm.com/install/index.html#installation)
* [Vagrant](https://github.com/StackStorm/st2workroom/)
You might be interested in other OS flavors to explore StackStorm engine:
* [Ubuntu/Debian](https://docs.stackstorm.com/install/deb.html)
* [RHEL7/CentOS7](https://docs.stackstorm.com/install/rhel7.html)
* [RHEL6/CentOS7](https://docs.stackstorm.com/install/rhel6.html)

## Help
If you're in stuck, our community always ready to help, feel free to:
* 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)
* Report bug, provide feature request or just give us a ✮ star at [GitHub st2](https://github.com/StackStorm/st2)
* Ask questions in our [public Slack channel](https://stackstorm.com/community-signup)
* [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

Your contribution is more than welcome!
26 changes: 4 additions & 22 deletions roles/st2/defaults/main.yml
Original file line number Diff line number Diff line change
@@ -1,33 +1,15 @@
---
# Required memory for st2 installation in MB
st2_required_memory: 2000
# MongoDB requires at least 3379MB available in /var/lib/mongo/journal
st2_required_space: 3500

# 'stable', 'unstable' to get latest version or numeric like '0.12.1'
# 'stable' to get latest version or numeric like '1.4.0'
st2_version: stable
# 'current' to get latest revision or numberic like '6'
st2_revision: current
# used only if 'st2_version' is numeric
st2_revision: 1

st2_system_user: stanley
st2_ssh_key_file: /home/{{ st2_system_user }}/.ssh/{{ st2_system_user }}_rsa

st2_packages:
- st2common
- st2actions
- st2api
- st2auth
- st2client
- st2debug
- st2reactor

# Number of action runners to register. Defaults to number of vCPUs, but not less than 2
st2_action_runners: "{{ [ansible_processor_vcpus, 2] | max }}"

enable_auth: true
st2_auth_username: testu
st2_auth_password: testp

# Set to no if you do not want the st2_system_user to be added in
# the sudoers file.
# Set to no if you do not want the st2_system_user to be added in the sudoers file
st2_system_user_in_sudoers: yes

0 comments on commit 34d8e92

Please sign in to comment.