Skip to content

Commit

Permalink
Merge pull request #34 from armab/33-docs
Browse files Browse the repository at this point in the history
Document new variables added in #33
  • Loading branch information
armab committed Dec 3, 2015
2 parents 12bd9e2 + ae9b589 commit 29890eb
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,18 @@ Ansible Galaxy roles used by StackStorm installation:
## Variables
Below is the list of variables you can redefine in your playbook to customize st2 deployment:

| 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_system_user` | `stanley` | System user on whose behalf st2 would work, including remote/local action runners.
| `st2_auth_username` | `testu` | Username used by StackStorm standalone authentication.
| `st2_auth_password` | `testp` | Password used by StackStorm standalone authentication.
| 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_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.
| `st2_auth_password` | `testp` | Password used by StackStorm standalone authentication.
| `mistral_db` | `mistral` | PostgreSQL DB name for Mistral.
| `mistral_db_username` | `mistral` | PostgreSQL DB user for Mistral.
| `mistral_db_password` | `StackStorm` | PostgreSQL DB password for Mistral.

## Examples
Install `stable` StackStorm with all its components on local machine:
Expand Down

0 comments on commit 29890eb

Please sign in to comment.