Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.

Commit 28ff7e2

Browse files
authored
Merge branch 'main' into mda-pw-test
2 parents 4fed14a + 92079a8 commit 28ff7e2

5 files changed

Lines changed: 9 additions & 54 deletions

File tree

site/content/docs/alerting-and-retries/retries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ There are some tradeoffs to consider:
6969

7070
### Network retries
7171

72-
For API checks, you can enable network retries to automatically retry a check run only if it fails due to a network error—such as a timeout, DNS resolution issue, or connection reset.
72+
For API checks & URL monitors, you can enable network retries to automatically retry a check run only if it fails due to a network error—such as a timeout, DNS resolution issue, or connection reset.
7373

7474
When network retries are enabled:
7575
* The check will retry on: ECONNRESET, ENOTFOUND, ETIMEDOUT, EAI_AGAIN, ECONNREFUSED, and similar network errors.

site/content/docs/cli/constructs-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1041,6 +1041,7 @@ For all of the methods above, the `options` argument can be used to customize th
10411041
- `maxRetries`: The maximum number of times to retry the check. This value should be between 1 and 10. Defaults to 2.
10421042
- `maxDurationSeconds`: The maximum amount of time to continue retrying the check. Maximum 600 seconds. Defaults to 600 seconds.
10431043
- `sameRegion`: Whether retries should be run in the same region as the initial failed check run. Defaults to `true`.
1044+
- `onlyOn`: Limits retries to specific failure types. Currently supports 'NETWORK_ERROR' only, and is only applicable to API checks and URL monitors. See [Network retries](/docs/alerting-and-retries/retries/#network-retries) for more information.
10441045

10451046
## `AlertEscalationPolicy`
10461047

site/content/docs/monitoring/global-locations.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ menu:
99
---
1010
You can configure your run checks to run from an ever growing amount of global locations. Leveraging global infrastructure allows us to measure what the user experience is in different parts of the world.
1111

12-
We use [Amazon Web Services](https://aws.amazon.com) to host our check runner infrastructure and follow the opening of new datacenter locations as close a possible, i.e. if a new location opens up, Checkly will be there very soon.
13-
1412
Current locations in Checkly are
1513

1614
| Americas | Europe/Middle East/Africa | Asia Pacific |

site/content/docs/private-locations/running-on-kubernetes.md

Lines changed: 7 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -9,58 +9,16 @@ menu:
99

1010
---
1111

12-
We advise running any production-grade Checkly Agent deployments on a container orchestrator like Kubernetes. To help you get started, we created the [checkly-k8s repo](https://github.com/checkly/checkly-k8s) which contains a Helm chart and a few example Kubernetes manifests.
12+
We advise running any production-grade Checkly Agent deployments on a container orchestrator like Kubernetes. To help you get started, we provide a [public Helm chart](https://github.com/checkly/helm-charts) for deploying the agent.
1313

1414
## Prerequisites
1515

16-
- You've [created a Private Location](/docs/private-locations/) and have an API key.
17-
- A running Kubernetes cluster
18-
- [Helm](https://helm.sh/) if you are using Helm charts.
16+
- You've [created a Private Location](/docs/private-locations/) and have an API key
17+
- You have a running Kubernetes cluster
18+
- [Helm](https://helm.sh/) is installed
1919

20-
Now, clone the repo with the examples:
20+
## Deploying the Checkly Agent with Helm
2121

22-
```bash
23-
git clone https://github.com/checkly/checkly-k8s.git
24-
cd checkly-k8
25-
```
22+
See the [Checkly Helm Charts README](https://github.com/checkly/helm-charts/tree/main/charts/agent#readme) for installation instructions and configuration options.
2623

27-
## Helm chart
28-
29-
Find the Helm chart in the `/helm-chart` directory. The Helm chart does two basic things:
30-
- Creates a secret for the API key.
31-
- Spins up two pods running the Checkly Agent
32-
33-
Assuming you have Helm set up to point at your K8S cluster, run it with the following command, making sure you
34-
**replace the `apiKeySecret.apikey="pl_..."` with your Checkly Private Location API key**.
35-
36-
```bash
37-
helm install checkly-agent --set apiKeySecret.apiKey="pl_..." ./helm-chart
38-
```
39-
40-
## Kubernetes manifests
41-
42-
If you are not using Helm, you can also use K8S manifest files to create your preferred cluster setup for the Checkly
43-
Agent. Here is a rundown of the manifest files you can find in the repo:
44-
45-
### [agentSecret.yaml](https://github.com/checkly/checkly-k8s/blob/main/k8s-manifests/agent-secret.yaml)
46-
47-
Creates a secret containing the API key your agents use to connect to the private location. The pod and deployment manifests are configured
48-
to use this secret.
49-
50-
### [agentPod.yaml](https://github.com/checkly/checkly-k8s/blob/main/k8s-manifests/agent-pod.yaml)
51-
52-
Creates a single pod running the Checkly agent. Connects to the Private Location using the API key specified in
53-
[agentSecret.yaml](https://github.com/checkly/checkly-k8s/blob/main/k8s-manifests/agent-secret.yaml). Uses the
54-
[latest image](https://hub.docker.com/r/checkly/agent/tags).
55-
56-
This is a quick way to test the Checkly Agent on your cluster. Be aware, if the container exits, it will not automatically restarted.
57-
58-
### [agentDeployment.yaml](https://github.com/checkly/checkly-k8s/blob/main/k8s-manifests/agent-deployment.yaml)
59-
60-
Create a deployment of Checkly agent pods (default: 2). Connects to the private location using the API key specified in
61-
[agentSecret.yaml](https://github.com/checkly/checkly-k8s/blob/main/k8s-manifests/agent-secret.yaml)). Uses the
62-
[latest image](https://hub.docker.com/r/checkly/agent/tags). Rolling updates are enabled.
63-
64-
### [checklyNamespace.yaml](https://github.com/checkly/checkly-k8s/blob/main/k8s-manifests/checkly-namespace.yaml)
65-
66-
Optional but recommended - Creates a namespace for the Checkly agent resources. Make sure to have NetworkPolicies in place to your other namespaces.
24+
If you run into any issues, feel free to open an issue on the repository or reach out via the [Community Slack](https://join.slack.com/t/checklycommunity/shared_invite/zt-2qc51mpyr-5idwVD4R4izkf5FC4CFk1A).

site/content/docs/url-monitors/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@ new UrlMonitor('hello-url-1', {
5858
name: 'Hello URL',
5959
activated: true,
6060
request: {
61-
method: 'GET',
6261
url: 'https://api.checklyhq.com/v1/echo/get',
6362
assertions: [
6463
UrlAssertionBuilder.statusCode().equals(200),
@@ -77,7 +76,6 @@ new UrlMonitor('hello-url-1', {
7776
name: 'Hello URL',
7877
activated: true,
7978
request: {
80-
method: 'GET',
8179
url: 'https://api.checklyhq.com/v1/echo/get',
8280
assertions: [
8381
UrlAssertionBuilder.statusCode().equals(200),

0 commit comments

Comments
 (0)