From 379f4b0b4aeea7c2ab4969573058a67770325e46 Mon Sep 17 00:00:00 2001 From: shreddedbacon Date: Tue, 27 Aug 2024 09:37:51 +1000 Subject: [PATCH] docs: remove uptime robot references and add note about monitoring support --- docs/concepts-basics/lagoon-yml.md | 10 +++++++++- docs/lagoonizing/index.md | 12 ------------ docs/resources/glossary.md | 1 - 3 files changed, 9 insertions(+), 14 deletions(-) diff --git a/docs/concepts-basics/lagoon-yml.md b/docs/concepts-basics/lagoon-yml.md index 64e03eee66..8eb4c67799 100644 --- a/docs/concepts-basics/lagoon-yml.md +++ b/docs/concepts-basics/lagoon-yml.md @@ -275,13 +275,21 @@ that's important!): ### Monitoring a specific path -When [UptimeRobot](https://uptimerobot.com/) is configured for your cluster \(Kubernetes or OpenShift\), Lagoon will inject annotations to each route/ingress for use by the `stakater/IngressControllerMonitor`. The default action is to monitor the homepage of the route. If you have a specific route to be monitored, this can be overridden by adding a `monitoring-path` to your route specification. A common use is to set up a path for monitoring which bypasses caching to give a more real-time monitoring of your site. +!!! Info + Lagoon does not provide any monitoring capabilties out of the box, only labels and annotations. Check with {{ defaults.helpstring }} if monitoring is supported. + +Lagoon will add the label `lagoon.sh/primaryIngress=true` to the first route defined in the `.lagoon.yml` file for an environment. + +If a specific path on a route requires monitoring, define `monitoring-path` with the path to use. Lagoon will add this path to the annotation `monitor.stakater.com/overridePath` to the route. ```yaml title=".lagoon.yml" - "www.example.com": monitoring-path: "/bypass-cache" ``` +!!! Info + The annotation `monitor.stakater.com/overridePath` used by monitoring-path references the stakater monitoring controller, this is not used by Lagoon. This annotation will eventually be replaced with a `lagoon.sh` scoped annotation in the future. + ### Ingress annotations !!! Warning diff --git a/docs/lagoonizing/index.md b/docs/lagoonizing/index.md index e129b54a59..fbd10efc8b 100644 --- a/docs/lagoonizing/index.md +++ b/docs/lagoonizing/index.md @@ -252,9 +252,6 @@ routes: environments: main: - monitoring_urls: - - "www.example.com" - - "www.example.com/special_page" routes: - nginx: - example.com @@ -352,15 +349,6 @@ The following options are allowed: Environment names match your deployed branches or pull requests. This allows each environment to have a different configuration. In this example, we have the environments main and staging. -#### Monitoring a Specific Path - -When UptimeRobot is configured for your cluster, Lagoon will inject annotations to each route/ingress for use by the `stakater/IngressControllerMonitor`. The default action is to monitor the homepage of the route. If you have a specific route to be monitored, this can be overridden by adding a `monitoring-path` to your route specification. A common use is to set up a path for monitoring which bypasses caching to give a more real-time monitoring of your site. - -```yaml title=".lagoon.yml example" - - "www.example.com": - monitoring-path: "/bypass-cache" -``` - #### `environments.[name].routes` In the route section, we identify the domain names to which the environment will respond. It is typical to only have an environment with routes specified for your production environment. All environments receive a generated route, but sometimes there is a need for a non-production environment to have its own domain name. You can specify it here, and then add that domain with your DNS provider as a CNAME to the generated route name (these routes publish in deploy messages). diff --git a/docs/resources/glossary.md b/docs/resources/glossary.md index 6058bfd646..41e9814c9f 100644 --- a/docs/resources/glossary.md +++ b/docs/resources/glossary.md @@ -109,7 +109,6 @@ description: >- | TLS | Transport Layer Security | | Trivy | A simple and comprehensive vulnerability scanner for containers, suitable for CI. | | TTL | Time to live or hop limit is a mechanism that limits the lifespan or lifetime of data in a computer or network. | -| Uptime Robot | Uptime monitoring service. | | Varnish | A powerful, open-source HTTP engine/reverse HTTP proxy that can speed up a website by caching \(or storing\) a copy of a webpage the first time a user visits. | | VM | Virtual Machine | | Webhook | A webhook is a way for an app like GitHub, GitLab, Bitbucket, etc, to provide other applications with immediate data and act upon something, like a pull request. |