From 9ea37be45f2edadbf534b4e0252641febe045299 Mon Sep 17 00:00:00 2001 From: Travis Nielsen Date: Thu, 14 Jul 2022 14:30:10 -0600 Subject: [PATCH] docs: add telemetry section to quickstart guide To start collecting telemetry on upstream clusters, we add a new section to the quickstart guide that requests users to enable the telemetry. Signed-off-by: Travis Nielsen --- Documentation/Getting-Started/quickstart.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/Documentation/Getting-Started/quickstart.md b/Documentation/Getting-Started/quickstart.md index 2f98ce1a3..24ec41ef6 100644 --- a/Documentation/Getting-Started/quickstart.md +++ b/Documentation/Getting-Started/quickstart.md @@ -164,6 +164,19 @@ Create a toolbox pod for full access to a ceph admin client for debugging and tr Each Rook cluster has some built in metrics collectors/exporters for monitoring with [Prometheus](https://prometheus.io/). To learn how to set up monitoring for your Rook cluster, you can follow the steps in the [monitoring guide](../Storage-Configuration/Monitoring/ceph-monitoring.md). +## Telemetry + +To allow us to understand usage, the maintainers for Rook and Ceph would like to receive telemetry reports for Rook clusters. +The data is anonymous and does not include any identifying information. +We invite you to enable the telemetry reporting feature with the following command in the toolbox: + +``` +ceph telemetry on +``` + +The telemetry is disabled by default. For more details on what is reported and how your privacy is protected, +see the [Ceph Telemetry Documentation](https://docs.ceph.com/en/latest/mgr/telemetry/). + ## Teardown When you are done with the test cluster, see [these instructions](../Storage-Configuration/ceph-teardown.md) to clean up the cluster.