{"id":20390466,"url":"https://github.com/checkly/checkly-k8s","last_synced_at":"2025-06-19T11:35:20.542Z","repository":{"id":50556632,"uuid":"485066889","full_name":"checkly/checkly-k8s","owner":"checkly","description":"Checkly Kubernetes Helm chart and manifests","archived":false,"fork":false,"pushed_at":"2024-10-30T11:42:43.000Z","size":18,"stargazers_count":8,"open_issues_count":1,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-13T11:56:29.846Z","etag":null,"topics":["kubernetes","monitoring"],"latest_commit_sha":null,"homepage":"","language":"Smarty","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/checkly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-04-24T15:35:42.000Z","updated_at":"2025-06-12T10:08:30.000Z","dependencies_parsed_at":"2025-04-12T11:29:27.595Z","dependency_job_id":"34988821-44fc-42f8-91f0-afea95b6ae5c","html_url":"https://github.com/checkly/checkly-k8s","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/checkly/checkly-k8s","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-k8s","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-k8s/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-k8s/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-k8s/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/checkly","download_url":"https://codeload.github.com/checkly/checkly-k8s/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/checkly%2Fcheckly-k8s/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260742824,"owners_count":23055852,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kubernetes","monitoring"],"created_at":"2024-11-15T03:25:06.707Z","updated_at":"2025-06-19T11:35:15.035Z","avatar_url":"https://github.com/checkly.png","language":"Smarty","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Checkly Agent Kubernetes resources\n\nThis repo contains a Helm chart and a few example Kubernetes manifests that can be used to run the Checkly Agent for your\n[Checkly Private Location](https://www.checklyhq.com/docs/private-locations) on Kubernetes.\n\nClone the repo to get started.\n\n```bash\ngit clone https://github.com/checkly/checkly-k8s.git\ncd checkly-k8\n```\n\n## Helm chart\n\nFind the Helm chart in the `/helm-cart` directory. The Helm chart does two basic things:\n- Creates a secret for the API key.\n- Spins up two pods running the Checkly Agent\n\n\nAssuming you have Helm set up to point at your K8S cluster, run it with the following command, making sure you \n**replace the `apikey=\"pl_...\"` with your Checkly Private Location API key**.\n\n```bash\nhelm install checkly-agent --set apiKeySecret.apiKey=\"pl_...\"  ./helm-chart\n```\n\n### Alternative ways to set Agent API Key\nInstead of setting `apiKeySecret.apiKey` you can also choose an existing secret with the following options \n\n```\napiKeySecret\n    create: false\n    name: \u003cNAME_OF_EXISTING_SECRET\u003e\n```\n\nor create the secret with `extraManifests`\n\n```\napiKeySecret\n    create: false\n    name: \u003cNAME_OF_SECRET_CREATED_BY_EXTRAMANIFEST\u003e\n\nextraManifests:\n    - apiVersion: external-secrets.io/v1beta1\n      kind: ExternalSecret\n      metadata:\n      name: checkly-agent-secret\n      namespace: monitoring\n      spec:\n      target:\n        name: my-checkly-secret-in-aws\n```\n\n## Kubernetes manifests\n\nIf you are not using Helm, you can also use these K8S manifest files to create your preferred cluster setup for the Checkly\nAgent.\n\n## [agentSecret.yaml](https://github.com/checkly/checkly-k8s/blob/main/k8s-manifests/agent-secret.yaml)\n\nCreates a secret containing the API key your agents use to connect to the private location. Useful if you want to obfuscate \nthe key so others can't see it with the `kubectl describe pod` command. The pod and deployment manifests are configured \nto use this secret.\n\n## [agentPod.yaml](https://github.com/checkly/checkly-k8s/blob/main/k8s-manifests/agent-pod.yaml)\n\nCreates a single pod running the Checkly agent. Connects to the Private Location using the API key specified in \n[agentSecret.yaml](https://github.com/checkly/checkly-k8s/blob/main/agentSecret.yaml). Uses the \n[latest image](https://github.com/checkly/checkly-lambda-runners/pkgs/container/agent).\n\n## [agentDeployment.yaml](https://github.com/checkly/checkly-k8s/blob/main/k8s-manifests/agent-deployment.yaml)\n\nCreate a deployment of Checkly agent pods (default: 2). Connects to the private location using the API key specified in \n[agentSecret.yaml](https://github.com/checkly/checkly-k8s/blob/main/agentSecret.yaml). Uses the \n[latest image](https://github.com/checkly/checkly-lambda-runners/pkgs/container/agent). Rolling updates are enabled.\n\n## [checklyNamespace.yaml](https://github.com/checkly/checkly-k8s/blob/main/k8s-manifests/checkly-namespace.yaml)\n\nOptional - Creates a namespace for the Checkly agent resources.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckly%2Fcheckly-k8s","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckly%2Fcheckly-k8s","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckly%2Fcheckly-k8s/lists"}