From 79a134f523e149c2eeb378e3fc838e662b6a7ad6 Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Tue, 15 Aug 2017 21:21:47 -0700 Subject: [PATCH] Add info about telemetry (#209) --- _data/toc.yaml | 2 ++ enterprise/telemetry.md | 52 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 enterprise/telemetry.md diff --git a/_data/toc.yaml b/_data/toc.yaml index fc86a10b2f..565228452e 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1292,6 +1292,8 @@ manuals: - path: /engine/installation/ title: Install Docker EE nosync: true + - path: /enterprise/telemetry/ + title: Manage usage data collection - path: /enterprise/release-notes/ title: Release Notes - path: /datacenter/install/linux/ diff --git a/enterprise/telemetry.md b/enterprise/telemetry.md new file mode 100644 index 0000000000..e241315268 --- /dev/null +++ b/enterprise/telemetry.md @@ -0,0 +1,52 @@ +--- +name: Manage usage data collection +description: Understand and manage usage data collected by Docker EE and sent to Docker. +keywords: enterprise, telemetry, data collection +--- + +Docker EE 17.06 and higher include a telemetry plugin which is enabled by +default on Ubuntu. This plugin sends Docker information about your running +system so that we can improve Docker EE. For details about the telemetry plugin +and the types of data it collects, see the +[`telemetry` plugin documentation](hhttps://store.docker.com/community/images/docker/telemetry). + +If your Docker instance runs in an environment with no internet connectivity, +the plugin does not collect or attempt to send any information to Docker. + +## Manage data collection + +If you do not wish to send any usage data to Docker, you can disable the plugin, +either using the Docker CLI or using Universal Control Plane. + +### Use the Docker CLI + +To disable the telemetry plugin, use the `docker plugin disable` command: + +```bash +$ docker plugin disable telemetry +``` + +This command needs to be run on each Docker host. + +To re-enable the telemetry plugin, you can use `docker plugin enable`. + +```bash +$ docker plugin enable telemetry +``` + +### Use Universal Control Plane + +If you use Universal Control Plane with Docker EE, do not use the Docker CLI to +disable the telemetry plugin. Instead, you can manage the information sent to +Docker by going to **Admin Settings** and choosing **Usage**. + +![UCP admin settings Usage defaults](images/usage-defaults.png) + +To disable the telemetry plugin, disable all three options and click **Save**. +Enabling either or both of the top two options will enable the telemetry plugin. +You can find out more about an individual option by clicking the **?** icon next +to it. + +> **Note**: If you enable gathering of API statistics, the payloads are not +> collected, but only information about which API endpoints you use. +