Skip to content
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.

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

Add flag to opt out of product telemetry #1605

Merged
merged 4 commits into from
Feb 22, 2024

Conversation

sjberman
Copy link
Contributor

Problem: As a user of NGF
I want an easy option to opt out of recording and sending of all telemetry data So that if I am not comfortable sending that information, I can still continue to use NGF

Solution: Added a new configurable flag that can disable telemetry. On by default. Also turns off any RBAC if not needed (for N+ usage or telemetry)

Testing: Verified RBAC permissions are set properly when telemetry is on/off or nginx plus is on/off.

Closes #1317

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

NONE

@sjberman sjberman requested review from a team as code owners February 21, 2024 20:09
@github-actions github-actions bot added documentation Improvements or additions to documentation chore Pull requests for routine tasks helm-chart Relates to helm chart labels Feb 21, 2024
@brianehlert
Copy link

FYI - license telemetry cannot be opted out of when N+, that is not an option.

@sjberman
Copy link
Contributor Author

@brianehlert Yes, this is just for XCDF.

Copy link
Contributor

@salonichf5 salonichf5 left a comment

Choose a reason for hiding this comment

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

looks good to me, just had some questions for my knowledge

deploy/helm-chart/README.md Show resolved Hide resolved
deploy/helm-chart/templates/deployment.yaml Show resolved Hide resolved
cmd/gateway/commands.go Outdated Show resolved Hide resolved
deploy/helm-chart/templates/rbac.yaml Outdated Show resolved Hide resolved
deploy/helm-chart/values.yaml Show resolved Hide resolved
deploy/helm-chart/README.md Show resolved Hide resolved
cmd/gateway/commands.go Outdated Show resolved Hide resolved
Problem: As a user of NGF
I want an easy option to opt out of recording and sending of all telemetry data
So that if I am not comfortable sending that information, I can still continue to use NGF

Solution: Added a new configurable flag that can disable telemetry. On by default. Also turns off any RBAC if not needed (for N+ usage or telemetry)
cmd/gateway/commands.go Outdated Show resolved Hide resolved
Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

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

🚀

@sjberman sjberman enabled auto-merge (squash) February 22, 2024 15:09
@sjberman sjberman merged commit 1dbe45a into nginxinc:main Feb 22, 2024
34 checks passed
@sjberman sjberman deleted the chore/telemetry-opt-out branch February 22, 2024 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks documentation Improvements or additions to documentation helm-chart Relates to helm chart
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Mechanism to Opt Out of all Telemetry
6 participants