From 76237c6bf63e131f749ccbd8f8df3996a7ad95d6 Mon Sep 17 00:00:00 2001 From: Lukasz Raczylo Date: Thu, 21 May 2026 04:06:40 +0100 Subject: [PATCH] docs: add Telemetry section linking to oss-telemetry opt-out docs Discloses the single anonymous adoption ping sent on startup and points users to the upstream README section for full opt-out instructions instead of duplicating the table here. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index ad6daca..b65fee8 100644 --- a/README.md +++ b/README.md @@ -970,6 +970,19 @@ git push origin v0.2.0 - [Helm Chart Documentation](charts/kubemirror/README.md) - Kubernetes deployment via Helm - [GitHub Repository](https://github.com/lukaszraczylo/kubemirror) - Source code and issue tracker +## Telemetry + +On startup this controller sends a single anonymous adoption ping — project +name, version, timestamp; no identifiers, no Kubernetes object data, no +cluster metadata. Fire-and-forget with a 2-second timeout; cannot block +startup or panic. + +See **[oss-telemetry — Disabling telemetry](https://github.com/lukaszraczylo/oss-telemetry#disabling-telemetry)** +for the exact wire format, source, and full opt-out documentation. + +Quick opt-out: set any of `DO_NOT_TRACK=1`, `OSS_TELEMETRY_DISABLED=1`, +or `KUBEMIRROR_DISABLE_TELEMETRY=1`. + ## License See [LICENSE](LICENSE) file for details.