Browse Source

Wrote integration documentation... aslo 's/Redis/redis'

cmacrae 9 years ago
parent
commit
64f4671c89

+ 20 - 16
README.md

@@ -5,13 +5,17 @@
 This role deploys a full [Sensu](https://sensuapp.org) stack, a modern, open source monitoring framework.
 This role deploys a full [Sensu](https://sensuapp.org) stack, a modern, open source monitoring framework.
 
 
 ## Features
 ## Features
-- Deploy a full [Sensu](https://sensuapp.org) stack, including RabbitMQ, Redis, and the [Uchiwa dashboard](https://uchiwa.io/#/)
+- Deploy a full [Sensu](https://sensuapp.org) stack, including RabbitMQ, redis, and the [Uchiwa dashboard](https://uchiwa.io/#/)
 - Tight integration with the Ansible inventory - deployment of monitoring checks based on inventory grouping
 - Tight integration with the Ansible inventory - deployment of monitoring checks based on inventory grouping
 - Fine grained control over dynamic client configurations
 - Fine grained control over dynamic client configurations
 - Remote plugin deployment
 - Remote plugin deployment
 - Automatic generation and dynamic deployment of SSL certs for secure communication between your clients and servers
 - Automatic generation and dynamic deployment of SSL certs for secure communication between your clients and servers
 - Highly configurable
 - Highly configurable
 
 
+## Batteries included, but not imposed
+Along with deploying the Sensu Server, API and clients, this role can deploy a full stack: [RabbitMQ](http://www.rabbitmq.com/), [redis](http://redis.io), and the [Uchiwa dashboard](https://uchiwa.io/#/).  
+However, if you want to rely on other roles/management methods to deploy/manage these services, [it's nice and easy to integrate this role](http://rtfm.cmacr.ae/integration/).
+
 ## Documentation [![Documentation](https://readthedocs.org/projects/ansible-sensu/badge/?version=latest)](http://rtfm.cmacr.ae/)
 ## Documentation [![Documentation](https://readthedocs.org/projects/ansible-sensu/badge/?version=latest)](http://rtfm.cmacr.ae/)
 [Read the full documentation](http://rtfm.cmacr.ae/) for a comprehensive overview of this role and its powerful features.
 [Read the full documentation](http://rtfm.cmacr.ae/) for a comprehensive overview of this role and its powerful features.
 
 
@@ -42,7 +46,7 @@ The current version includes the following variables:
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
 |--------------------|---------------|------------------------------|
 |--------------------|---------------|------------------------------|
 |`sensu_deploy_rabbitmq` | `true`    | Determines whether or not to use this role to deploy/configure RabbitMQ |
 |`sensu_deploy_rabbitmq` | `true`    | Determines whether or not to use this role to deploy/configure RabbitMQ |
-|`sensu_deploy_redis`    | `true`    | Determines whether or not to use this role to deploy/configure Redis |
+|`sensu_deploy_redis`    | `true`    | Determines whether or not to use this role to deploy/configure redis |
 _Note: The above options are intended to provide users with flexibility. This allows the use of other roles for deployment of these services._
 _Note: The above options are intended to provide users with flexibility. This allows the use of other roles for deployment of these services._
 
 
 ### [RabbitMQ Server Properties](https://sensuapp.org/docs/0.21/rabbitmq)
 ### [RabbitMQ Server Properties](https://sensuapp.org/docs/0.21/rabbitmq)
@@ -59,16 +63,16 @@ _Note: The above options are intended to provide users with flexibility. This al
 | `rabbitmq_sensu_password` | sensu | Password for authentication with the RabbitMQ vhost |
 | `rabbitmq_sensu_password` | sensu | Password for authentication with the RabbitMQ vhost |
 | `rabbitmq_sensu_vhost` | `/sensu` | Name of the RabbitMQ Sensu vhost |
 | `rabbitmq_sensu_vhost` | `/sensu` | Name of the RabbitMQ Sensu vhost |
 
 
-### [Redis Server Properties](https://sensuapp.org/docs/0.21/redis)
+### [redis Server Properties](https://sensuapp.org/docs/0.21/redis)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
 |--------------------|---------------|------------------------------|
 |--------------------|---------------|------------------------------|
-| `redis_host` | `"{{ groups['redis_servers'][0] }}"` | Hostname/IP address of the Redis node |
-| `redis_server` | `false` | Determines whether to include the deployment of Redis |
-| `redis_pkg_repo` | _undefined_ |  The PPA to use for installing Redis from (specific to Debian flavored systems) |
-| `redis_service_name` | redis | The name of the Redis service |
-| `redis_pkg_name` | redis |  The name of the Redis package to install |
-| `redis_pkg_state` | present | The state of the Redis package (should be set to `present` or `latest`) |
-| `redis_port` | 6379 | The transmission port for Redis communications |
+| `redis_host` | `"{{ groups['redis_servers'][0] }}"` | Hostname/IP address of the redis node |
+| `redis_server` | `false` | Determines whether to include the deployment of redis |
+| `redis_pkg_repo` | _undefined_ |  The PPA to use for installing redis from (specific to Debian flavored systems) |
+| `redis_service_name` | redis | The name of the redis service |
+| `redis_pkg_name` | redis |  The name of the redis package to install |
+| `redis_pkg_state` | present | The state of the redis package (should be set to `present` or `latest`) |
+| `redis_port` | 6379 | The transmission port for redis communications |
 
 
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
@@ -108,7 +112,7 @@ sensu_ssl_server_key: "{{ sensu_ssl_tool_base_path }}/server/key.pem"
 |--------------------|---------------|------------------------------|
 |--------------------|---------------|------------------------------|
 | `uchiwa_dc_name` | _undefined_ | Datacenter name for Uchiwa instance |
 | `uchiwa_dc_name` | _undefined_ | Datacenter name for Uchiwa instance |
 | `uchiwa_path` | `/opt/uchiwa` | Path to the Uchiwa configuration directory |
 | `uchiwa_path` | `/opt/uchiwa` | Path to the Uchiwa configuration directory |
-| `uchiwa_redis_use_ssl` | `false` | Determines whether to use SSL for Redis communication |
+| `uchiwa_redis_use_ssl` | `false` | Determines whether to use SSL for redis communication |
 | `uchiwa_user_name`| admin | The user-name to log into Uchiwa |
 | `uchiwa_user_name`| admin | The user-name to log into Uchiwa |
 | `uchiwa_password` | admin | The password to log into Uchiwa |
 | `uchiwa_password` | admin | The password to log into Uchiwa |
 | `uchiwa_port` | 3000 | The TCP port to bind the Uchiwa web service to |
 | `uchiwa_port` | 3000 | The TCP port to bind the Uchiwa web service to |
@@ -119,10 +123,10 @@ sensu_ssl_server_key: "{{ sensu_ssl_tool_base_path }}/server/key.pem"
 | `uchiwa_pkg_download_url` | _undefined_ | The URL of the Uchiwa package to fetch (specific to Linux systems) |
 | `uchiwa_pkg_download_url` | _undefined_ | The URL of the Uchiwa package to fetch (specific to Linux systems) |
 
 
 ## Ubuntu
 ## Ubuntu
-### [Redis Server Properties](https://sensuapp.org/docs/0.21/redis)
+### [redis Server Properties](https://sensuapp.org/docs/0.21/redis)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
 |--------------------|---------------|------------------------------|
 |--------------------|---------------|------------------------------|
-| `redis_pkg_repo`   | `'ppa:rwky/redis'` | The PPA to use for installing Redis from |
+| `redis_pkg_repo`   | `'ppa:rwky/redis'` | The PPA to use for installing redis from |
 
 
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
@@ -135,11 +139,11 @@ sensu_ssl_server_key: "{{ sensu_ssl_tool_base_path }}/server/key.pem"
 | `uchiwa_pkg_download_url`  | _See `vars/Ubuntu.yml`_ | The URL of the Uchiwa package to fetch |
 | `uchiwa_pkg_download_url`  | _See `vars/Ubuntu.yml`_ | The URL of the Uchiwa package to fetch |
 
 
 ## Debian
 ## Debian
-### [Redis Server Properties](https://sensuapp.org/docs/0.21/redis)
+### [redis Server Properties](https://sensuapp.org/docs/0.21/redis)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
 |--------------------|---------------|------------------------------|
 |--------------------|---------------|------------------------------|
-| `redis_pkg_repo`   | `'ppa:rwky/redis'` | The PPA to use for installing Redis from |
-| `redis_service_name` | redis-server | The name of the Redis service |
+| `redis_pkg_repo`   | `'ppa:rwky/redis'` | The PPA to use for installing redis from |
+| `redis_service_name` | redis-server | The name of the redis service |
 
 
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |

+ 1 - 1
defaults/main.yml

@@ -15,7 +15,7 @@ rabbitmq_sensu_user_name: sensu
 rabbitmq_sensu_password: sensu
 rabbitmq_sensu_password: sensu
 rabbitmq_sensu_vhost: /sensu
 rabbitmq_sensu_vhost: /sensu
 
 
-# Redis server properties
+# redis server properties
 redis_host: "{{ groups['redis_servers'][0] }}"
 redis_host: "{{ groups['redis_servers'][0] }}"
 redis_server: false
 redis_server: false
 redis_service_name: redis
 redis_service_name: redis

+ 1 - 1
docs/afewwords.md

@@ -9,7 +9,7 @@ I figure I have to list them, in no particular order, here they are. __Make sure
 - [Uchiwa](https://uchiwa.io/#/)
 - [Uchiwa](https://uchiwa.io/#/)
 - [SmartOS](https://smartos.org/)
 - [SmartOS](https://smartos.org/)
 - [RabbitMQ](https://rabbitmq.com/)
 - [RabbitMQ](https://rabbitmq.com/)
-- [Redis](http://redis.io/)
+- [redis](http://redis.io/)
 
 
 ## What about support for other operating systems?
 ## What about support for other operating systems?
 It's planned!
 It's planned!

+ 4 - 4
docs/dynamic_checks.md

@@ -120,7 +120,7 @@ data/static
 
 
 ## Picking up changes on the fly
 ## Picking up changes on the fly
 Let's say, for some reason, one of your nodes decides to switch roles, or take on the responsibility of another role.
 Let's say, for some reason, one of your nodes decides to switch roles, or take on the responsibility of another role.
-You've got a webserver, who all of a sudden you decide "this guy should be running Redis too". No problem!
+You've got a webserver, who all of a sudden you decide "this guy should be running redis too". No problem!
 You probably had something like:
 You probably had something like:
 ```
 ```
 [webservers]
 [webservers]
@@ -134,7 +134,7 @@ mime.domain.name
 [redis_servers]
 [redis_servers]
 mime.domain.name
 mime.domain.name
 ```
 ```
-Not to worry, the next time your playbook applying this Sensu role runs through (notably the `tasks/client.yml` & `tasks/plugins.yml` playbooks), the new checks for Redis will be deployed to `mime.domain.name` and it'll be subscribed to the `redis_servers` stream within Sensu. Pretty slick, right?
+Not to worry, the next time your playbook applying this Sensu role runs through (notably the `tasks/client.yml` & `tasks/plugins.yml` playbooks), the new checks for redis will be deployed to `mime.domain.name` and it'll be subscribed to the `redis_servers` stream within Sensu. Pretty slick, right?
 
 
-The same goes for the removal of a node from a group. Did you just realize you really don't want `mime.domain.name` to act as a Redis server?
-It's cool, we all make mistakes, just take him out of the `[redis_servers]` group in your inventory. When your play comes through again, applying this Sensu role, he'll be unsubscribed from the `redis_servers` stream, and Redis'll stop being monitored!
+The same goes for the removal of a node from a group. Did you just realize you really don't want `mime.domain.name` to act as a redis server?
+It's cool, we all make mistakes, just take him out of the `[redis_servers]` group in your inventory. When your play comes through again, applying this Sensu role, he'll be unsubscribed from the `redis_servers` stream, and redis'll stop being monitored!

+ 2 - 2
docs/example_infra.md

@@ -66,7 +66,7 @@ The above code could also be set straight in the node's `host_vars` file: `host_
 	  - cmacrae.sensu
 	  - cmacrae.sensu
 ```
 ```
 
 
-### RabbitMQ/Redis variables
+### RabbitMQ/redis variables
 You'll probably have noticed the two groups `rabbitmq_servers` and `redis_servers` in the example inventory.
 You'll probably have noticed the two groups `rabbitmq_servers` and `redis_servers` in the example inventory.
 Quite self explanatory what these are, but - as with the `sensu_master` variable in the previous section - both the `rabbitmq_server` & `redis_server` values are set to `false` by default (defined in `defaults/main.yml`).
 Quite self explanatory what these are, but - as with the `sensu_master` variable in the previous section - both the `rabbitmq_server` & `redis_server` values are set to `false` by default (defined in `defaults/main.yml`).
 
 
@@ -83,4 +83,4 @@ rabbitmq_server: true
 redis_server: true
 redis_server: true
 ```
 ```
 
 
-The same can, again, be set directly in your RabbitMQ/Redis nodes' `host_vars` files, or done so in the playbook as shown in the previous section for the values `sensu_master` & `sensu_include_uchiwa`.
+The same can, again, be set directly in your RabbitMQ/redis nodes' `host_vars` files, or done so in the playbook as shown in the previous section for the values `sensu_master` & `sensu_include_uchiwa`.

+ 5 - 1
docs/index.md

@@ -4,13 +4,17 @@ An [Ansible](https://ansible.com) role that deploys a full [Sensu](https://sensu
 [![Join the chat at https://gitter.im/cmacrae/ansible-sensu](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cmacrae/ansible-sensu?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Join the chat at https://gitter.im/cmacrae/ansible-sensu](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cmacrae/ansible-sensu?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 
 ## Features
 ## Features
-- Deploy a full [Sensu](https://sensuapp.org) stack, including RabbitMQ, Redis, and the [Uchiwa dashboard](https://uchiwa.io/#/)
+- Deploy a full [Sensu](https://sensuapp.org) stack, including RabbitMQ, redis, and the [Uchiwa dashboard](https://uchiwa.io/#/)
 - Tight integration with the Ansible inventory - deployment of monitoring checks based on inventory grouping
 - Tight integration with the Ansible inventory - deployment of monitoring checks based on inventory grouping
 - Fine grained control over dynamic client configurations
 - Fine grained control over dynamic client configurations
 - Remote plugin deployment
 - Remote plugin deployment
 - Automatic generation and dynamic deployment of SSL certs for secure communication between your clients and servers
 - Automatic generation and dynamic deployment of SSL certs for secure communication between your clients and servers
 - Highly configurable
 - Highly configurable
 
 
+## Batteries included, but not imposed
+Along with deploying the Sensu Server, API and clients, this role can deploy a full stack: [RabbitMQ](http://www.rabbitmq.com/), [redis](http://redis.io), and the [Uchiwa dashboard](https://uchiwa.io/#/).  
+However, if you want to rely on other roles/management methods to deploy/manage these services, [it's nice and easy to integrate this role](integration/).
+
 ## Requirements
 ## Requirements
 This role requires Ansible 2.0
 This role requires Ansible 2.0
 
 

+ 32 - 0
docs/integration.md

@@ -0,0 +1,32 @@
+Integration with other roles/management methods
+===============================================
+Although this role can deploy and manage the full Sensu stack, you can opt to use other roles to manage RabbitMQ, redis, and the Uchiwa dashboard, if you so desire.  
+
+RabbitMQ
+--------
+If you'd like to use a different role/management method for RabbitMQ, the following variables are of interest:
+``` yaml
+sensu_deploy_rabbitmq: false
+rabbitmq_host: < IP/DNS record of your RabbitMQ server >
+rabbitmq_port: < optionally set a differing port, defaults to 5671 >
+rabbitmq_sensu_user_name: < the username for interacting with RabbitMQ >
+rabbitmq_sensu_password: < the password for interacting with RabbitMQ >
+rabbitmq_sensu_vhost: < the RabbitMQ vhost to use, defaults to '/sensu' >
+rabbitmq_config_path: < the path to the RabbitMQ configuration >
+
+```
+
+You'll want to ensure you have a directory named `ssl` under your `rabbitmq_config_path` with the Sensu SSL Server CACert, Cert, and Key data inside (the path to this data is defined by the following variables: `sensu_ssl_server_cacert`,  `sensu_ssl_server_cert`,  `sensu_ssl_server_key`. These are typically stored in the [dynamic data store](dynamic_data/)).
+
+redis
+-----
+If you'd like to use a different role/management method for redis, the following vairables are of interest:
+``` yaml
+sensu_deploy_redis: false
+redis_host: < IP/DNS record of your redis server >
+redis_port: < optionally set a differing port, defaults to 6379 >
+```
+
+Uchiwa dashboard
+----------------
+If you'd like to use a different role/management method for the Uchiwa dashboard, you can simply set `sensu_include_dashboard` to `false`.

+ 15 - 15
docs/role_variables.md

@@ -5,7 +5,7 @@
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
 |--------------------|---------------|------------------------------|
 |--------------------|---------------|------------------------------|
 |`sensu_deploy_rabbitmq` | `true`    | Determines whether or not to use this role to deploy/configure RabbitMQ |
 |`sensu_deploy_rabbitmq` | `true`    | Determines whether or not to use this role to deploy/configure RabbitMQ |
-|`sensu_deploy_redis`    | `true`    | Determines whether or not to use this role to deploy/configure Redis |
+|`sensu_deploy_redis`    | `true`    | Determines whether or not to use this role to deploy/configure redis |
 
 
 _Note: The above options are intended to provide users with flexibility. This allows the use of other roles for deployment of these services._
 _Note: The above options are intended to provide users with flexibility. This allows the use of other roles for deployment of these services._
 
 
@@ -23,15 +23,15 @@ _Note: The above options are intended to provide users with flexibility. This al
 | `rabbitmq_sensu_password` | sensu | Password for authentication with the RabbitMQ vhost |
 | `rabbitmq_sensu_password` | sensu | Password for authentication with the RabbitMQ vhost |
 | `rabbitmq_sensu_vhost` | `/sensu` | Name of the RabbitMQ Sensu vhost |
 | `rabbitmq_sensu_vhost` | `/sensu` | Name of the RabbitMQ Sensu vhost |
 
 
-### [Redis Server Properties](https://sensuapp.org/docs/0.21/redis)
+### [redis Server Properties](https://sensuapp.org/docs/0.21/redis)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
 |--------------------|---------------|------------------------------|
 |--------------------|---------------|------------------------------|
-| `redis_host` | `"{{ groups['redis_servers'][0] }}"` | Hostname/IP address of the Redis node |
-| `redis_server` | `false` | Determines whether to include the deployment of Redis |
-| `redis_pkg_repo` | _undefined_ |  The PPA to use for installing Redis from (specific to Debian flavored systems) |
-| `redis_pkg_name` | redis |  The name of the Redis package to install |
-| `redis_pkg_state` | present | The state of the Redis package (should be set to `present` or `latest`) |
-| `redis_port` | 6379 | The transmission port for Redis communications |
+| `redis_host` | `"{{ groups['redis_servers'][0] }}"` | Hostname/IP address of the redis node |
+| `redis_server` | `false` | Determines whether to include the deployment of redis |
+| `redis_pkg_repo` | _undefined_ |  The PPA to use for installing redis from (specific to Debian flavored systems) |
+| `redis_pkg_name` | redis |  The name of the redis package to install |
+| `redis_pkg_state` | present | The state of the redis package (should be set to `present` or `latest`) |
+| `redis_port` | 6379 | The transmission port for redis communications |
 
 
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
@@ -71,7 +71,7 @@ sensu_ssl_server_key: "{{ sensu_ssl_tool_base_path }}/server/key.pem"
 |--------------------|---------------|------------------------------|
 |--------------------|---------------|------------------------------|
 | `uchiwa_dc_name` | _undefined_ | Datacenter name for Uchiwa instance |
 | `uchiwa_dc_name` | _undefined_ | Datacenter name for Uchiwa instance |
 | `uchiwa_path` | `/opt/uchiwa` | Path to the Uchiwa configuration directory |
 | `uchiwa_path` | `/opt/uchiwa` | Path to the Uchiwa configuration directory |
-| `uchiwa_redis_use_ssl` | `false` | Determines whether to use SSL for Redis communication |
+| `uchiwa_redis_use_ssl` | `false` | Determines whether to use SSL for redis communication |
 | `uchiwa_user_name`| admin | The user-name to log into Uchiwa |
 | `uchiwa_user_name`| admin | The user-name to log into Uchiwa |
 | `uchiwa_password` | admin | The password to log into Uchiwa |
 | `uchiwa_password` | admin | The password to log into Uchiwa |
 | `uchiwa_port` | 3000 | The TCP port to bind the Uchiwa web service to |
 | `uchiwa_port` | 3000 | The TCP port to bind the Uchiwa web service to |
@@ -82,11 +82,11 @@ sensu_ssl_server_key: "{{ sensu_ssl_tool_base_path }}/server/key.pem"
 | `uchiwa_pkg_download_url` | _undefined_ | The URL of the Uchiwa package to fetch (specific to Linux systems) |
 | `uchiwa_pkg_download_url` | _undefined_ | The URL of the Uchiwa package to fetch (specific to Linux systems) |
 
 
 ## Ubuntu
 ## Ubuntu
-### [Redis Server Properties](https://sensuapp.org/docs/0.21/redis)
+### [redis Server Properties](https://sensuapp.org/docs/0.21/redis)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
 |--------------------|---------------|------------------------------|
 |--------------------|---------------|------------------------------|
-| `redis_pkg_repo`   | `'ppa:rwky/redis'` | The PPA to use for installing Redis from |
-| `redis_pkg_name` | redis-server |  The name of the Redis package to install |
+| `redis_pkg_repo`   | `'ppa:rwky/redis'` | The PPA to use for installing redis from |
+| `redis_pkg_name` | redis-server |  The name of the redis package to install |
 
 
 
 
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
@@ -100,11 +100,11 @@ sensu_ssl_server_key: "{{ sensu_ssl_tool_base_path }}/server/key.pem"
 | `uchiwa_pkg_download_url`  | _See `vars/Ubuntu.yml`_ | The URL of the Uchiwa package to fetch |
 | `uchiwa_pkg_download_url`  | _See `vars/Ubuntu.yml`_ | The URL of the Uchiwa package to fetch |
 
 
 ## Debian
 ## Debian
-### [Redis Server Properties](https://sensuapp.org/docs/0.21/redis)
+### [redis Server Properties](https://sensuapp.org/docs/0.21/redis)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |
 |--------------------|---------------|------------------------------|
 |--------------------|---------------|------------------------------|
-| `redis_pkg_repo`   | `'ppa:rwky/redis'` | The PPA to use for installing Redis from |
-| `redis_service_name` | redis-server | The name of the Redis service |
+| `redis_pkg_repo`   | `'ppa:rwky/redis'` | The PPA to use for installing redis from |
+| `redis_service_name` | redis-server | The name of the redis service |
 
 
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 ### [Sensu Properties](https://sensuapp.org/docs/0.21/install-sensu)
 | Name               | Default Value | Description                  |
 | Name               | Default Value | Description                  |

+ 2 - 2
docs/single_master.md

@@ -15,7 +15,7 @@ sensu_include_dashboard: true
 rabbitmq_server: true
 rabbitmq_server: true
 redis_server: true
 redis_server: true
 ```
 ```
-This would set the node `master.cmacr.ae` to act as the Sensu, RabbitMQ, and Redis server for all Sensu communications across your infrastructure.
+This would set the node `master.cmacr.ae` to act as the Sensu, RabbitMQ, and redis server for all Sensu communications across your infrastructure.
 
 
 ## Statically setting the communication endpoints
 ## Statically setting the communication endpoints
 In `defaults/main.yml` the following keys have the following values:
 In `defaults/main.yml` the following keys have the following values:
@@ -37,5 +37,5 @@ rabbitmq_host: master.cmacr.ae
 redis_host: master.cmacr.ae
 redis_host: master.cmacr.ae
 sensu_api_host: master.cmacr.ae
 sensu_api_host: master.cmacr.ae
 ```
 ```
-This will tell your entire environment that if they're looking to communicate with RabbitMQ, Redis, or the Sensu API, they can talk to `master.cmacr.ae`. Of course, if you're just distributing Sensu to just the `zones` group or `some_other_group`, the same could be set in `group_vars/zones.yml`/`group_vars/some_other_group.yml`.
+This will tell your entire environment that if they're looking to communicate with RabbitMQ, redis, or the Sensu API, they can talk to `master.cmacr.ae`. Of course, if you're just distributing Sensu to just the `zones` group or `some_other_group`, the same could be set in `group_vars/zones.yml`/`group_vars/some_other_group.yml`.
 
 

+ 1 - 1
files/redis_systemd.service

@@ -1,5 +1,5 @@
 [Unit]
 [Unit]
-Description=Redis Datastore Server
+Description=redis Datastore Server
 After=network.target
 After=network.target
 
 
 [Service]
 [Service]

+ 1 - 1
meta/main.yml

@@ -1,6 +1,6 @@
 galaxy_info:
 galaxy_info:
   author: Calum MacRae
   author: Calum MacRae
-  description: Deploy a full Sensu monitoring stack; including Redis, RabbitMQ & the Uchiwa dashboard
+  description: Deploy a full Sensu monitoring stack; including redis, RabbitMQ & the Uchiwa dashboard
   license: MIT
   license: MIT
   min_ansible_version: 2.0
   min_ansible_version: 2.0
   platforms:
   platforms:

+ 1 - 0
mkdocs.yml

@@ -15,6 +15,7 @@ pages:
   - [ 'deploy_plugins.md', 'Usage', 'Deployment of handlers/filters/mutators' ]
   - [ 'deploy_plugins.md', 'Usage', 'Deployment of handlers/filters/mutators' ]
   - [ 'remote_plugins.md', 'Usage', 'Remote plugin deployment']
   - [ 'remote_plugins.md', 'Usage', 'Remote plugin deployment']
   - [ 'sensitive_info.md', 'Usage', 'Sensitive information in version control' ]
   - [ 'sensitive_info.md', 'Usage', 'Sensitive information in version control' ]
+  - [ 'integration.md', 'Usage', 'Integration with other roles/managment methods']
   - [ 'testing.md', 'Usage', 'Testing' ]
   - [ 'testing.md', 'Usage', 'Testing' ]
   - [ 'dynamic_data.md','Conventions','Dynamic data store' ]
   - [ 'dynamic_data.md','Conventions','Dynamic data store' ]
   - [ 'dynamic_checks.md','Conventions','Dynamic check deployment' ]
   - [ 'dynamic_checks.md','Conventions','Dynamic check deployment' ]

+ 3 - 3
tasks/CentOS/redis.yml

@@ -1,16 +1,16 @@
 ---
 ---
-# tasks/CentOS/redis.yml: Deploy Redis
+# tasks/CentOS/redis.yml: Deploy redis
 # Specific to CentOS
 # Specific to CentOS
 
 
   - include_vars: "{{ ansible_distribution }}.yml"
   - include_vars: "{{ ansible_distribution }}.yml"
 
 
-  - name: Ensure Redis is installed
+  - name: Ensure redis is installed
     yum:
     yum:
       name: "{{ redis_pkg_name }}"
       name: "{{ redis_pkg_name }}"
       state: "{{ redis_pkg_state }}"
       state: "{{ redis_pkg_state }}"
       enablerepo: epel
       enablerepo: epel
 
 
-  - name: Ensure Redis binds to accessible IP
+  - name: Ensure redis binds to accessible IP
     lineinfile:
     lineinfile:
       dest: /etc/redis.conf
       dest: /etc/redis.conf
       regexp: '^bind'
       regexp: '^bind'

+ 3 - 3
tasks/Debian/redis.yml

@@ -1,16 +1,16 @@
 ---
 ---
-# tasks/Debian/redis.yml: Deploy Redis
+# tasks/Debian/redis.yml: Deploy redis
 # Specific to Debian
 # Specific to Debian
 
 
   - include_vars: "{{ ansible_distribution }}.yml"
   - include_vars: "{{ ansible_distribution }}.yml"
 
 
-  - name: Ensure Redis is installed
+  - name: Ensure redis is installed
     apt:
     apt:
       name: "{{ redis_pkg_name }}"
       name: "{{ redis_pkg_name }}"
       state: "{{ redis_pkg_state }}"
       state: "{{ redis_pkg_state }}"
       update_cache: true
       update_cache: true
 
 
-  - name: Ensure Redis binds to accessible IP
+  - name: Ensure redis binds to accessible IP
     lineinfile:
     lineinfile:
       dest: /etc/redis/redis.conf
       dest: /etc/redis/redis.conf
       regexp: '^bind'
       regexp: '^bind'

+ 3 - 3
tasks/FreeBSD/redis.yml

@@ -1,15 +1,15 @@
 ---
 ---
-# tasks/FreeBSD/redis.yml: Deploy Redis
+# tasks/FreeBSD/redis.yml: Deploy redis
 # Specific to FreeBSD
 # Specific to FreeBSD
 
 
   - include_vars: "{{ ansible_distribution }}.yml"
   - include_vars: "{{ ansible_distribution }}.yml"
 
 
-  - name: Ensure Redis is installed
+  - name: Ensure redis is installed
     pkgng:
     pkgng:
       name: "{{ redis_pkg_name }}"
       name: "{{ redis_pkg_name }}"
       state: "{{ redis_pkg_state }}"
       state: "{{ redis_pkg_state }}"
 
 
-  - name: Ensure Redis binds to accessible IP
+  - name: Ensure redis binds to accessible IP
     lineinfile:
     lineinfile:
       dest: /usr/local/etc/redis.conf
       dest: /usr/local/etc/redis.conf
       regexp: '^bind'
       regexp: '^bind'

+ 2 - 2
tasks/SmartOS/redis.yml

@@ -1,8 +1,8 @@
 ---
 ---
-# tasks/SmartOS/redis.yml: Deploy Redis
+# tasks/SmartOS/redis.yml: Deploy redis
 # Specific to Ubuntu
 # Specific to Ubuntu
 
 
   - include_vars: "{{ ansible_distribution }}.yml"
   - include_vars: "{{ ansible_distribution }}.yml"
 
 
-  - name: Ensure Redis is installed
+  - name: Ensure redis is installed
     pkgin: name=redis state={{ redis_pkg_state }}
     pkgin: name=redis state={{ redis_pkg_state }}

+ 4 - 4
tasks/Ubuntu/redis.yml

@@ -1,22 +1,22 @@
 ---
 ---
-# tasks/Ubuntu/redis.yml: Deploy Redis
+# tasks/Ubuntu/redis.yml: Deploy redis
 # Specific to Ubuntu
 # Specific to Ubuntu
 
 
   - include_vars: "{{ ansible_distribution }}.yml"
   - include_vars: "{{ ansible_distribution }}.yml"
 
 
-  - name: Ensure the Redis APT repo is present
+  - name: Ensure the redis APT repo is present
     apt_repository:
     apt_repository:
       repo: "{{ redis_pkg_repo }}"
       repo: "{{ redis_pkg_repo }}"
       state: present
       state: present
       update_cache: true
       update_cache: true
 
 
-  - name: Ensure Redis is installed
+  - name: Ensure redis is installed
     apt:
     apt:
       name: "{{ redis_pkg_name }}"
       name: "{{ redis_pkg_name }}"
       state: "{{ redis_pkg_state }}"
       state: "{{ redis_pkg_state }}"
       update_cache: true
       update_cache: true
 
 
-  - name: Deploy Redis systemd service manifest
+  - name: Deploy redis systemd service manifest
     copy:
     copy:
       src: redis_systemd.service
       src: redis_systemd.service
       dest: /etc/systemd/system/redis.service
       dest: /etc/systemd/system/redis.service

+ 2 - 2
tasks/redis.yml

@@ -1,7 +1,7 @@
 ---
 ---
-# tasks/redis.yml: Deploy Redis
+# tasks/redis.yml: Deploy redis
 
 
   - include: "{{ ansible_distribution }}/redis.yml"
   - include: "{{ ansible_distribution }}/redis.yml"
 
 
-  - name: Ensure Redis is running
+  - name: Ensure redis is running
     service: name={{ redis_service_name }} state=started enabled=true
     service: name={{ redis_service_name }} state=started enabled=true

+ 1 - 1
tasks/server.yml

@@ -19,7 +19,7 @@
       src: sensu-api.json.j2
       src: sensu-api.json.j2
     notify: restart sensu-api service
     notify: restart sensu-api service
 
 
-  - name: Deploy Sensu Redis configuration
+  - name: Deploy Sensu redis configuration
     template:
     template:
       dest: "{{ sensu_config_path }}/conf.d/redis.json"
       dest: "{{ sensu_config_path }}/conf.d/redis.json"
       owner: "{{ sensu_user_name }}"
       owner: "{{ sensu_user_name }}"

+ 1 - 1
vars/Debian.yml

@@ -2,7 +2,7 @@
 # vars/Debian.yml: Variables for Debian
 # vars/Debian.yml: Variables for Debian
 # Defaults are defined in vars/default.yml
 # Defaults are defined in vars/default.yml
 
 
-# Redis server properties
+# redis server properties
 redis_pkg_name: redis-server
 redis_pkg_name: redis-server
 redis_service_name: redis-server
 redis_service_name: redis-server
 
 

+ 1 - 1
vars/Ubuntu.yml

@@ -2,7 +2,7 @@
 # vars/Ubuntu.yml: Variables for Ubuntu
 # vars/Ubuntu.yml: Variables for Ubuntu
 # Defaults are defined in vars/default.yml
 # Defaults are defined in vars/default.yml
 
 
-# Redis server properties
+# redis server properties
 redis_pkg_repo: 'ppa:rwky/redis'
 redis_pkg_repo: 'ppa:rwky/redis'
 redis_pkg_name: redis-server
 redis_pkg_name: redis-server