Skip to content

fix(telemetry): document the opt-out for both collectors #651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Andrei Kvapil (kvaps) wants to merge 2 commits into
base: main
Choose a base branch
from
+71 −6
Open

fix(telemetry): document the opt-out for both collectors #651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6381cc
fix(telemetry): document the opt-out for both collectors
kvaps Aug 12, 2026
254b0e3
fix(telemetry): document the controller opt-out for v1.5 too
kvaps Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions content/en/docs/next/operations/configuration/telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,11 @@ We respect your privacy and choice regarding telemetry. If you prefer not to par

Opting Out:

To disable telemetry reporting, upgrade the Cozystack operator Helm release with the `disableTelemetry` flag:
Telemetry is sent by the two components named above, and they are installed by
two different charts, so opting out takes two steps. Doing only the first
leaves `cozystack-controller` reporting application counts.

**1. The operator**, which is part of the `cozy-installer` release:

```bash
helm upgrade cozystack oci://ghcr.io/cozystack/cozystack/cozy-installer \
Expand All @@ -79,7 +83,24 @@ Replace `X.Y.Z` with your currently installed Cozystack version.

{{< reuse-values-warning >}}

This command updates the operator to disable telemetry data collection. If you wish to re-enable telemetry in the future, run the same command with `disableTelemetry=false`.
**2. The controller**, which the platform deploys. Set `telemetry.disabled` in
the Platform Package and apply it:

```yaml
apiVersion: cozystack.io/v1alpha1
kind: Package
metadata:
name: cozystack.cozystack-platform
spec:
components:
platform:
values:
telemetry:
disabled: true
```

To re-enable telemetry later, run the same command with
`disableTelemetry=false` and set `telemetry.disabled: false`.
Comment on lines +102 to +103

@coderabbitai coderabbitai Bot Aug 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Document separate re-enable actions for the operator and controller.

Each page uses two configuration mechanisms, but the re-enable text can lead users to run only the Helm command and omit the Package update.

  • content/en/docs/next/operations/configuration/telemetry.md#L102-L103: run Helm with cozystackOperator.disableTelemetry=false, then set telemetry.disabled: false in the Platform Package and apply it.
  • content/en/docs/v1.5/operations/configuration/telemetry.md#L103-L104: run Helm with cozystackOperator.disableTelemetry=false, then set cozystackController.disableTelemetry: false in the engine Package and apply it.
  • content/en/docs/v1.6/operations/configuration/telemetry.md#L103-L104: run Helm with cozystackOperator.disableTelemetry=false, then set cozystackController.disableTelemetry: false in the engine Package and apply it.
📍 Affects 3 files
  • content/en/docs/next/operations/configuration/telemetry.md#L102-L103 (this comment)
  • content/en/docs/v1.5/operations/configuration/telemetry.md#L103-L104
  • content/en/docs/v1.6/operations/configuration/telemetry.md#L103-L104
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@content/en/docs/next/operations/configuration/telemetry.md` around lines 102
- 103, Update the re-enable instructions in
content/en/docs/next/operations/configuration/telemetry.md:102-103 to explicitly
run Helm with cozystackOperator.disableTelemetry=false, then set
telemetry.disabled: false in the Platform Package and apply it. Apply the
corresponding update in
content/en/docs/v1.5/operations/configuration/telemetry.md:103-104 and
content/en/docs/v1.6/operations/configuration/telemetry.md:103-104, using
cozystackController.disableTelemetry: false in the engine Package and
instructing the operator to apply it.


## Conclusion

Expand Down
26 changes: 24 additions & 2 deletions content/en/docs/v1.5/operations/configuration/telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,11 @@ We respect your privacy and choice regarding telemetry. If you prefer not to par

Opting Out:

To disable telemetry reporting, upgrade the Cozystack operator Helm release with the `disableTelemetry` flag:
Telemetry is sent by the two components named above, and they are installed by
two different charts, so opting out takes two steps. Doing only the first
leaves `cozystack-controller` reporting application counts.

**1. The operator**, which is part of the `cozy-installer` release:

```bash
helm upgrade cozystack oci://ghcr.io/cozystack/cozystack/cozy-installer \
Expand All @@ -79,7 +83,25 @@ Replace `X.Y.Z` with your currently installed Cozystack version.

{{< reuse-values-warning >}}

This command updates the operator to disable telemetry data collection. If you wish to re-enable telemetry in the future, run the same command with `disableTelemetry=false`.
**2. The controller**, which the platform deploys. This version has no
platform-level key for it, so override the component's values directly on the
`cozystack.cozystack-engine` Package:

```yaml
apiVersion: cozystack.io/v1alpha1
kind: Package
metadata:
name: cozystack.cozystack-engine
spec:
components:
cozystack-controller:
values:
cozystackController:
disableTelemetry: true
```

To re-enable telemetry later, run the same command with
`disableTelemetry=false` and set `disableTelemetry: false` on the component.

## Conclusion

Expand Down
26 changes: 24 additions & 2 deletions content/en/docs/v1.6/operations/configuration/telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,11 @@ We respect your privacy and choice regarding telemetry. If you prefer not to par

Opting Out:

To disable telemetry reporting, upgrade the Cozystack operator Helm release with the `disableTelemetry` flag:
Telemetry is sent by the two components named above, and they are installed by
two different charts, so opting out takes two steps. Doing only the first
leaves `cozystack-controller` reporting application counts.

**1. The operator**, which is part of the `cozy-installer` release:

```bash
helm upgrade cozystack oci://ghcr.io/cozystack/cozystack/cozy-installer \
Expand All @@ -79,7 +83,25 @@ Replace `X.Y.Z` with your currently installed Cozystack version.

{{< reuse-values-warning >}}

This command updates the operator to disable telemetry data collection. If you wish to re-enable telemetry in the future, run the same command with `disableTelemetry=false`.
**2. The controller**, which the platform deploys. This version has no
platform-level key for it, so override the component's values directly on the
`cozystack.cozystack-engine` Package:

```yaml
apiVersion: cozystack.io/v1alpha1
kind: Package
metadata:
name: cozystack.cozystack-engine
spec:
components:
cozystack-controller:
values:
cozystackController:
disableTelemetry: true
```

To re-enable telemetry later, run the same command with
`disableTelemetry=false` and set `disableTelemetry: false` on the component.

## Conclusion

Expand Down
Loading