Skip to content

Commit 1d029f0

Browse files
authored
Merge pull request #27692 from pneedle-rh/remote_health_updates
Updates to the Remote Health section.
2 parents 8153b93 + 28f4c64 commit 1d029f0

9 files changed

+124
-39
lines changed

images/telmetry-and-insights-operator-data-flow.svg

Lines changed: 1 addition & 0 deletions
Loading

modules/insights-operator-about.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,10 @@ The Insights Operator periodically gathers configuration and component failure s
99

1010
Users of {product-title} can display the report of each cluster in {cloud-redhat-com}. If any issues have been identified, Insights provides further details and, if available, steps on how to solve a problem.
1111

12-
The Insights Operator does not collect identifying information, such as user names, passwords, or certificates. However, to provide specific remediation steps, the Insights Operator does not anonymize certain information internal to the cluster, such as IP addresses and host names of nodes.
12+
The Insights Operator does not collect identifying information, such as user names, passwords, or certificates. See link:https://cloud.redhat.com/security/insights[Red Hat Insights Data & Application Security] for information about Red Hat Insights data collection and controls.
1313

1414
Red Hat uses all connected cluster information to:
1515

1616
* Proactively identify potential cluster issues and provide a solution and preventive actions in {cloud-redhat-com}
17-
* Improve {product-title}
17+
* Improve {product-title} by providing aggregated and critical information to product and support teams
1818
* Make {product-title} more intuitive
19-
20-
The information the Insights Operator sends is available only to Red Hat Support and engineering teams with the same restrictions as accessing data reported in support cases. Red Hat does not share this information with third parties.

modules/insights-operator-what-information-is-collected.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@
55
[id="insights-operator-what-information-is-collected_{context}"]
66
= Information collected by the Insights Operator
77

8-
The Insights Operator collects:
8+
The following information is collected by the Insights Operator:
99

1010
* General information about your cluster and its components to identify issues that are specific to your {product-title} version and environment
1111
* Configuration files, such as the image registry configuration, of your cluster to determine incorrect settings and issues that are specific to parameters you set
12-
* Error that occurred in the cluster components
13-
* Progress and health information of running updates, and the status of any component upgrades
12+
* Errors that occur in the cluster components
13+
* Progress information of running updates, and the status of any component upgrades
1414
* Details of the platform that {product-title} is deployed on, such as Amazon Web Services, and the region that the cluster is located in
15-
* Information about infrastructure pods
15+
* If an Operator reports an issue, information is collected about core {product-title} pods in the `openshift-*` and `kube-*` projects. This includes state, resource, security context, volume information, and more.
16+

modules/telemetry-about-telemetry.adoc

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,8 @@
66
[id="telemetry-about-telemetry_{context}"]
77
= About Telemetry
88

9-
Telemetry sends a carefully chosen subset of the cluster monitoring metrics to Red Hat. These metrics are sent continuously and describe:
9+
Telemetry sends a carefully chosen subset of the cluster monitoring metrics to Red Hat. The Telemeter Client fetches the metrics values every four minutes and thirty seconds and uploads the data to Red Hat. These metrics are described in this document.
1010

11-
* The size of an {product-title} cluster
12-
* The health and status of {product-title} components
13-
* The health and status of any upgrade being performed
14-
* Limited usage information about {product-title} components and features
15-
* Summary info about alerts reported by the cluster monitoring component
11+
This stream of data is used by Red Hat to monitor the clusters in real-time and to react as necessary to problems that impact our customers. It also allows Red Hat to roll out {product-title} upgrades to customers to minimize service impact and continuously improve the upgrade experience.
1612

17-
This continuous stream of data is used by Red Hat to monitor the health of clusters in real time and to react as necessary to problems that impact our customers. It also allows Red Hat to roll out {product-title} upgrades to customers so as to minimize service impact and continuously improve the upgrade experience.
18-
19-
This debugging information is available to Red Hat Support and engineering teams with the same restrictions as accessing data reported via support cases. All connected cluster information is used by Red Hat to help make {product-title} better and more intuitive to use. None of the information is shared with third parties.
13+
This debugging information is available to Red Hat Support and Engineering teams with the same restrictions as accessing data reported through support cases. All connected cluster information is used by Red Hat to help make {product-title} better and more intuitive to use.

modules/telemetry-consequences-of-disabling-telemetry.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
[id="telemetry-consequences-of-disabling-telemetry_{context}"]
66
= Consequences of disabling remote health reporting
77

8-
In {product-title}, customers can opt out of reporting health and usage information. However, connected clusters allow Red Hat to react more quickly to problems and better support our customers, as well as better understand how product upgrades impact clusters.
8+
In {product-title}, customers can opt out of reporting usage information. However, connected clusters allow Red Hat to react more quickly to problems and better support our customers, as well as better understand how product upgrades impact clusters. Connected clusters also help to simplify the subscription and entitlement process and enable the {cloud-redhat-com} service to provide an overview of your clusters and their subscription status.
99

1010
Red Hat strongly recommends leaving health and usage reporting enabled for pre-production and test clusters even if it is necessary to opt out for production clusters. This allows Red Hat to be a participant in qualifying {product-title} in your environments and react more rapidly to product issues.
1111

1212
Some of the consequences of opting out of having a connected cluster are:
1313

1414
* Red Hat will not be able to monitor the success of product upgrades or the health of your clusters without a support case being opened.
15-
* Red Hat will not be able to use anonymized configuration data to better triage customer support cases and identify which configurations our customers find important.
15+
* Red Hat will not be able to use configuration data to better triage customer support cases and identify which configurations our customers find important.
1616
* The {cloud-redhat-com} will not show data about your clusters including health and usage information.
1717
ifndef::openshift-origin[]
1818
* Your subscription entitlement information must be manually entered via cloud.redhat.com without the benefit of automatic usage reporting.

modules/telemetry-what-information-is-collected.adoc

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,26 @@ endif::[]
1010
[id="what-information-is-collected_{context}"]
1111
= Information collected by Telemetry
1212

13-
Primary information collected by Telemetry includes:
13+
The following information is collected by Telemetry:
1414

15-
* The number of updates available per cluster
16-
* Channel and image repository used for an update
17-
* The number of errors that occurred during an update
18-
* Progress information of running updates
19-
* The number of machines per cluster
20-
* The number of CPU cores and size of RAM of the machines
21-
* The number of members in the etcd cluster and number of objects currently stored in the etcd cluster
22-
* The number of CPU cores and RAM used per machine type - infra or master
23-
* The number of CPU cores and RAM used per cluster
15+
* The unique random identifier that is generated during an installation
16+
* Version information, including the {product-title} cluster version and installed update details that are used to determine update version availability
17+
* Update information, including the number of updates available per cluster, the channel and image repository used for an update, update progress information, and the number of errors that occur in an update
18+
* The name of the provider platform that {product-title} is deployed on and the data center location
19+
* Sizing information about clusters, machine types, and machines, including the number of CPU cores and the amount of RAM used for each
2420
ifdef::virt-cluster[]
25-
* The number of running virtual machine instances in the cluster
21+
* The number of running virtual machine instances in a cluster
2622
endif::virt-cluster[]
27-
* Use of {product-title} framework components per cluster
28-
* The version of the {product-title} cluster
29-
* Health, condition, and status for any {product-title} framework component that is installed on the cluster, for example Cluster Version Operator, Cluster Monitoring, Image Registry, and Elasticsearch for Logging
30-
* A unique random identifier that is generated during installation
31-
* The name of the platform that {product-title} is deployed on, such as Amazon Web Services
23+
* The number of etcd members and the number of objects stored in the etcd cluster
24+
* The {product-title} framework components installed in a cluster and their condition and status
25+
* Usage information about components, features, and extensions
26+
* Usage details about Technology Previews and unsupported configurations
27+
* Information about degraded software and nodes marked as `NotReady`
28+
* Events for all namespaces listed as "related objects" for a degraded Operator
29+
* Configuration details that help Red Hat Support to provide beneficial support for customers. This includes node configuration at the cloud infrastructure level, host names, IP addresses, Kubernetes pod names, namespaces, and services.
30+
* Information about the validity of certificates
3231

33-
Telemetry does not collect identifying information such as user names, passwords, or the names or addresses of user resources.
32+
Telemetry does not collect identifying information such as user names, or passwords. Red Hat does not intend to collect personal information. If Red Hat discovers that personal information has been inadvertently received, Red Hat will delete such information. To the extent that any telemetry data constitutes personal data, please refer to the link:https://www.redhat.com/en/about/privacy-policy[Red Hat Privacy Statement] for more information about Red Hat’s privacy practices.
3433

3534
ifeval::["{context}" == "virt-openshift-cluster-monitoring"]
3635
:!virt-cluster:
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * support/remote_health_monitoring/about-remote-health-monitoring.adoc
4+
5+
[id="understanding-telemetry-and-insights-operator-data-flow_{context}"]
6+
= Understanding Telemetry and Insights Operator data flow
7+
8+
The Telemeter Client collects selected time series data from the Prometheus API. The time series data is uploaded to api.openshift.com every four minutes and thirty seconds for processing.
9+
10+
The Insights Operator gathers selected data from the Kubernetes API and the Prometheus API into an archive. The archive is uploaded to link:https://cloud.redhat.com[cloud.redhat.com] every two hours for processing. The Insights Operator also downloads the latest Insights analysis from link:https://cloud.redhat.com[cloud.redhat.com]. This is used to populate the *Insights status* pop-up that is included in the *Overview* page in the {product-title} web console.
11+
12+
All of the communication with Red Hat occurs over encrypted channels by using Transport Layer Security (TLS) and mutual certificate authentication. All of the data is encrypted in transit and at rest.
13+
14+
Access to the systems that handle customer data is controlled through multi-factor authentication and strict authorization controls. Access is granted on a need-to-know basis and is limited to required operations.
15+
16+
.Telemetry and Insights Operator data flow
17+
image:telmetry-and-insights-operator-data-flow.svg[Telemetry and Insights Operator data flow]

0 commit comments

Comments
 (0)