Moved role variables to dedicated page + a few cosmetic cleanups

docs/deploy_plugins.md

@@ -1,5 +1,5 @@
 # Deployment of Handlers, Filters, and Mutators
-_Note:_ _If you haven't familiarized yourself with the concept of the static data store please read_['_Dynamic check deployment'_](http://rtfm.cmacr.ae/dynamic_checks/)
+_Note:_ _If you haven't familiarized yourself with the concept of the static data store please read_['_Dynamic check deployment'_](dynamic_checks.md)
 
 Deployment of [handlers](https://sensuapp.org/docs/0.18/handlers), [filters](https://sensuapp.org/docs/0.18/filters), and [mutators](https://sensuapp.org/docs/0.18/mutators) is handled by leveraging templates and other data placed in the static data store.
 

docs/index.md

@@ -4,12 +4,11 @@ An [Ansible](https://ansible.com) role that deploys a full [Sensu](https://sensu
 ## Features
 - Deploy a full Sensu stack, including RabbitMQ, Redis, and the [Uchiwa dashboard](https://uchiwa.io/#/)
 - Tight integration with the Ansible inventory - deployment of monitoring checks based on role defined in your inventory
+- Fine grained control over dynamic client configurations
 - Automatic generation and dynamic deployment of SSL certs for secure communication between your clients and servers
 - Highly configurable
 
 ## Supported Platforms
-This role has been written with [SmartOS](https://smartos.org) in mind, to be deployed to [zones](https://wiki.smartos.org/display/DOC/Zones)
-
 In this initial release [SmartOS](https://smartos.org) will be the only supported platform.
 However, I am dedicating a lot of time to this role and will be adding support for all major BSD & Linux platforms.
 
@@ -24,59 +23,8 @@ However, I am dedicating a lot of time to this role and will be adding support f
 - Ubuntu / Debian
 
 ## Role Variables
-All variables have sensible defaults, which can be found in `defaults/main.yml`.
-The current version includes the following variables:
-
-### RabbitMQ Server Properties - [Sensu RabbitMQ documentation](https://sensuapp.org/docs/0.18/rabbitmq)
-| Name               | Default Value | Description                  |
-|--------------------|---------------|------------------------------|
-| rabbitmq\_config\_path| /opt/local/etc/rabbitmq | Path to the RabbitMQ configuration directory |
-| rabbitmq\_host| "{{ groups\['rabbitmq\_servers']\[0] }}" | The hostname/IP address of the RabbitMQ node |
-| rabbitmq\_port| 5671 | The transmission port for RabbitMQ communications |
-| rabbitmq\_server| false | Determines whether to include the deployment of RabbitMQ |
-| rabbitmq\_sensu\_user\_name| sensu | Username 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 |
-
-### Redis Server Properties - [Sensu Redis documentation](https://sensuapp.org/docs/0.18/redis)
-| 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_port| 6379 | The transmission port for Redis communications |
-
-### Sensu Properties - [Sensu services documentation](https://sensuapp.org/docs/0.18/install-sensu)
-| Name               | Default Value | Description                  |
-|--------------------|---------------|------------------------------|
-| sensu\_api\_host| "{{ groups['sensu_masters'][0] }}" | Hostname/IP address of the node running the Sensu API |
-| sensu\_api\_port| 4567 | Transmission port for Sensu API communications |
-| sensu\_api\_ssl| "false" | Determines whether to use SSL for Sensu API communications |
-| sensu\_api\_user\_name| admin | Username for authentication with the Sensu API |
-| sensu\_api\_password| secret | Password for authentication with the Sensu API |
-| sensu\_api\_uchiwa\_path| '' | Path to append to the Sensu API URI for Uchiwa communications |
-| sensu\_api\_timeout| 5000 | Value to set for the Sensu API timeout |
-| sensu\_client\_config| client.json.j2 | Jinja2 template to use for node configuration of the Sensu Client service |
-| sensu\_config\_path| /opt/local/etc/sensu | Path to the Sensu configuration directory |
-| sensu\_gem\_state| present | State of the Sensu gem - can be set to `latest` to keep Sensu updated |
-| sensu\_plugin\_gem\_state| present | State of the Sensu Plugins gem - can be set to `latest` to keep Sensu Plugins updated |
-| sensu\_group\_name| sensu | The name of the Sensu service user's primary group |
-| sensu\_include\_plugins| true | Determines whether to include the `sensu-plugins` gem |
-| sensu\_include\_dashboard| false | Determines whether to deploy the Uchiwa dashboard |
-| sensu\_master| false | Determines if a node is to act as the Sensu "master" node |
-| sensu\_user\_name| sensu | The name of the Sensu service user |
-
-### Uchiwa Properties - [Uchiwa documentation](http://docs.uchiwa.io/en/latest/)
-| Name               | Default Value | Description                  |
-|--------------------|---------------|------------------------------|
-| uchiwa\_dc\_name| _undefined_ | Datacenter name for Uchiwa instance |
-| uchiwa\_path| /opt/uchiwa | Path to the Uchiwa configuration directory |
-| 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\_password| admin | The password to log into Uchiwa |
-| uchiwa\_port| 3000 | The TCP port to bind the Uchiwa web service to |
-| uchiwa\_refresh| 5 | The interval to pull the Sensu APIs in seconds |
-
-_Note_: _A few of these defaults will be moving to_`vars`_in the near future due to the addition of other OS support_
+All variables have sensible defaults, which can be found in `defaults/main.yml`.  
+Head over to [the role variables page](role_variables.md) to review them
 
 ## Example Playbook
 
@@ -95,7 +43,7 @@ Or, passing parameter values:
 
 License
 -------
-MIT
+[MIT](license.md)
 
 Author Information
 ------------------

docs/role_variables.md

@@ -0,0 +1,52 @@
+# Role Variables
+
+### RabbitMQ Server Properties - [Sensu RabbitMQ documentation](https://sensuapp.org/docs/0.18/rabbitmq)
+| Name               | Default Value | Description                  |
+|--------------------|---------------|------------------------------|
+| rabbitmq\_config\_path| /opt/local/etc/rabbitmq | Path to the RabbitMQ configuration directory |
+| rabbitmq\_host| "{{ groups\['rabbitmq\_servers']\[0] }}" | The hostname/IP address of the RabbitMQ node |
+| rabbitmq\_port| 5671 | The transmission port for RabbitMQ communications |
+| rabbitmq\_server| false | Determines whether to include the deployment of RabbitMQ |
+| rabbitmq\_sensu\_user\_name| sensu | Username 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 |
+
+### Redis Server Properties - [Sensu Redis documentation](https://sensuapp.org/docs/0.18/redis)
+| 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_port| 6379 | The transmission port for Redis communications |
+
+### Sensu Properties - [Sensu services documentation](https://sensuapp.org/docs/0.18/install-sensu)
+| Name               | Default Value | Description                  |
+|--------------------|---------------|------------------------------|
+| sensu\_api\_host| "{{ groups['sensu_masters'][0] }}" | Hostname/IP address of the node running the Sensu API |
+| sensu\_api\_port| 4567 | Transmission port for Sensu API communications |
+| sensu\_api\_ssl| "false" | Determines whether to use SSL for Sensu API communications |
+| sensu\_api\_user\_name| admin | Username for authentication with the Sensu API |
+| sensu\_api\_password| secret | Password for authentication with the Sensu API |
+| sensu\_api\_uchiwa\_path| '' | Path to append to the Sensu API URI for Uchiwa communications |
+| sensu\_api\_timeout| 5000 | Value to set for the Sensu API timeout |
+| sensu\_client\_config| client.json.j2 | Jinja2 template to use for node configuration of the Sensu Client service |
+| sensu\_config\_path| /opt/local/etc/sensu | Path to the Sensu configuration directory |
+| sensu\_gem\_state| present | State of the Sensu gem - can be set to `latest` to keep Sensu updated |
+| sensu\_plugin\_gem\_state| present | State of the Sensu Plugins gem - can be set to `latest` to keep Sensu Plugins updated |
+| sensu\_group\_name| sensu | The name of the Sensu service user's primary group |
+| sensu\_include\_plugins| true | Determines whether to include the `sensu-plugins` gem |
+| sensu\_include\_dashboard| false | Determines whether to deploy the Uchiwa dashboard |
+| sensu\_master| false | Determines if a node is to act as the Sensu "master" node |
+| sensu\_user\_name| sensu | The name of the Sensu service user |
+
+### Uchiwa Properties - [Uchiwa documentation](http://docs.uchiwa.io/en/latest/)
+| Name               | Default Value | Description                  |
+|--------------------|---------------|------------------------------|
+| uchiwa\_dc\_name| _undefined_ | Datacenter name for Uchiwa instance |
+| uchiwa\_path| /opt/uchiwa | Path to the Uchiwa configuration directory |
+| 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\_password| admin | The password to log into Uchiwa |
+| uchiwa\_port| 3000 | The TCP port to bind the Uchiwa web service to |
+| uchiwa\_refresh| 5 | The interval to pull the Sensu APIs in seconds |
+
+_Note_: _A few of these defaults will be moving to_`vars`_in the near future due to the addition of other OS support_

docs/sensitive_info.md

@@ -48,5 +48,5 @@ Then, to ensure the variables are picked up during the play, you can add `vars/s
 ```
 
 ### Editing encrypted data
-Editing encrypted data is as easy as `$ ansible-vault edit path/to/data.yml`
+Editing encrypted data is as easy as `$ ansible-vault edit path/to/data.yml`  
 See [the Ansible Vault page for more information](http://docs.ansible.com/playbooks_vault.html)

mkdocs.yml

@@ -6,7 +6,8 @@ site_author: Calum MacRae
 
 theme: flatly
 pages:
-  - [ 'index.md', 'Index' ]
+  - [ 'index.md', 'Home' ]
+  - [ 'role_variables.md', 'Usage', 'Role variables' ]
   - [ 'example_infra.md', 'Usage', 'Example infrastructure layout' ]
   - [ 'single_master.md', 'Usage', 'Deploy the stack to a single node' ]
   - [ 'custom_client_config.md', 'Usage', 'Custom client configuration' ]