From 45212475c3ded903ddc3e714e790a926a1cf6c0c Mon Sep 17 00:00:00 2001 From: Dr Abraham Martin <amc203@cam.ac.uk> Date: Wed, 9 Dec 2020 09:49:43 +0000 Subject: [PATCH] Update README with information about monitoring --- README.md | 8 ++++++++ modules/monitoring/README.md | 3 --- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1f5acb9..e001d2d 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,11 @@ setting this value you *must* have verified ownership of the domain with Google. [Instructions on how to do this](https://guidebook.devops.uis.cam.ac.uk/en/latest/notes/google-domain-verification/) can be found in the DevOps division guidebook. + +## Monitoring and Alerting +If the variable [alerting_email_address](variables.tf) is set, the module adds +basic uptime alerting via email for failing http polling. See [variables.tf](variables.tf) +for how to configure alerting and monitoring. + +Note that monitoring and alerting must be in a Stackdriver monitoring workspace +and this must be configured manually, at the time of writing this. diff --git a/modules/monitoring/README.md b/modules/monitoring/README.md index df5ab41..2c9dcd4 100644 --- a/modules/monitoring/README.md +++ b/modules/monitoring/README.md @@ -3,9 +3,6 @@ This provides basic uptime alerting via email for failing http polling. See [variables.tf](variables.tf) for how to configure this module. - Note that the project must be in a Stackdriver monitoring workspace and this must be configured manually. At the time of writing there is no terraform support for this. This module will error when applying if this is not so. - - -- GitLab