diff --git a/README.md b/README.md index 51e5207c..aa57fea5 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,9 @@ Below is the list of variables you can redefine in your playbook to customize st | `st2mistral_db_username` | `mistral` | PostgreSQL DB user for Mistral. | `st2mistral_db_password` | `StackStorm` | PostgreSQL DB password for Mistral. | **st2chatops** -| `st2chatops_config` | `{ }` | Hash of st2chatops settings to edit in [`st2chatops.env`](https://github.com/StackStorm/st2chatops/blob/master/st2chatops.env) file. For example, `Slack` hubot adapter requires: `ST2_API_KEY: CHANGE-ME-PLEASE` `HUBOT_ADAPTER: slack` `HUBOT_SLACK_TOKEN: xoxb-CHANGE-ME-PLEASE` +| `st2chatops_st2_api_key` | | st2 API key to be updated in st2chatops.env using "st2 apikey create -k" in a task [**Required**] +| `st2chatops_hubot_adapter` | | Hubot Adapter to be used for st2chatops. Default is `shell`, but should be changed to one of the [supported adapters](`https://github.com/StackStorm/ansible-st2/blob/master/roles/st2chatops/vars/main.yml`).[**Required**] +| `st2chatops_config` | `{ }` | Based on adapter in `st2chatops_hubot_adapter`, provide hash for the adapter settings, to update [`st2chatops.env`](https://github.com/StackStorm/st2chatops/blob/master/st2chatops.env). For example, for `Slack` hubot adapter: `st2chatops_config: {"HUBOT_SLACK_TOKEN": "xoxb-CHANGE-ME-PLEASE"}` | `st2chatops_version` | `latest` | st2chatops version to install. Use `latest` to get automatic updates or pin it to numeric version like `2.2.0`. ## Examples diff --git a/roles/st2chatops/meta/main.yml b/roles/st2chatops/meta/main.yml index 3a29ba4c..17a7c8c5 100644 --- a/roles/st2chatops/meta/main.yml +++ b/roles/st2chatops/meta/main.yml @@ -3,7 +3,7 @@ galaxy_info: description: Install st2chatops author: humblearner company: StackStorm - license: Apache + license: Apache 2.0 min_ansible_version: 2.2 platforms: - name: Ubuntu @@ -18,7 +18,8 @@ galaxy_info: - st2 - devops - chatops - - autmation + - automation + - hubot dependencies: - - role: st2 - role: nodejs + - role: st2