|
9 | 9 |
|
10 | 10 | --- |
11 | 11 |
|
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. |
13 | 13 |
|
14 | 14 | ## Prerequisites |
15 | 15 |
|
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 |
19 | 19 |
|
20 | | -Now, clone the repo with the examples: |
| 20 | +## Deploying the Checkly Agent with Helm |
21 | 21 |
|
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. |
26 | 23 |
|
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). |
0 commit comments