initial import

Author: integrii

Dockerfile

@@ -0,0 +1,6 @@
+FROM node:20-alpine
+WORKDIR /app
+COPY package.json ./
+RUN npm install --production
+COPY check.js ./
+CMD ["node", "check.js"]

Makefile

@@ -0,0 +1,7 @@
+IMAGE ?= kuberhealthy-example-js:latest
+
+build:
+	docker build -t $(IMAGE) .
+
+push:
+	docker push $(IMAGE)

README.md

@@ -0,0 +1,33 @@
+# JavaScript Kuberhealthy Client
+
+This directory contains an example external check for [Kuberhealthy](https://github.com/kuberhealthy/kuberhealthy) written in JavaScript. The script demonstrates how to report a successful run or a failure back to Kuberhealthy using environment variables provided to every checker pod.
+
+## Usage
+
+1. **Add your logic**: edit `check.js` and replace the placeholder section in `main` with your own check logic. Call `report(true, [])` when the check succeeds or `report(false, ["message"])` on failure.
+2. **Build the image**: run `make build IMAGE=my-registry/my-check:tag` to build a container image containing your check.
+3. **Push the image**: `make push IMAGE=my-registry/my-check:tag`.
+4. **Create a KuberhealthyCheck**: write a khcheck resource that references your image and apply it to clusters where Kuberhealthy runs.
+
+The check relies on two environment variables set automatically by Kuberhealthy:
+
+- `KH_REPORTING_URL` – the endpoint where status reports are posted.
+- `KH_RUN_UUID` – the UUID for this check run. It must be sent back in the `kh-run-uuid` header.
+
+## Example khcheck
+
+```yaml
+apiVersion: kuberhealthy.github.io/v2
+kind: KuberhealthyCheck
+metadata:
+  name: example-js-check
+  namespace: kuberhealthy
+spec:
+  runInterval: 1m
+  podSpec:
+    containers:
+      - name: check
+        image: my-registry/my-check:tag
+```
+
+Apply the file with `kubectl apply -f <file>`.

check.js

@@ -0,0 +1,46 @@
+const reportingURL = process.env.KH_REPORTING_URL;
+const runUUID = process.env.KH_RUN_UUID;
+
+if (!reportingURL || !runUUID) {
+  console.error('KH_REPORTING_URL and KH_RUN_UUID must be set');
+  process.exit(1);
+}
+
+// report sends a result to Kuberhealthy
+async function report(ok, errors) {
+  const res = await fetch(reportingURL, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      'kh-run-uuid': runUUID,
+    },
+    body: JSON.stringify({ ok, errors }),
+  });
+
+  if (res.ok) {
+    return;
+  }
+
+  const text = await res.text();
+  throw new Error(`Kuberhealthy responded with ${res.status}: ${text}`);
+}
+
+async function main() {
+  try {
+    // Add your check logic here.
+    await report(true, []);
+    console.log('Reported success to Kuberhealthy');
+  } catch (err) {
+    console.error('Check logic failed:', err);
+    try {
+      await report(false, [err.message]);
+    } catch (e) {
+      console.error('Failed to report failure:', e);
+    }
+    process.exit(1);
+  }
+}
+
+main();
+
+module.exports = { report };

package.json

@@ -0,0 +1,10 @@
+{
+  "name": "kuberhealthy-javascript-client",
+  "version": "0.1.0",
+  "description": "Example Kuberhealthy external check written in JavaScript",
+  "main": "check.js",
+  "scripts": {
+    "start": "node check.js"
+  },
+  "dependencies": {}
+}