aboutsummaryrefslogtreecommitdiffstats
path: root/roles/nagios_client/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/nagios_client/README.md')
-rw-r--r--roles/nagios_client/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/roles/nagios_client/README.md b/roles/nagios_client/README.md
new file mode 100644
index 0000000..fffa1bb
--- /dev/null
+++ b/roles/nagios_client/README.md
@@ -0,0 +1,32 @@
+Nagios Client
+=============
+
+Description
+-----------
+
+The `nagios_client` role creates the `nagios` user and installs Nagios plugins.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+---------------------------------|-----------|------------
+`nagios_ssh_pubkey` |   | SSH public key for `nagios` user
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: all
+ roles:
+ - role: nagios_client
+ vars:
+ nagios_ssh_pubkey: |
+ ssh-ed25519 AAAA...
+````