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.

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

Update privacy.md #277

Merged
merged 6 commits into from
Oct 16, 2018
Merged

Update privacy.md #277

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9badd4a
Update privacy.md
marcparadise Oct 15, 2018
e50a187
Copy & format edits
Oct 15, 2018
067974b
Commit with content --signoff
Oct 15, 2018
fc028ce
Responds to feedback
Oct 15, 2018
9611b87
fixes chef-run
Oct 15, 2018
58fbf0c
Fixes em dashes
Oct 15, 2018
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
43 changes: 36 additions & 7 deletions www/site/content/docs/chef-workstation/privacy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,55 @@ title = "Privacy and Telemetry"

## Chef Workstation Telemetry

Chef Workstation collects information to help us identify bugs and how users are interacting with Chef Workstation to help us make continuous improvements.
Chef Workstation collects information to help us identify bugs and how users
Copy link

Choose a reason for hiding this comment

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

id really rather say people instead of users here

are interacting with Chef Workstation to help us make continuous improvements.

We capture:

* A unique installation-id that is not connected to any customer data. This helps us track
the number of active Chef Workstation installations without needing to perform
IP-based tracking.
* The Chef-specific commands you execute, **without** any of the arguments you pass.
* How you connect, either WinRM or SSH.
* Your host operating system and version.
* A SHA256 sum of any hostname that you're connecting to via `chef-run`.
* How you connect to a remote host via `chef-run`, either WinRM or SSH.
* Target operating system of any hosts connected to via `chef-run`.

## See Your Data
## Usage of Your Data

You can view the analytics we collect before it is sent. Find--and remove--your data in the `HOME/.chef-workstation/telemetry/` folder. We save the data from a current chef-run in the telemetry folder and collect it at the start of the next chef-run.
We use this data to track Chef Workstation usage patterns, identify bugs, and
iterate development based on the aggregate feedback it providesa

Only Chef Software, Inc employees have access to your data. We will never sell, re-sell, or use your data in a malicious manner.
Only Chef Software, Inc employees have access to your data. We will never sell,
re-sell, or use your data in a malicious manner.

## Opting out

* To stop the capture of telemetry data from a single session, set the environment variable CHEF_TELEMETRY_OPT_OUT to any value before running chef-run.
* Disable telemetry entirely by adding the following to `$HOME/.chef-workstation/config.toml`:
* To stop the capture of telemetry data from a single session, set the
environment variable `CHEF_TELEMETRY_OPT_OUT` to any value before running
chef-run, for example:
```
CHEF_TELEMETRY_OPT_OUT=1 chef-run -h
```
* Disable telemetry entirely by adding the following to
`$HOME/.chef-workstation/config.toml`:

```bash
[telemetry]
enabled=false
```

### What telemetry data does Chef Workstation Capture?

* The Chef specific commands you execute (we do not capture any arguments)
* Connection method (WinRM or SSH)
* Host and Target operating system and version

## See Your Data

You can view the analytics we collect before it is sent. Find--and remove--your
Copy link

Choose a reason for hiding this comment

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

can we use — for the em dashes?

Copy link

Choose a reason for hiding this comment

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

It appears not, but it is worth further investigation.

Copy link

Choose a reason for hiding this comment

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

It does work(after all) but it also makes the markdown difficult to read with no benefit other than using the nice long em-dash. It is the way I like it, but I need to confer with the docs-team.

data in the `HOME/.chef-workstation/telemetry/` folder. We save the data from a
current chef-run in the telemetry folder and collect it at the start of the
next chef-run.
Copy link

Choose a reason for hiding this comment

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

should this be `chef-run`?


When telemetry is disabled, previously collected analytics will not be sent.