From a801942c301a033b5b7c642f1e71b0374abbfba5 Mon Sep 17 00:00:00 2001 From: Tom Leavitt Date: Wed, 4 Oct 2017 13:19:32 -0700 Subject: [PATCH 01/11] Add telemetry enable/disable guide this guide walks through installing, enabling, disabling and removing the telemetrics feature --- .../maintenance/Telemetry-Enable-Disable.rst | 106 ++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst diff --git a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst new file mode 100644 index 00000000..bdfa0116 --- /dev/null +++ b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst @@ -0,0 +1,106 @@ +.. _telemtry-enable-disable: + +Enable and Disable Telemetry in Clear Linux +########################################### + +|CLOSIA| includes a telemetry solution as part of the OS that records events +of interest and reports them back to the development team via the telemetrics +daemon, :command:`telemd`. This functionality is maintained in the +``telemetrics`` software bundle. + +.. Note:: + The telemetrics functionality adheres to `Intel’s privacy policies`_ + regarding the collection and use of Personally Identifiable Information + (PII) and is Open Source. Specifically, no intentionally identifiable + information about the user or system owner is collected. + +End users may enable or disable the telemetry component of |CL| or even +redirect where records go if they wish to collect records for themselves. + +Install the telemetry software bundle +************************************* + +During the initial installation of |CL| you are requested to join the +Stability Enhancement Program and allow |CLOSIA| to collect anonymous reports +to improve system stability. If you chose not to join this program at that +time then the telemetry software bundle was not added to your system. + +To install the telemetry bundle, enter the following command as either the +root user or with :command:`sudo` priveleges: + +.. code-block:: console + + sudo swupd bundle-add telemetrics + +This will add the telemetrics-client to your system and you will automatically +be opted-in for the service. + +Enable Telemetry +**************** + +To start telemetry on your system run the following command: + +.. code-block:: console + + sudo telemctl start + +This will enable and start the :command:`telemd` daemon and your system will +begin to send telemetry data to the server defined in the file +:file:`/etc/telemetrics/telemetrics.conf` and if this file does not exist it +will use the file :file:`/usr/share/defaults/telemetrics/telemetrics.conf`. + +Disable Telemetry +***************** + +To disable the telemetry daemon run the following command: + +.. code-block:: console + + sudo telemctl stop + +Opt-out of telemetry +******************** + +If you no longer want to send telemetrics data from your system, you can +opt-out of the service by running the command: + +.. code-block:: console + + sudo telemctl stop + sudo telemctl opt-out + +This will create the file :file:`/etc/telemetrics/opt-out` and stop the +telemetry services. + +Opt-in to telemetry +******************* + +Conversely, to opt-in to the telemetry services, simple enter the opt-in +command and start the service: + +.. code-block:: console + + sudo telemctl opt-in + sudo telemctl start + +This will remove the file :file:`/etc/telemetrics/opt-out` file if it exists. + +Remove the telemetry software bundle +************************************ + +To completely remove telemetrics from your system, use the command +:command:`swupd` to remove the telemetry software bundle: + +.. code-block:: console + + sudo swupd bundle-remove telemetrics + +Additional resources +******************** + +https://clearlinux.org/features/telemetry + +https://github.com/clearlinux/telemetrics-client + +.. _`Intel's privacy policies`: + http://www.intel.com/content/www/us/en/privacy/intel-privacy.html \ No newline at end of file From 2c9d2ef91a01c3c4be262818e56675eaba1aead3 Mon Sep 17 00:00:00 2001 From: Tom Leavitt Date: Wed, 4 Oct 2017 13:21:13 -0700 Subject: [PATCH 02/11] Add telemetry-enable-disable Add this entry to the toctree list --- source/clear-linux/guides/maintenance/maintenance.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/clear-linux/guides/maintenance/maintenance.rst b/source/clear-linux/guides/maintenance/maintenance.rst index 8d4f0c4b..bfd50c23 100644 --- a/source/clear-linux/guides/maintenance/maintenance.rst +++ b/source/clear-linux/guides/maintenance/maintenance.rst @@ -13,3 +13,4 @@ maintaining |CLOSIA| after :ref:`installation ` is completed. bulk-provision mixer validate-signatures + telemtry-enable-disable From 9f69cf69a604c72c8e361f3c9e1b46352f35bbea Mon Sep 17 00:00:00 2001 From: Tom Leavitt Date: Wed, 4 Oct 2017 13:25:20 -0700 Subject: [PATCH 03/11] typo fix fix mispelling telemetry --- source/clear-linux/guides/maintenance/maintenance.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/clear-linux/guides/maintenance/maintenance.rst b/source/clear-linux/guides/maintenance/maintenance.rst index bfd50c23..babf5335 100644 --- a/source/clear-linux/guides/maintenance/maintenance.rst +++ b/source/clear-linux/guides/maintenance/maintenance.rst @@ -13,4 +13,4 @@ maintaining |CLOSIA| after :ref:`installation ` is completed. bulk-provision mixer validate-signatures - telemtry-enable-disable + telemetry-enable-disable From 8f891366c09a8ef87464e0accbd9865ea3044961 Mon Sep 17 00:00:00 2001 From: Tom Leavitt Date: Wed, 4 Oct 2017 13:26:02 -0700 Subject: [PATCH 04/11] typo fix fix mispelling telemetry --- .../guides/maintenance/Telemetry-Enable-Disable.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst index bdfa0116..2a4214e8 100644 --- a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst +++ b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst @@ -1,4 +1,4 @@ -.. _telemtry-enable-disable: +.. _telemetry-enable-disable: Enable and Disable Telemetry in Clear Linux ########################################### @@ -103,4 +103,4 @@ https://clearlinux.org/features/telemetry https://github.com/clearlinux/telemetrics-client .. _`Intel's privacy policies`: - http://www.intel.com/content/www/us/en/privacy/intel-privacy.html \ No newline at end of file + http://www.intel.com/content/www/us/en/privacy/intel-privacy.html From eaa041fc782c69071f2b965e5378b9c454238b03 Mon Sep 17 00:00:00 2001 From: Tom Leavitt Date: Thu, 5 Oct 2017 09:03:28 -0700 Subject: [PATCH 05/11] requested updates to telemetry enable/disable several changes requested to clarify functionality and clean up document --- .../guides/maintenance/Telemetry-Enable-Disable.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst index 2a4214e8..bce8e532 100644 --- a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst +++ b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst @@ -61,13 +61,12 @@ To disable the telemetry daemon run the following command: Opt-out of telemetry ******************** -If you no longer want to send telemetrics data from your system, you can -opt-out of the service by running the command: +To stop sending telemetrics data from your system, opt out of the +telemetry service: .. code-block:: console sudo telemctl stop - sudo telemctl opt-out This will create the file :file:`/etc/telemetrics/opt-out` and stop the telemetry services. @@ -75,15 +74,15 @@ telemetry services. Opt-in to telemetry ******************* -Conversely, to opt-in to the telemetry services, simple enter the opt-in +Conversely, to opt-in to the telemetry services, simply enter the opt-in command and start the service: .. code-block:: console sudo telemctl opt-in - sudo telemctl start - -This will remove the file :file:`/etc/telemetrics/opt-out` file if it exists. + +This will remove the file :file:`/etc/telemetrics/opt-out` file if it exists +and start the telemetry services. Remove the telemetry software bundle ************************************ From fe07e66c25fbfe2569986879f50e5f237fdd00b4 Mon Sep 17 00:00:00 2001 From: Tom Leavitt Date: Thu, 5 Oct 2017 14:06:10 -0700 Subject: [PATCH 06/11] Add note to stop services after opt-in This adds a note to enable telemetry but delay starting the service. --- .../guides/maintenance/Telemetry-Enable-Disable.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst index bce8e532..5ad02325 100644 --- a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst +++ b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst @@ -84,6 +84,12 @@ command and start the service: This will remove the file :file:`/etc/telemetrics/opt-out` file if it exists and start the telemetry services. +.. Note:: + To opt-in but not immediately start telemetry services, you will need to + run the command :command:`sudo telemctl stop` after the :command:`opt-in` + command is entered. Once you are ready to start the service, enter the + command :command:`sudo telemctl start`. + Remove the telemetry software bundle ************************************ From 874f7d23fe9eb133793cb6751932f39ef808f745 Mon Sep 17 00:00:00 2001 From: Tom Leavitt Date: Thu, 5 Oct 2017 14:23:16 -0700 Subject: [PATCH 07/11] fix opt-out command removed the wrong line in the previous change. --- .../clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst index 5ad02325..d974444a 100644 --- a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst +++ b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst @@ -66,7 +66,7 @@ telemetry service: .. code-block:: console - sudo telemctl stop + sudo telemctl opt-out This will create the file :file:`/etc/telemetrics/opt-out` and stop the telemetry services. From d052919209cd6c2296eaad665508ce95aac31cae Mon Sep 17 00:00:00 2001 From: Tom Leavitt Date: Mon, 9 Oct 2017 13:52:29 -0700 Subject: [PATCH 08/11] cosmetic updates to the telemetry file changes to the telemetry-enable-disable file based on review from Rodrigo --- .../maintenance/Telemetry-Enable-Disable.rst | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst index d974444a..c9b566d2 100644 --- a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst +++ b/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst @@ -1,6 +1,6 @@ .. _telemetry-enable-disable: -Enable and Disable Telemetry in Clear Linux +Enable and disable telemetry in Clear Linux ########################################### |CLOSIA| includes a telemetry solution as part of the OS that records events @@ -8,20 +8,20 @@ of interest and reports them back to the development team via the telemetrics daemon, :command:`telemd`. This functionality is maintained in the ``telemetrics`` software bundle. -.. Note:: - The telemetrics functionality adheres to `Intel’s privacy policies`_ - regarding the collection and use of Personally Identifiable Information - (PII) and is Open Source. Specifically, no intentionally identifiable +.. note:: + The telemetry functionality adheres to `Intel’s privacy policies`_ + regarding the collection and use of :abbr:`PII (Personally Identifiable + Information)` and is open source. Specifically, no intentionally identifiable information about the user or system owner is collected. End users may enable or disable the telemetry component of |CL| or even -redirect where records go if they wish to collect records for themselves. +redirect where the records go if they wish to collect records for themselves. Install the telemetry software bundle ************************************* During the initial installation of |CL| you are requested to join the -Stability Enhancement Program and allow |CLOSIA| to collect anonymous reports +stability enhancement program and allow |CLOSIA| to collect anonymous reports to improve system stability. If you chose not to join this program at that time then the telemetry software bundle was not added to your system. @@ -46,7 +46,7 @@ To start telemetry on your system run the following command: This will enable and start the :command:`telemd` daemon and your system will begin to send telemetry data to the server defined in the file -:file:`/etc/telemetrics/telemetrics.conf` and if this file does not exist it +:file:`/etc/telemetrics/telemetrics.conf`. If this file does not exist it will use the file :file:`/usr/share/defaults/telemetrics/telemetrics.conf`. Disable Telemetry @@ -81,10 +81,10 @@ command and start the service: sudo telemctl opt-in -This will remove the file :file:`/etc/telemetrics/opt-out` file if it exists +This will remove the file :file:`/etc/telemetrics/opt-out` file, if it exists, and start the telemetry services. -.. Note:: +.. note:: To opt-in but not immediately start telemetry services, you will need to run the command :command:`sudo telemctl stop` after the :command:`opt-in` command is entered. Once you are ready to start the service, enter the From f94a44de0dbc41a9e28c836a1367f0a4c79d6627 Mon Sep 17 00:00:00 2001 From: Tom Leavitt Date: Wed, 18 Oct 2017 11:44:39 -0700 Subject: [PATCH 09/11] Update and rename Telemetry-Enable-Disable.rst to Telemetry-Enable.rst Change filename to telemetry-enable.rst and change label to match --- .../{Telemetry-Enable-Disable.rst => Telemetry-Enable.rst} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename source/clear-linux/guides/maintenance/{Telemetry-Enable-Disable.rst => Telemetry-Enable.rst} (96%) diff --git a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst b/source/clear-linux/guides/maintenance/Telemetry-Enable.rst similarity index 96% rename from source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst rename to source/clear-linux/guides/maintenance/Telemetry-Enable.rst index c9b566d2..acc3bf90 100644 --- a/source/clear-linux/guides/maintenance/Telemetry-Enable-Disable.rst +++ b/source/clear-linux/guides/maintenance/Telemetry-Enable.rst @@ -1,4 +1,4 @@ -.. _telemetry-enable-disable: +.. _telemetry-enable: Enable and disable telemetry in Clear Linux ########################################### From 8cb2f63a7318fac8dfa6ddce0ddeb831ea466f4e Mon Sep 17 00:00:00 2001 From: Tom Leavitt Date: Wed, 18 Oct 2017 11:45:52 -0700 Subject: [PATCH 10/11] change reference to telemetry-enable change reference of telemetry-enable to match filename and label --- source/clear-linux/guides/maintenance/maintenance.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/clear-linux/guides/maintenance/maintenance.rst b/source/clear-linux/guides/maintenance/maintenance.rst index babf5335..c919f846 100644 --- a/source/clear-linux/guides/maintenance/maintenance.rst +++ b/source/clear-linux/guides/maintenance/maintenance.rst @@ -13,4 +13,4 @@ maintaining |CLOSIA| after :ref:`installation ` is completed. bulk-provision mixer validate-signatures - telemetry-enable-disable + telemetry-enable From 3e20be0758bff6e6144f8621d0fd9457259a6543 Mon Sep 17 00:00:00 2001 From: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com> Date: Fri, 20 Oct 2017 12:02:33 -0700 Subject: [PATCH 11/11] Update telemetry-enable to present tense Update the voice to present tense and remove passive words Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com> --- .../guides/maintenance/Telemetry-Enable.rst | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/source/clear-linux/guides/maintenance/Telemetry-Enable.rst b/source/clear-linux/guides/maintenance/Telemetry-Enable.rst index acc3bf90..f5cbcfa2 100644 --- a/source/clear-linux/guides/maintenance/Telemetry-Enable.rst +++ b/source/clear-linux/guides/maintenance/Telemetry-Enable.rst @@ -5,14 +5,14 @@ Enable and disable telemetry in Clear Linux |CLOSIA| includes a telemetry solution as part of the OS that records events of interest and reports them back to the development team via the telemetrics -daemon, :command:`telemd`. This functionality is maintained in the +daemon, :command:`telemd`. This functionality is maintained in the ``telemetrics`` software bundle. .. note:: The telemetry functionality adheres to `Intel’s privacy policies`_ regarding the collection and use of :abbr:`PII (Personally Identifiable - Information)` and is open source. Specifically, no intentionally identifiable - information about the user or system owner is collected. + Information)` and is open source. Specifically, no intentionally + identifiable information about the user or system owner is collected. End users may enable or disable the telemetry component of |CL| or even redirect where the records go if they wish to collect records for themselves. @@ -22,8 +22,8 @@ Install the telemetry software bundle During the initial installation of |CL| you are requested to join the stability enhancement program and allow |CLOSIA| to collect anonymous reports -to improve system stability. If you chose not to join this program at that -time then the telemetry software bundle was not added to your system. +to improve system stability. If you chose not to join this program at that +time then the telemetry software bundle is not added to your system. To install the telemetry bundle, enter the following command as either the root user or with :command:`sudo` priveleges: @@ -32,8 +32,8 @@ root user or with :command:`sudo` priveleges: sudo swupd bundle-add telemetrics -This will add the telemetrics-client to your system and you will automatically -be opted-in for the service. +This adds the telemetrics-client to your system and you will automatically +opt-in for the service. Enable Telemetry **************** @@ -44,10 +44,11 @@ To start telemetry on your system run the following command: sudo telemctl start -This will enable and start the :command:`telemd` daemon and your system will +This enables and starts the :command:`telemd` daemon and your system will begin to send telemetry data to the server defined in the file -:file:`/etc/telemetrics/telemetrics.conf`. If this file does not exist it -will use the file :file:`/usr/share/defaults/telemetrics/telemetrics.conf`. +:file:`/etc/telemetrics/telemetrics.conf`. If this file does not exist, the +:command:`telemd` daemon will use the file +:file:`/usr/share/defaults/telemetrics/telemetrics.conf`. Disable Telemetry ***************** @@ -68,7 +69,7 @@ telemetry service: sudo telemctl opt-out -This will create the file :file:`/etc/telemetrics/opt-out` and stop the +This creates the file :file:`/etc/telemetrics/opt-out` and stops the telemetry services. Opt-in to telemetry @@ -81,13 +82,13 @@ command and start the service: sudo telemctl opt-in -This will remove the file :file:`/etc/telemetrics/opt-out` file, if it exists, -and start the telemetry services. +This removes the file :file:`/etc/telemetrics/opt-out` file, if it exists, +and starts the telemetry services. .. note:: To opt-in but not immediately start telemetry services, you will need to run the command :command:`sudo telemctl stop` after the :command:`opt-in` - command is entered. Once you are ready to start the service, enter the + command is entered. Once you are ready to start the service, enter the command :command:`sudo telemctl start`. Remove the telemetry software bundle