From 2532d6a12e66cd88c0cada655f78ae75610a9c4c Mon Sep 17 00:00:00 2001 From: saibotk Date: Sat, 2 Jan 2021 10:56:38 +0100 Subject: [PATCH] README: Add note about dependencies --- README.md | 10 +++++++--- roles/monitoring/README.md | 2 ++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0bb7969..ad628d6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,11 @@ Ansible infrastructure playbooks/roles for the saibotk.de services. -# Setup +## Requirements + +Some roles may need specific python libraries etc. installed on the ansible client (for example python-influxdb for the [roles/monitoring](roles/monitoring) role). + +## Setup Install all required roles from ansible galaxy using: ``` @@ -14,8 +18,8 @@ Run with your local (test) inventory: ansible-playbook -i test.inventory PLAYBOOK.yml ``` -# License +## License This repository is licensed under GPL-3 and many roles are derived from the awesome [infrastructure](https://git.shivering-isles.com/shivering-isles/infrastructure) repository published by [Sheogorath](https://shivering-isles.com). -Thank you, and so i hope this can be as useful to someone else as Sheogorath's repository was to me. \ No newline at end of file +Thank you, and so I hope this can be as useful to someone else as Sheogorath's repository was to me. \ No newline at end of file diff --git a/roles/monitoring/README.md b/roles/monitoring/README.md index a39f725..ba38666 100644 --- a/roles/monitoring/README.md +++ b/roles/monitoring/README.md @@ -6,6 +6,8 @@ This will setup an [InfluxDB](https://www.influxdata.com/products/influxdb-overv Requirements ------------ +> NOTE: You need the `python-influxdb` package installed locally with the Ansible client, to run this role! + You will need to have docker, docker-compose and traefik installed or declared as dependencies with their respective roles. **This role assumes that you have setup traefik with an endpoint called `websecure`.**