Merge pull request #928 from joelddiaz/monitoring-deploy

Created role to deploy ops host monitoring

1 files changed, 50 insertions, 0 deletions

diff --git a/roles/oso_host_monitoring/README.md b/roles/oso_host_monitoring/README.md
new file mode 100644
index 000000000..f1fa05adb
--- /dev/null
+++ b/roles/oso_host_monitoring/README.md
@@ -0,0 +1,50 @@
+Role Name
+=========
+
+Applies local host monitoring container(s).
+
+Requirements
+------------
+
+None.
+
+Role Variables
+--------------
+
+osohm_zagg_web_url: where to contact monitoring service
+osohm_host_monitoring: name of host monitoring container
+osohm_zagg_client: name of container with zabbix client
+osohm_docker_registry_url: docker repository containing above containers
+osohm_default_zagg_server_user: login info to zabbix server
+osohm_default_zagg_password: password to zabbix server
+
+Dependencies
+------------
+
+None.
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+
+    - hosts: servers
+      roles:
+      - oso_host_monitoring
+      vars:
+        osohm_zagg_web_url: "https://..."
+        osohm_host_monitoring: "oso-rhel7-host-monitoring"
+        osohm_zagg_client: "oso-rhel7-zagg-client"
+        osohm_docker_registry_url: "docker-registry.example.com/mon/"
+        osohm_default_zagg_server_user: "zagg-client"
+        osohm_default_zagg_password: "secret"
+
+License
+-------
+
+ASL 2.0
+
+Author Information
+------------------
+
+OpenShift operations, Red Hat, Inc