Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove uptimerobot references and add note about monitoring #3799

Merged
merged 1 commit into from
Sep 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/concepts-basics/lagoon-yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 0 additions & 12 deletions docs/lagoonizing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,9 +252,6 @@ routes:

environments:
main:
monitoring_urls:
- "www.example.com"
- "www.example.com/special_page"
routes:
- nginx:
- example.com
Expand Down Expand Up @@ -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).
Expand Down
1 change: 0 additions & 1 deletion docs/resources/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down