mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-660: Adding docs for insights operator
This commit is contained in:
committed by
openshift-cherrypick-robot
parent
6d4d84e68a
commit
7d0d760c60
@@ -926,17 +926,6 @@ Topics:
|
||||
- Name: Troubleshooting and debugging
|
||||
File: metering-troubleshooting-debugging
|
||||
---
|
||||
Name: Telemetry
|
||||
Dir: telemetry
|
||||
Distros: openshift-enterprise,openshift-origin
|
||||
Topics:
|
||||
- Name: About Telemetry
|
||||
File: about-telemetry
|
||||
- Name: Showing data collected by Telemetry
|
||||
File: showing-data-collected-by-telemetry
|
||||
- Name: Opting out of Telemetry
|
||||
File: opting-out-of-telemetry
|
||||
---
|
||||
Name: Scalability and performance
|
||||
Dir: scalability_and_performance
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
@@ -1225,3 +1214,13 @@ Topics:
|
||||
- Name: Gathering data about your cluster
|
||||
File: gathering-cluster-data
|
||||
Distros: openshift-enterprise,openshift-dedicated
|
||||
- Name: Remote health monitoring with connected clusters
|
||||
Dir: remote_health_monitoring
|
||||
Distros: openshift-enterprise,openshift-dedicated
|
||||
Topics:
|
||||
- Name: About remote health monitoring
|
||||
File: about-remote-health-monitoring
|
||||
- Name: Showing data collected by remote health monitoring
|
||||
File: showing-data-collected-by-remote-health-monitoring
|
||||
- Name: Opting out of remote health reporting
|
||||
File: opting-out-of-remote-health-reporting
|
||||
|
||||
@@ -58,4 +58,4 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -46,4 +46,4 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -72,4 +72,4 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -117,4 +117,4 @@ include::modules/installation-aws-user-infra-installation.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -43,4 +43,4 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -33,4 +33,4 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -84,4 +84,4 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -44,4 +44,4 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -34,4 +34,4 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -39,4 +39,4 @@ include::modules/installation-osp-configuring-floating-ip.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -41,4 +41,4 @@ include::modules/installation-osp-configuring-floating-ip.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -35,4 +35,4 @@ include::modules/installation-osp-configuring-floating-ip.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -134,4 +134,4 @@ include::modules/installation-aws-user-infra-installation.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -93,4 +93,4 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -78,4 +78,4 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -69,4 +69,4 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
28
modules/images-update-global-pull-secret.adoc
Normal file
28
modules/images-update-global-pull-secret.adoc
Normal file
@@ -0,0 +1,28 @@
|
||||
// Module included in the following assemblies:
|
||||
// * openshift_images/using-image-pull-secrets
|
||||
|
||||
[id="images-update-global-pull-secret_{context}"]
|
||||
= Updating the global cluster pull secret
|
||||
|
||||
You can update the global pull secret for your cluster.
|
||||
|
||||
[WARNING]
|
||||
====
|
||||
Cluster resources must adjust to the new pull secret, which can temporarily limit the usability of the cluster.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have a new or modified pull secret file to upload.
|
||||
* You have access to the cluster as a user with the `cluster-admin` role.
|
||||
|
||||
.Procedure
|
||||
|
||||
* Run the following command to update the global pull secret for your cluster:
|
||||
+
|
||||
----
|
||||
$ oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson=<pull-secret-location> <1>
|
||||
----
|
||||
<1> Provide the path to the new pull secret file.
|
||||
|
||||
This update is rolled out to all nodes, which can take some time depending on the size of your cluster. During this time, nodes are drained and Pods are rescheduled on the remaining nodes.
|
||||
24
modules/insights-operator-about.adoc
Normal file
24
modules/insights-operator-about.adoc
Normal file
@@ -0,0 +1,24 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * support/remote_health_monitoring/about-remote-health-monitoring.adoc
|
||||
|
||||
[id="insights-operator-about_{context}"]
|
||||
= About the Insights Operator
|
||||
|
||||
// The Insights Operator collects anonymized information about:
|
||||
//
|
||||
// * The version of the {product-title} cluster and its components
|
||||
// * The health, status, and current errors that are reported by {product-title} components and nodes
|
||||
// * The network topology
|
||||
// * Additional product features in use, such as Service Mesh or Serverless
|
||||
//
|
||||
// This information is reported to Red Hat Insights and is used by Red Hat to provide better support for the {product-title} cluster. None of the information is shared with third parties.
|
||||
|
||||
|
||||
The Insights Operator periodically gathers anonymized configuration and component failure status and reports that to Red Hat. This is a subset of the information captured by the `must-gather` tool and allows Red Hat to assess important configuration and deeper failure data than is reported via Telemetry. This data is sent several times a day and describes:
|
||||
|
||||
* Important configuration information about the environment that the cluster runs in
|
||||
* Details about the state of the cluster and its major components
|
||||
* Debugging information about infrastructure Pods or nodes that are reporting failures
|
||||
|
||||
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.
|
||||
33
modules/insights-operator-new-pull-secret-disabled.adoc
Normal file
33
modules/insights-operator-new-pull-secret-disabled.adoc
Normal file
@@ -0,0 +1,33 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * support/insights-operator/disabling-insights-operator.adoc
|
||||
|
||||
[id="insights-operator-new-pull-secret_{context}"]
|
||||
= Modifying the global cluster pull secret to disable remote health reporting
|
||||
|
||||
You can modify your existing global cluster pull secret to disable remote health reporting. This disables both Telemetry and the Insights Operator.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have access to the cluster as a user with the `cluster-admin` role.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Download the global cluster pull secret to your local file system.
|
||||
+
|
||||
----
|
||||
$ oc extract secret/pull-secret -n openshift-config --to=.
|
||||
----
|
||||
|
||||
. In a text editor, edit the `.dockerconfigjson` file that was downloaded.
|
||||
|
||||
. Remove the `cloud.openshift.com` JSON entry, for example:
|
||||
+
|
||||
[source,json]
|
||||
----
|
||||
"cloud.openshift.com":{"auth":"<hash>","email":"<email_address>"}
|
||||
----
|
||||
|
||||
. Save the file.
|
||||
|
||||
You can now update your cluster to use this modified pull secret.
|
||||
@@ -0,0 +1,28 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * support/remote_health_monitoring/showing-data-collected-by-remote-health-reporting.adoc
|
||||
|
||||
[id="insights-operator-showing-data-collected-from-the-cluster_{context}"]
|
||||
= Showing data collected by the Insights Operator
|
||||
|
||||
You can review the data that is collected by the Insights Operator.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Access to the cluster as a user with the `cluster-admin` role.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Find the name of the currently running Pod for the Insights Operator:
|
||||
+
|
||||
----
|
||||
$ INSIGHTS_OPERATOR_POD=$(oc get pods --namespace=openshift-insights -o custom-columns=:metadata.name --no-headers --field-selector=status.phase=Running)
|
||||
----
|
||||
|
||||
. Copy the recent data archives collected by the Insights Operator:
|
||||
+
|
||||
----
|
||||
$ oc cp openshift-insights/$INSIGHTS_OPERATOR_POD:/var/lib/insights-operator ./insights-data
|
||||
----
|
||||
|
||||
The recent Insights Operator archives are now available in the `insights-data` directory.
|
||||
20
modules/insights-operator-what-information-is-collected.adoc
Normal file
20
modules/insights-operator-what-information-is-collected.adoc
Normal file
@@ -0,0 +1,20 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * support/remote_health_monitoring/about-remote-health-monitoring.adoc
|
||||
|
||||
[id="insights-operator-what-information-is-collected_{context}"]
|
||||
= Information collected by the Insights Operator
|
||||
|
||||
Primary information collected by the Insights Operator includes:
|
||||
|
||||
* The version of the cluster and its components, as well as the unique cluster identifier
|
||||
* Channel and image repository used for an update
|
||||
* Details about errors that have occurred in the cluster components
|
||||
* Progress and health information of running updates and the status of any component upgrades
|
||||
* Anonymized details about the cluster configuration that is relevant to Red Hat Support
|
||||
* Details about any Technology Preview or unsupported configurations that might impact Red Hat Support
|
||||
* Details of the platform that {product-title} is deployed on, such as Amazon Web Services, and the region that the cluster is located in
|
||||
* Information about Pods of degraded {product-title} cluster Operators
|
||||
* Information about nodes marked as `NotReady`
|
||||
|
||||
The Insights Operator does not collect identifying information such as user names, passwords, or the names or addresses of user resources.
|
||||
@@ -1,28 +1,19 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * telemetry/about-telemetry.adoc
|
||||
// * support/remote_health_monitoring/about-remote-health-monitoring.adoc
|
||||
// * cnv/cnv_users_guide/cnv-openshift-cluster-monitoring.adoc
|
||||
//
|
||||
// This module uses a conditionalized title so that the module
|
||||
// can be re-used in associated products but the title is not
|
||||
// included in the existing OpenShift assembly.
|
||||
|
||||
[id="telemetry-about-telemetry_{context}"]
|
||||
ifeval::["{context}" == "about-telemetry"]
|
||||
:ocp-telemetry:
|
||||
endif::[]
|
||||
|
||||
ifndef::ocp-telemetry[]
|
||||
= About Telemetry
|
||||
endif::ocp-telemetry[]
|
||||
:ocp-telemetry!:
|
||||
|
||||
Telemetry collects anonymized aggregated information about:
|
||||
Telemetry sends a carefully chosen subset of the cluster monitoring metrics to Red Hat. These metrics are sent continuously and describe:
|
||||
|
||||
* The size of an {product-title} cluster
|
||||
* The health and status of {product-title} components
|
||||
* Use of {product-title} components
|
||||
* The features in use
|
||||
* The health and status of any upgrade being performed
|
||||
* Limited usage information about {product-title} components and features
|
||||
* Summary info about alerts reported by the cluster monitoring component
|
||||
|
||||
This 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.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
@@ -1,17 +1,19 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// telemetry/opting-out-of-telemetry.adoc
|
||||
// support/remote_health_monitoring/opting-out-of-telemetry.adoc
|
||||
|
||||
[id="telemetry-consequences-of-disabling-telemetry_{context}"]
|
||||
= Consequences of disabling Telemetry
|
||||
= Consequences of disabling remote health reporting
|
||||
|
||||
In {product-title} {product-version}, customers can opt out of the Telemetry service. However, Telemetry is embedded as a core component and serves as part of the overall function of the cluster. Therefore, opting out is strongly discouraged.
|
||||
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.
|
||||
|
||||
Some of the consequences of opting out of Telemetry are:
|
||||
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.
|
||||
|
||||
* The Red Hat OpenShift Cluster Manager does not work as expected and does not show critical information about your clusters.
|
||||
* You cannot perform subscription management, including legally entitling your purchase from Red Hat through `cloud.redhat.com`. Because there is no disconnected subscription management, you cannot both opt out of sending data to Red Hat and entitle your purchase.
|
||||
* You will not gain quality assurance by reporting faults encountered during upgrades.
|
||||
* You cannot entitle your cluster.
|
||||
Some of the consequences of opting out of having a connected cluster are:
|
||||
|
||||
Deployment and management of {product-title} for restricted networks is a critical goal and will be delivered in a future version of {product-title}.
|
||||
* 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.
|
||||
* 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.
|
||||
* The Red Hat OpenShift Cluster Manager will not show data about your clusters including health and usage information.
|
||||
* Your subscription entitlement information must be manually entered via cloud.redhat.com without the benefit of automatic usage reporting.
|
||||
|
||||
In restricted networks, Telemetry and Insights data can still be reported through appropriate configuration of your proxy.
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * telemetry/opting-out-of-telemetry.adoc
|
||||
|
||||
[id="disabling-telemetry_{context}"]
|
||||
= Disabling Telemetry
|
||||
|
||||
You can disable Telemetry.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Start editing the `cluster-monitoring-config` ConfigMap:
|
||||
+
|
||||
----
|
||||
$ oc -n openshift-monitoring edit configmap cluster-monitoring-config
|
||||
----
|
||||
|
||||
. Add the two lines that are required to disable Telemetry to the `data/config.yaml` section, as shown:
|
||||
+
|
||||
[source,yaml,subs=quotes]
|
||||
----
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: cluster-monitoring-config
|
||||
namespace: openshift-monitoring
|
||||
data:
|
||||
config.yaml: |+
|
||||
*telemeterClient:*
|
||||
*enabled: false*
|
||||
----
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * telemetry/showing-data-collected-by-telemetry.adoc
|
||||
// * support/remote_health_monitoring/showing-data-collected-by-remote-health-reporting.adoc
|
||||
|
||||
[id="showing-data-collected-from-the-cluster_{context}"]
|
||||
= Showing data collected from the cluster
|
||||
= Showing data collected by Telemetry
|
||||
|
||||
You can see the cluster and components time series data captured by Telemetry.
|
||||
|
||||
@@ -27,4 +27,3 @@ $ oc get route prometheus-k8s -n openshift-monitoring -o jsonpath="{.spec.host}"
|
||||
{__name__="up"} or {__name__="cluster_version"} or {__name__="cluster_version_available_updates"} or {__name__="cluster_operator_up"} or {__name__="cluster_operator_conditions"} or {__name__="cluster_version_payload"} or {__name__="cluster_version_payload_errors"} or {__name__="instance:etcd_object_counts:sum"} or {__name__="ALERTS",alertstate="firing"} or {__name__="code:apiserver_request_count:rate:sum"} or {__name__="kube_pod_status_ready:etcd:sum"} or {__name__="kube_pod_status_ready:image_registry:sum"} or {__name__="cluster:capacity_cpu_cores:sum"} or {__name__="cluster:capacity_memory_bytes:sum"} or {__name__="cluster:cpu_usage_cores:sum"} or {__name__="cluster:memory_usage_bytes:sum"} or {__name__="openshift:cpu_usage_cores:sum"} or {__name__="openshift:memory_usage_bytes:sum"} or {__name__="cluster:node_instance_type_count:sum"}
|
||||
+
|
||||
This query replicates the request that Telemetry makes against a running {product-title} cluster's Prometheus service and returns the full set of time series captured by Telemetry.
|
||||
|
||||
|
||||
@@ -1,34 +1,33 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * telemetry/about-telemetry.adoc
|
||||
// * cnv/cnv_users_guide/cnv-openshift-cluster-monitoring.adoc
|
||||
// * support/remote_health_monitoring/about-remote-health-monitoring.adoc
|
||||
// * cnv/cnv_users_guide/cnv-openshift-cluster-monitoring.adoc
|
||||
|
||||
ifeval::["{context}" == "cnv-openshift-cluster-monitoring"]
|
||||
:cnv-cluster:
|
||||
endif::[]
|
||||
|
||||
[id="what-information-is-collected_{context}"]
|
||||
= What information is collected
|
||||
= Information collected by Telemetry
|
||||
|
||||
Telemetry does not collect, and will never collect, identifying information like user names, passwords, or the names or addresses of user resources.
|
||||
Primary information collected by Telemetry includes:
|
||||
|
||||
Primary information collected includes:
|
||||
|
||||
* Number of updates available per cluster
|
||||
* The number of updates available per cluster
|
||||
* Channel and image repository used for an update
|
||||
* Number of errors that occurred during an update
|
||||
* Progress information of an update that is running
|
||||
* Number of machines per cluster
|
||||
* Number of CPU cores and size of RAM of the machines
|
||||
* Number of members in the etcd cluster and number of objects currently stored in the etcd cluster
|
||||
* Number of CPU cores and RAM used per machine type - infra or master
|
||||
* Number of CPU cores and RAM used per cluster
|
||||
//ifdef::cnv-cluster[]
|
||||
//* Number of running virtual machine instances in the cluster
|
||||
//endif::cnv-cluster[]
|
||||
* The number of errors that occurred during an update
|
||||
* Progress information of running updates
|
||||
* The number of machines per cluster
|
||||
* The number of CPU cores and size of RAM of the machines
|
||||
* The number of members in the etcd cluster and number of objects currently stored in the etcd cluster
|
||||
* The number of CPU cores and RAM used per machine type - infra or master
|
||||
* The number of CPU cores and RAM used per cluster
|
||||
// ifdef::cnv-cluster[]
|
||||
// * The number of running virtual machine instances in the cluster
|
||||
// endif::cnv-cluster[]
|
||||
* Use of {product-title} framework components per cluster
|
||||
* Version of the {product-title} cluster
|
||||
* The version of the {product-title} cluster
|
||||
* 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
|
||||
* A unique random identifier that is generated during installation
|
||||
* Name of the platform {product-title} is deployed on, such as Amazon Web Services
|
||||
* The name of the platform that {product-title} is deployed on, such as Amazon Web Services
|
||||
|
||||
Telemetry does not collect identifying information such as user names, passwords, or the names or addresses of user resources.
|
||||
|
||||
@@ -76,4 +76,5 @@ include::modules/monitoring-listing-acting-alerting-rules.adoc[leveloffset=+2]
|
||||
.Next steps
|
||||
|
||||
* xref:managing-cluster-alerts.adoc#managing-cluster-alerts[Manage cluster alerts.]
|
||||
* Learn about xref:../../telemetry/about-telemetry.adoc#about-telemetry[Telemetry] and, if necessary, opt out of it.
|
||||
* Learn about
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[remote health reporting] and, if necessary, opt out of it.
|
||||
|
||||
@@ -19,3 +19,5 @@ include::modules/images-allow-pods-to-reference-images-across-projects.adoc[leve
|
||||
include::modules/images-allow-pods-to-reference-images-from-secure-registries.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/images-pulling-from-private-registries.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/images-update-global-pull-secret.adoc[leveloffset=+1]
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
[id="about-remote-health-monitoring"]
|
||||
= About remote health monitoring
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: about-remote-health-monitoring
|
||||
|
||||
toc::[]
|
||||
|
||||
{product-title} collects anonymized aggregated information about the health, usage, and size of clusters and reports it to Red Hat via two integrated components: Telemetry and the Insights Operator. This information allows Red Hat to improve {product-title} and to react to issues that impact customers more quickly. This also simplifies the subscription and entitlement process for Red Hat customers and enables the Red Hat OpenShift Cluster Manager service to provide an overview of your clusters and their health and subscription status.
|
||||
|
||||
A cluster that reports data to Red Hat via Telemetry and the Insights Operator is considered a _connected cluster_.
|
||||
|
||||
include::modules/telemetry-about-telemetry.adoc[leveloffset=+1]
|
||||
include::modules/telemetry-what-information-is-collected.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/insights-operator-about.adoc[leveloffset=+1]
|
||||
include::modules/insights-operator-what-information-is-collected.adoc[leveloffset=+2]
|
||||
1
support/remote_health_monitoring/images
Symbolic link
1
support/remote_health_monitoring/images
Symbolic link
@@ -0,0 +1 @@
|
||||
../../images
|
||||
1
support/remote_health_monitoring/modules
Symbolic link
1
support/remote_health_monitoring/modules
Symbolic link
@@ -0,0 +1 @@
|
||||
../../modules
|
||||
@@ -0,0 +1,29 @@
|
||||
[id="opting-out-remote-health-reporting"]
|
||||
= Opting out of remote health reporting
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: opting-out-remote-health-reporting
|
||||
|
||||
toc::[]
|
||||
|
||||
ifdef::openshift-enterprise,openshift-origin[]
|
||||
You might need to opt out of reporting health and usage data for your cluster. For example, you might need to comply with privacy laws or standards governing how your organization reports monitoring data.
|
||||
endif::[]
|
||||
|
||||
ifdef::openshift-dedicated[]
|
||||
On {product-title}, remote health reporting is always enabled. You cannot opt out.
|
||||
endif::[]
|
||||
|
||||
ifdef::openshift-enterprise,openshift-origin[]
|
||||
|
||||
To opt out of remote health reporting, you must:
|
||||
|
||||
. xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#insights-operator-new-pull-secret_opting-out-remote-health-reporting[Modify the global cluster pull secret] to disable remote health reporting.
|
||||
. xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#images-update-global-pull-secret_opting-out-remote-health-reporting[Update the cluster] to use this modified pull secret.
|
||||
|
||||
include::modules/telemetry-consequences-of-disabling-telemetry.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/insights-operator-new-pull-secret-disabled.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/images-update-global-pull-secret.adoc[leveloffset=+1]
|
||||
|
||||
endif::[]
|
||||
@@ -0,0 +1,12 @@
|
||||
[id="showing-data-collected-by-remote-health-monitoring"]
|
||||
= Showing data collected by remote health monitoring
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: showing-data-collected-by-remote-health-monitoring
|
||||
|
||||
toc::[]
|
||||
|
||||
As an administrator, you can review the metrics collected by Telemetry and the Insights Operator.
|
||||
|
||||
include::modules/telemetry-showing-data-collected-from-the-cluster.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/insights-operator-showing-data-collected-from-the-cluster.adoc[leveloffset=+1]
|
||||
@@ -1,9 +0,0 @@
|
||||
[id="about-telemetry"]
|
||||
= About Telemetry
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: about-telemetry
|
||||
|
||||
toc::[]
|
||||
|
||||
include::modules/telemetry-about-telemetry.adoc[leveloffset=+1]
|
||||
include::modules/telemetry-what-information-is-collected.adoc[leveloffset=+1]
|
||||
@@ -1 +0,0 @@
|
||||
../images/
|
||||
@@ -1 +0,0 @@
|
||||
../modules/
|
||||
@@ -1,25 +0,0 @@
|
||||
[id="opting-out-of-telemetry"]
|
||||
= Opting out of Telemetry
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: telemetry
|
||||
|
||||
toc::[]
|
||||
|
||||
ifdef::openshift-enterprise,openshift-origin[]
|
||||
You might need to opt out of Telemetry for your cluster. For example, you might need to comply with privacy laws.
|
||||
endif::[]
|
||||
|
||||
ifdef::openshift-dedicated[]
|
||||
On {product-title}, Telemetry is always enabled. You cannot opt out.
|
||||
endif::[]
|
||||
|
||||
ifdef::openshift-enterprise,openshift-origin[]
|
||||
.Prerequisites
|
||||
|
||||
* Install the OpenShift Command-line Interface (CLI), commonly known as `oc`.
|
||||
* You must log in to the cluster with a user that has the `cluster-admin` role.
|
||||
* You need to have the `cluster-monitoring-config` ConfigMap object with the `data/config.yaml` section. See xref:../monitoring/cluster-monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Creating cluster monitoring ConfigMap] for details.
|
||||
|
||||
include::modules/telemetry-consequences-of-disabling-telemetry.adoc[leveloffset=+1]
|
||||
include::modules/telemetry-disabling-telemetry.adoc[leveloffset=+1]
|
||||
endif::[]
|
||||
@@ -1,10 +0,0 @@
|
||||
[id="showing-data-collected-by-telemetry"]
|
||||
= Showing data collected by Telemetry
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: telemetry
|
||||
|
||||
toc::[]
|
||||
|
||||
An administrator might need to review the metrics that Telemetry collects.
|
||||
|
||||
include::modules/telemetry-showing-data-collected-from-the-cluster.adoc[leveloffset=+1]
|
||||
@@ -145,8 +145,7 @@ be reviewed by cluster administrators and xref:../operators/olm-adding-operators
|
||||
learn to xref:../monitoring/cluster-monitoring/managing-cluster-alerts.adoc#managing-cluster-alerts[manage alerts]. Once your monitoring is configured, use the `oc` tool and Web UI to xref:../monitoring/cluster-monitoring/prometheus-alertmanager-and-grafana.adoc[access Prometheus, Alertmanager, and Grafana].
|
||||
To monitor applications, configure custom metrics for each selected namespace.
|
||||
|
||||
- **xref:../telemetry/about-telemetry.adoc[View Telemetry data]**: Telemetry collects anonymous data about your
|
||||
cluster so that data can be used to improve the {product-title} platform. You can view the xref:../telemetry/showing-data-collected-by-telemetry.adoc[data being collected from your cluster].
|
||||
- **xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring_about-remote-health-monitoring[Remote health monitoring]**: {product-title} collects anonymized aggregated information about your cluster and reports it to Red Hat via Telemetry and the Insights Operator. This information allows Red Hat to improve {product-title} and to react to issues that impact customers more quickly. You can view the xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring_showing-data-collected-by-remote-health-monitoring[data collected by remote health monitoring].
|
||||
endif::[]
|
||||
|
||||
ifdef::openshift-dedicated[]
|
||||
@@ -182,7 +181,6 @@ be reviewed by cluster administrators and xref:../operators/olm-adding-operators
|
||||
learn to xref:../monitoring/cluster-monitoring/managing-cluster-alerts.adoc#managing-cluster-alerts[manage alerts]. Once your monitoring is configured, use the `oc` tool and Web UI to xref:../monitoring/cluster-monitoring/prometheus-alertmanager-and-grafana.adoc[access Prometheus, Alertmanager, and Grafana].
|
||||
To monitor applications, configure custom metrics for each selected namespace.
|
||||
|
||||
- **xref:../telemetry/about-telemetry.adoc[View Telemetry data]**: Telemetry collects anonymous data about your
|
||||
cluster so that data can be used to improve the {product-title} platform. You can view the xref:../telemetry/showing-data-collected-by-telemetry.adoc[data being collected from your cluster].
|
||||
- **xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring_about-remote-health-monitoring[Remote health monitoring]**: {product-title} collects anonymized aggregated information about your cluster and reports it to Red Hat via Telemetry and the Insights Operator. This information allows Red Hat to improve {product-title} and to react to issues that impact customers more quickly. You can view the xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring_showing-data-collected-by-remote-health-monitoring[data collected by remote health monitoring].
|
||||
////
|
||||
endif::[]
|
||||
|
||||
Reference in New Issue
Block a user