mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS#16385: Renaming 'Insights' to 'Red Hat Lightspeed'
This commit is contained in:
Andrea Hoffer
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
8b884ebb61
commit
baf8ff9bb8
@@ -37,7 +37,9 @@ endif::[]
|
||||
:cluster-manager: OpenShift Cluster Manager
|
||||
:cluster-manager-url: link:https://console.redhat.com/openshift[OpenShift Cluster Manager]
|
||||
:cluster-manager-url-pull: link:https://console.redhat.com/openshift/install/pull-secret[pull secret from Red Hat OpenShift Cluster Manager]
|
||||
:insights-advisor-url: link:https://console.redhat.com/openshift/insights/advisor/[Insights Advisor]
|
||||
:insights-advisor-url: link:https://console.redhat.com/openshift/insights/advisor/[Advisor]
|
||||
:insights-operator: Insights Operator
|
||||
:red-hat-lightspeed: Red{nbsp}Hat Lightspeed
|
||||
:hybrid-console: Red{nbsp}Hat Hybrid Cloud Console
|
||||
:hybrid-console-second: Hybrid Cloud Console
|
||||
:hybrid-console-url: link:https://console.redhat.com[Red Hat Hybrid Cloud Console]
|
||||
|
||||
@@ -38,8 +38,8 @@ Selecting an active, installed cluster shows tabs associated with that cluster.
|
||||
* Access control
|
||||
* Add-ons
|
||||
* Networking
|
||||
* Insights Advisor
|
||||
* Machine pools
|
||||
* {red-hat-lightspeed} Advisor
|
||||
* Support
|
||||
* Settings
|
||||
|
||||
|
||||
@@ -45,7 +45,7 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
// The following two xrefs are not included in the OSD and ROSA docs.
|
||||
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
* xref:../../support/remote_health_monitoring/insights-operator-simple-access.adoc#insights-operator-simple-access[Importing simple content access certificates with Insights Operator]
|
||||
* xref:../../support/remote_health_monitoring/insights-operator-simple-access.adoc#insights-operator-simple-access[Importing simple content access certificates with {insights-operator}]
|
||||
* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
* xref:../../openshift_images/image-streams-manage.adoc#image-streams-managing[Managing image streams]
|
||||
|
||||
@@ -55,7 +55,7 @@ include::modules/connected-to-disconnected-disconnect.adoc[leveloffset=+1]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The Insights Operator is degraded when the cluster loses its Internet connection. You can avoid this problem by temporarily xref:../support/remote_health_monitoring/remote-health-reporting.adoc#insights-operator-new-pull-secret-disabled_remote-health-reporting[disabling the Insights Operator] until you can restore it.
|
||||
The {insights-operator} is degraded when the cluster loses its Internet connection. You can avoid this problem by temporarily xref:../support/remote_health_monitoring/remote-health-reporting.adoc#insights-operator-new-pull-secret-disabled_remote-health-reporting[disabling the {insights-operator}] until you can restore it.
|
||||
====
|
||||
|
||||
include::modules/connected-to-disconnected-restore-insights.adoc[leveloffset=+1]
|
||||
|
||||
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
If you use a firewall, you must configure it so that {product-title} can access the sites that it requires to function. You must always grant access to some sites, and you grant access to more if you use Red Hat Insights, the Telemetry service, a cloud to host your cluster, and certain build strategies.
|
||||
If you use a firewall, you must configure it so that {product-title} can access the sites that it requires to function. You must always grant access to some sites, and you grant access to more if you use {red-hat-lightspeed}, the Telemetry service, a cloud to host your cluster, and certain build strategies.
|
||||
|
||||
include::modules/configuring-firewall.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -85,7 +85,7 @@ include::modules/insights-operator.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../support/remote_health_monitoring/using-insights-operator.adoc#using-insights-operator[Using Insights Operator]
|
||||
* xref:../../support/remote_health_monitoring/using-insights-operator.adoc#using-insights-operator[Using {insights-operator}]
|
||||
|
||||
// Machine API capability
|
||||
include::modules/machine-api-capability.adoc[leveloffset=+2]
|
||||
|
||||
@@ -51,7 +51,7 @@ include::modules/reviewing-cluster-status-from-the-openshift-cluster-manager.ado
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster] for more information about reviewing potential issues with your cluster.
|
||||
* See xref:../../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using {red-hat-lightspeed} to identify issues with your cluster] for more information about reviewing potential issues with your cluster.
|
||||
|
||||
//Checking cluster resource availability and utilization
|
||||
include::modules/checking-cluster-resource-availability-and-utilization.adoc[leveloffset=+1]
|
||||
|
||||
@@ -4,13 +4,12 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="about-insights-advisor-workload-recommendations_{context}"]
|
||||
= About Insights advisor service recommendations for workloads
|
||||
= About {red-hat-lightspeed} advisor service recommendations for workloads
|
||||
|
||||
You can use the Red Hat Insights for OpenShift advisor service to view and manage information about recommendations that affect not only your clusters, but also your workloads. The advisor service takes advantage of deployment validation and helps OpenShift cluster administrators to see all runtime violations of deployment policies. You can see recommendations for workloads at link:https://console.redhat.com/openshift/insights/advisor/workloads[OpenShift > Advisor > Workloads] on the {hybrid-console}. For more information, see these additional resources:
|
||||
You can use the {red-hat-lightspeed} advisor service to view and manage information about recommendations that affect not only your clusters, but also your workloads. The advisor service takes advantage of deployment validation and helps OpenShift cluster administrators to see all runtime violations of deployment policies. You can see recommendations for workloads at link:https://console.redhat.com/openshift/insights/advisor/workloads[OpenShift > Advisor > Workloads] on the {hybrid-console}. For more information, see these additional resources:
|
||||
|
||||
* link:https://kubernetes.io/docs/concepts/workloads/[Information about Kubernetes workloads]
|
||||
* https://www.redhat.com/en/blog/boost-your-cluster-operations-with-deployment-validation-and-insights-advisor-for-workloads[Boost your cluster operations with Deployment Validation and Insights Advisor for Workloads]
|
||||
* link:https://docs.redhat.com/en/documentation/red_hat_insights_for_openshift/1-latest/html-single/monitoring_your_openshift_cluster_health_with_insights_advisor/index#identifying-workload-recommendations-for-namespaces-in-clusters_using-insights-advisor[Identifying workload recommendations for namespaces in your clusters]
|
||||
* link:https://docs.redhat.com/en/documentation/red_hat_insights_for_openshift/1-latest/html-single/monitoring_your_openshift_cluster_health_with_insights_advisor/index#viewing-workload-recommendations-for-namespaces_using-insights-advisor[Viewing workload recommendations for namespaces in your cluster]
|
||||
* link:https://docs.redhat.com/en/documentation/red_hat_insights_for_openshift/1-latest/html-single/monitoring_your_openshift_cluster_health_with_insights_advisor/index#excluding-objects-from-workload-recommendations_using-insights-advisor[Excluding objects from workload recommendations in your clusters]
|
||||
|
||||
* https://www.redhat.com/en/blog/boost-your-cluster-operations-with-deployment-validation-and-insights-advisor-for-workloads[Boost your cluster operations with Deployment Validation and {red-hat-lightspeed} Advisor for Workloads]
|
||||
* link:https://docs.redhat.com/en/documentation/red_hat_lightspeed/1-latest/html-single/monitoring_your_openshift_cluster_health_with_red_hat_lightspeed_advisor/index#identifying-workload-recommendations-for-namespaces-in-clusters_using-insights-advisor[Identifying workload recommendations for namespaces in your clusters]
|
||||
* link:https://docs.redhat.com/en/documentation/red_hat_lightspeed/1-latest/html-single/monitoring_your_openshift_cluster_health_with_red_hat_lightspeed_advisor/index#viewing-workload-recommendations-for-namespaces_using-insights-advisor[Viewing workload recommendations for namespaces in your cluster]
|
||||
* link:https://docs.redhat.com/en/documentation/red_hat_lightspeed/1-latest/html-single/monitoring_your_openshift_cluster_health_with_red_hat_lightspeed_advisor/index#excluding-objects-from-workload-recommendations_using-insights-advisor[Excluding objects from workload recommendations in your clusters]
|
||||
|
||||
@@ -11,7 +11,7 @@ Builds that use Red Hat subscriptions to install content must include the entitl
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
* You must have access to {op-system-base-full} package repositories through your subscription. The entitlement secret to access these repositories is automatically created by the Insights Operator when your cluster is subscribed.
|
||||
* You must have access to {op-system-base-full} package repositories through your subscription. The entitlement secret to access these repositories is automatically created by the {insights-operator} when your cluster is subscribed.
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
* You must have access to the cluster as a user with the `cluster-admin` role or you have permission to access secrets in the `openshift-config-managed` project.
|
||||
|
||||
@@ -97,7 +97,7 @@ If your environment has a dedicated load balancer in front of your {product-titl
|
||||
|
||||
. Set your firewall's allowlist to include any site that provides resources for a language or framework that your builds require.
|
||||
|
||||
. If you do not disable Telemetry, you must grant access to the following URLs to access Red Hat Insights:
|
||||
. If you do not disable Telemetry, you must grant access to the following URLs to access {red-hat-lightspeed}:
|
||||
+
|
||||
[cols="3,2,4",options="header"]
|
||||
|===
|
||||
|
||||
@@ -4,11 +4,11 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="connected-to-disconnected-restore-insights_{context}"]
|
||||
= Restoring a degraded Insights Operator
|
||||
= Restoring a degraded {insights-operator}
|
||||
|
||||
Disconnecting the cluster from the network necessarily causes the cluster to lose the Internet connection. The Insights Operator becomes degraded because it requires access to link:https://console.redhat.com[Red Hat Insights].
|
||||
Disconnecting the cluster from the network necessarily causes the cluster to lose the Internet connection. The {insights-operator} becomes degraded because it requires access to link:https://console.redhat.com[{red-hat-lightspeed}].
|
||||
|
||||
This topic describes how to recover from a degraded Insights Operator.
|
||||
This topic describes how to recover from a degraded {insights-operator}.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -28,7 +28,7 @@ This topic describes how to recover from a degraded Insights Operator.
|
||||
$ oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson=./.dockerconfigjson
|
||||
----
|
||||
|
||||
. Verify that the Insights Operator is no longer degraded:
|
||||
. Verify that the {insights-operator} is no longer degraded:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="disabling-insights-advisor-recommendations_{context}"]
|
||||
= Disabling Insights advisor service recommendations
|
||||
= Disabling {red-hat-lightspeed} advisor service recommendations
|
||||
|
||||
You can disable specific recommendations that affect your clusters, so that they no longer appear in your reports. It is possible to disable a recommendation for a single cluster or all of your clusters.
|
||||
|
||||
|
||||
@@ -5,14 +5,14 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="disabling-insights-operator-alerts_{context}"]
|
||||
= Disabling Insights Operator alerts
|
||||
= Disabling {insights-operator} alerts
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
To prevent the Insights Operator from sending alerts to the cluster Prometheus instance, you create or edit the *insights-config* `ConfigMap` object.
|
||||
To prevent the {insights-operator} from sending alerts to the cluster Prometheus instance, you create or edit the *insights-config* `ConfigMap` object.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Previously, a cluster administrator would create or edit the Insights Operator configuration using a *support secret* in the `openshift-config` namespace. Red Hat Insights now supports the creation of a `ConfigMap` object to configure the Operator. The Operator gives preference to the config map configuration over the support secret if both exist.
|
||||
Previously, a cluster administrator would create or edit the {insights-operator} configuration using a *support secret* in the `openshift-config` namespace. {red-hat-lightspeed} now supports the creation of a `ConfigMap` object to configure the Operator. The Operator gives preference to the config map configuration over the support secret if both exist.
|
||||
====
|
||||
|
||||
If the *insights-config* `ConfigMap` object does not exist, you must create it when you first add custom configurations. Note that configurations within the `ConfigMap` object take precedence over the default settings defined in the `config/pod.yaml` file.
|
||||
@@ -54,4 +54,4 @@ data:
|
||||
. Click *Save*. The *insights-config* config-map details page opens.
|
||||
. Verify that the value of the `config.yaml` `alerting` attribute is set to `disabled: true`.
|
||||
|
||||
After you save the changes, Insights Operator no longer sends alerts to the cluster Prometheus instance.
|
||||
After you save the changes, {insights-operator} no longer sends alerts to the cluster Prometheus instance.
|
||||
|
||||
@@ -5,22 +5,22 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="disabling-insights-operator-gather_{context}"]
|
||||
= Disabling the Insights Operator periodic gather operations
|
||||
= Disabling the {insights-operator} periodic gather operations
|
||||
|
||||
|
||||
[role="_abstract"]
|
||||
You can optionally disable the periodic `InsightsDataGather` operations that the Insights Operator runs every 2 hours by default. Disabling the periodic data gather operations increases privacy for your organization as Insights Operator will no longer gather and send Insights cluster reports to Red{nbsp}Hat.
|
||||
You can optionally disable the periodic `InsightsDataGather` operations that the {insights-operator} runs every 2 hours by default. Disabling the periodic data gather operations increases privacy for your organization as {insights-operator} will no longer gather and send {red-hat-lightspeed} cluster reports to Red{nbsp}Hat.
|
||||
|
||||
Disabling gather operations will also disable Insights analysis and recommendations for your cluster without affecting other core functions that require communication with Red{nbsp}Hat such as cluster transfers.
|
||||
Disabling gather operations will also disable {red-hat-lightspeed} analysis and recommendations for your cluster without affecting other core functions that require communication with Red{nbsp}Hat such as cluster transfers.
|
||||
|
||||
You can view a list of attempted gather operations for your cluster from the `/insights-operator/gathers.json` file in your Insights Operator archive. Be aware that some gather operations occur only when certain conditions are met and might not show in your most recent archive.
|
||||
You can view a list of attempted gather operations for your cluster from the `/insights-operator/gathers.json` file in your {insights-operator} archive. Be aware that some gather operations occur only when certain conditions are met and might not show in your most recent archive.
|
||||
|
||||
:FeatureName: The `InsightsDataGather` custom resource
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If you enable Technology Preview in your cluster, the Insights Operator runs gather operations in individual pods. This is part of the Technology Preview feature set for the Insights Operator and supports the new data gathering features.
|
||||
If you enable Technology Preview in your cluster, the {insights-operator} runs gather operations in individual pods. This is part of the Technology Preview feature set for the {insights-operator} and supports the new data gathering features.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
@@ -79,9 +79,9 @@ spec:
|
||||
|
||||
.Results
|
||||
|
||||
After you save the changes, the Insights Operator gather configurations are updated and the operations that you disabled in the configuration will no longer occur.
|
||||
After you save the changes, the {insights-operator} gather configurations are updated and the operations that you disabled in the configuration will no longer occur.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Disabling gather operations restricts the ability of the Insights Advisor service to offer effective recommendations for your cluster.
|
||||
Disabling gather operations restricts the ability of the {red-hat-lightspeed} advisor service to offer effective recommendations for your cluster.
|
||||
====
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="displaying-all-insights-advisor-recommendations_{context}"]
|
||||
= Displaying all Insights advisor service recommendations
|
||||
= Displaying all {red-hat-lightspeed} advisor service recommendations
|
||||
|
||||
The Recommendations view, by default, only displays the recommendations that are detected on your clusters. However, you can view all of the recommendations in the advisor service's archive.
|
||||
|
||||
|
||||
@@ -6,9 +6,9 @@
|
||||
[id="displaying-potential-issues-with-your-cluster_{context}"]
|
||||
= Displaying potential issues with your cluster
|
||||
|
||||
This section describes how to display the Insights report in *Insights Advisor* on {cluster-manager-url}.
|
||||
This section describes how to display the {red-hat-lightspeed} report in *{red-hat-lightspeed} Advisor* on {cluster-manager-url}.
|
||||
|
||||
Note that Insights repeatedly analyzes your cluster and shows the latest results. These results can change, for example, if you fix an issue or a new issue has been detected.
|
||||
Note that {red-hat-lightspeed} repeatedly analyzes your cluster and shows the latest results. These results can change, for example, if you fix an issue or a new issue has been detected.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
@@ -20,13 +20,13 @@ Note that Insights repeatedly analyzes your cluster and shows the latest results
|
||||
|
||||
. Navigate to *Advisor* -> *Recommendations* on {cluster-manager-url}.
|
||||
+
|
||||
Depending on the result, the Insights advisor service displays one of the following:
|
||||
Depending on the result, the {red-hat-lightspeed} advisor service displays one of the following:
|
||||
+
|
||||
* *No matching recommendations found*, if Insights did not identify any issues.
|
||||
* *No matching recommendations found*, if {red-hat-lightspeed} did not identify any issues.
|
||||
+
|
||||
* A list of issues Insights has detected, grouped by risk (low, moderate, important, and critical).
|
||||
* A list of issues {red-hat-lightspeed} has detected, grouped by risk (low, moderate, important, and critical).
|
||||
+
|
||||
* *No clusters yet*, if Insights has not yet analyzed the cluster. The analysis starts shortly after the cluster has been installed, registered, and connected to the internet.
|
||||
* *No clusters yet*, if {red-hat-lightspeed} has not yet analyzed the cluster. The analysis starts shortly after the cluster has been installed, registered, and connected to the internet.
|
||||
|
||||
. If any issues are displayed, click the *>* icon in front of the entry for more details.
|
||||
+
|
||||
|
||||
@@ -5,9 +5,9 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="displaying-the-insights-status-in-the-web-console_{context}"]
|
||||
= Displaying the Insights status in the web console
|
||||
= Displaying the {red-hat-lightspeed} status in the web console
|
||||
|
||||
Insights repeatedly analyzes your cluster and you can display the status of identified potential issues of your cluster in the {product-title} web console. This status shows the number of issues in the different categories and, for further details, links to the reports in {cluster-manager-url}.
|
||||
{red-hat-lightspeed} repeatedly analyzes your cluster and you can display the status of identified potential issues of your cluster in the {product-title} web console. This status shows the number of issues in the different categories and, for further details, links to the reports in {cluster-manager-url}.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
@@ -19,6 +19,6 @@ Insights repeatedly analyzes your cluster and you can display the status of iden
|
||||
|
||||
. Navigate to *Home* -> *Overview* in the {product-title} web console.
|
||||
|
||||
. Click *Insights* on the *Status* card.
|
||||
. Click *{red-hat-lightspeed}* on the *Status* card.
|
||||
+
|
||||
The pop-up window lists potential issues grouped by risk. Click the individual categories or *View all recommendations in Insights Advisor* to display more details.
|
||||
The pop-up window lists potential issues grouped by risk. Click the individual categories or *View all recommendations in {red-hat-lightspeed} Advisor* to display more details.
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="enabling-insights-advisor-recommendations_{context}"]
|
||||
= Enabling a previously disabled Insights advisor service recommendation
|
||||
= Enabling a previously disabled {red-hat-lightspeed} advisor service recommendation
|
||||
|
||||
When a recommendation is disabled for all clusters, you no longer see the recommendation in the Insights advisor service. You can change this behavior.
|
||||
When a recommendation is disabled for all clusters, you no longer see the recommendation in the {red-hat-lightspeed} advisor service. You can change this behavior.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
|
||||
@@ -5,13 +5,13 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="enabling-insights-operator-alerts_{context}"]
|
||||
= Enabling Insights Operator alerts
|
||||
= Enabling {insights-operator} alerts
|
||||
|
||||
When alerts are disabled, the Insights Operator no longer sends alerts to the cluster Prometheus instance. You can reenable them.
|
||||
When alerts are disabled, the {insights-operator} no longer sends alerts to the cluster Prometheus instance. You can reenable them.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Previously, a cluster administrator would create or edit the Insights Operator configuration using a *support secret* in the `openshift-config` namespace. Red Hat Insights now supports the creation of a `ConfigMap` object to configure the Operator. The Operator gives preference to the config map configuration over the support secret if both exist.
|
||||
Previously, a cluster administrator would create or edit the {insights-operator} configuration using a *support secret* in the `openshift-config` namespace. {red-hat-lightspeed} now supports the creation of a `ConfigMap` object to configure the {insights-operator}. The {insights-operator} gives preference to the config map configuration over the support secret if both exist.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
@@ -48,4 +48,4 @@ data:
|
||||
. Click *Save*. The *insights-config* config-map details page opens.
|
||||
. Verify that the value of the `config.yaml` `alerting` attribute is set to `disabled: false`.
|
||||
|
||||
After you save the changes, Insights Operator again sends alerts to the cluster Prometheus instance.
|
||||
After you save the changes, {insights-operator} again sends alerts to the cluster Prometheus instance.
|
||||
|
||||
@@ -5,9 +5,9 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="enabling-insights-operator-gather_{context}"]
|
||||
= Re-enabling the Insights Operator periodic gather operations
|
||||
= Re-enabling the {insights-operator} periodic gather operations
|
||||
|
||||
If you disabled the default `InsightsDataGather` data gather operations, you can enable them again so that the Insights Operator resumes the periodic data collection, and sends the resulting Insights cluster reports to Red Hat.
|
||||
If you disabled the default `InsightsDataGather` data gather operations, you can enable them again so that the {insights-operator} resumes the periodic data collection, and sends the resulting {red-hat-lightspeed} cluster reports to Red{nbsp}Hat.
|
||||
|
||||
:FeatureName: The `InsightsDataGather` custom resource
|
||||
include::snippets/technology-preview.adoc[]
|
||||
@@ -44,7 +44,7 @@ spec:
|
||||
mode: All # Options: All, None, Custom
|
||||
----
|
||||
|
||||
** To enable individual gather operations that were previously disabled, find the name of the gatherer operation under the `gatherers:custom:configs` key section and change the `state` to *Enabled*. Alternatively, under the `config` specification, remove the `name` and `state` configuration lines for the operation you want to enable.
|
||||
** To enable individual gather operations that were previously disabled, find the name of the gatherer operation under the `gatherers:custom:configs` key section and change the `state` to *Enabled*. Alternatively, under the `config` specification, remove the `name` and `state` configuration lines for the operation you want to enable.
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
@@ -69,9 +69,9 @@ spec:
|
||||
+
|
||||
. Click *Save*.
|
||||
+
|
||||
After you save the changes, the Insights Operator gather configurations are updated and the affected gather operations start.
|
||||
After you save the changes, the {insights-operator} gather configurations are updated and the affected gather operations start.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Disabling gather operations restricts the ability of the Insights Advisor service to offer effective recommendations for your cluster.
|
||||
Disabling gather operations restricts the ability of the {red-hat-lightspeed} advisor service to offer effective recommendations for your cluster.
|
||||
====
|
||||
|
||||
@@ -8,5 +8,5 @@
|
||||
|
||||
If you or your organization have disabled remote health reporting, you can enable this feature again. You can see that remote health reporting is disabled from the message `Insights not available` in the *Status* tile on the {product-title} web console *Overview* page.
|
||||
|
||||
To enable remote health reporting, you must change the global cluster pull secret with a new authorization token. Enabling remote health reporting enables both Insights Operator and Telemetry.
|
||||
To enable remote health reporting, you must change the global cluster pull secret with a new authorization token. Enabling remote health reporting enables both {insights-operator} and Telemetry.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="filtering-unnecessary-advisor-recommendations_{context}"]
|
||||
= Filtering Insights advisor service recommendations
|
||||
= Filtering {red-hat-lightspeed} advisor service recommendations
|
||||
|
||||
As an {product-title} cluster manager, you can filter the recommendations that are displayed on the recommendations list. By applying filters, you can reduce the number of reported recommendations and concentrate on your highest priority recommendations.
|
||||
|
||||
|
||||
@@ -6,9 +6,9 @@
|
||||
[id="insights-operator-advisor-recommendation-filters_{context}"]
|
||||
= Advisor recommendation filters
|
||||
|
||||
The Insights advisor service can return a large number of recommendations. To focus on your most critical recommendations, you can apply filters to the https://console.redhat.com/openshift/insights/advisor/recommendations[Advisor recommendations] list to remove low-priority recommendations.
|
||||
The {red-hat-lightspeed} advisor service can return a large number of recommendations. To focus on your most critical recommendations, you can apply filters to the https://console.redhat.com/openshift/insights/advisor/recommendations[Advisor recommendations] list to remove low-priority recommendations.
|
||||
|
||||
By default, filters are set to only show enabled recommendations that are impacting one or more clusters. To view all or disabled recommendations in the Insights library, you can customize the filters.
|
||||
By default, filters are set to only show enabled recommendations that are impacting one or more clusters. To view all or disabled recommendations in the {red-hat-lightspeed} library, you can customize the filters.
|
||||
|
||||
To apply a filter, select a filter type and then set its value based on the options that are available in the drop-down list. You can apply multiple filters to the list of recommendations.
|
||||
|
||||
@@ -16,9 +16,9 @@ You can set the following filter types:
|
||||
|
||||
* *Name:* Search for a recommendation by name.
|
||||
* *Total risk:* Select one or more values from *Critical*, *Important*, *Moderate*, and *Low* indicating the likelihood and the severity of a negative impact on a cluster.
|
||||
* *Impact:* Select one or more values from *Critical*, *High*, *Medium*, and *Low* indicating the potential impact to the continuity of cluster operations.
|
||||
* *Impact:* Select one or more values from *Critical*, *High*, *Medium*, and *Low* indicating the potential impact to the continuity of cluster operations.
|
||||
* *Likelihood:* Select one or more values from *Critical*, *High*, *Medium*, and *Low* indicating the potential for a negative impact to a cluster if the recommendation comes to fruition.
|
||||
* *Category:* Select one or more categories from *Service Availability*, *Performance*, *Fault Tolerance*, *Security*, and *Best Practice* to focus your attention on.
|
||||
* *Status:* Click a radio button to show enabled recommendations (default), disabled recommendations, or all recommendations.
|
||||
* *Clusters impacted:* Set the filter to show recommendations currently impacting one or more clusters, non-impacting recommendations, or all recommendations.
|
||||
* *Risk of change:* Select one or more values from *High*, *Moderate*, *Low*, and *Very low* indicating the risk that the implementation of the resolution could have on cluster operations.
|
||||
* *Risk of change:* Select one or more values from *High*, *Moderate*, *Low*, and *Very low* indicating the risk that the implementation of the resolution could have on cluster operations.
|
||||
|
||||
@@ -4,13 +4,13 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="insights-operator-about_{context}"]
|
||||
= About the Insights Operator
|
||||
= About the {insights-operator}
|
||||
|
||||
The Insights Operator periodically gathers configuration and component failure status and, by default, reports that data every two hours to Red Hat. This information enables Red Hat to assess configuration and deeper failure data than is reported through Telemetry.
|
||||
The {insights-operator} periodically gathers configuration and component failure status and, by default, reports that data every two hours to Red{nbsp}Hat. This information enables Red{nbsp}Hat to assess configuration and deeper failure data than is reported through Telemetry.
|
||||
|
||||
Users of {product-title} can display the report of each cluster in the {insights-advisor-url} service on {hybrid-console}. If any issues have been identified, Insights provides further details and, if available, steps on how to solve a problem.
|
||||
Users of {product-title} can display the report of each cluster in the {insights-advisor-url} service on {hybrid-console}. If any issues have been identified, {red-hat-lightspeed} provides further details and, if available, steps on how to solve a problem.
|
||||
|
||||
The Insights Operator does not collect identifying information, such as user names, passwords, or certificates. See link:https://console.redhat.com/security/insights[Red Hat Insights Data & Application Security] for information about Red Hat Insights data collection and controls.
|
||||
The {insights-operator} does not collect identifying information, such as user names, passwords, or certificates. See link:https://console.redhat.com/security/insights[{red-hat-lightspeed} Data & Application Security] for information about {red-hat-lightspeed} data collection and controls.
|
||||
|
||||
Red Hat uses all connected cluster information to:
|
||||
|
||||
|
||||
@@ -4,13 +4,13 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="insights-operator-advisor-overview_{context}"]
|
||||
= About Red Hat Insights Advisor for {product-title}
|
||||
= About {red-hat-lightspeed} Advisor for {product-title}
|
||||
|
||||
You can use the Insights advisor service to assess and monitor the health of your {product-title} clusters. Whether you are concerned about individual clusters, or with your whole infrastructure, it is important to be aware of the exposure of your cluster infrastructure to issues that can affect service availability, fault tolerance, performance, or security.
|
||||
You can use the {red-hat-lightspeed} advisor service to assess and monitor the health of your {product-title} clusters. Whether you are concerned about individual clusters, or with your whole infrastructure, it is important to be aware of the exposure of your cluster infrastructure to issues that can affect service availability, fault tolerance, performance, or security.
|
||||
|
||||
If the cluster has the Deployment Validation Operator (DVO) installed the recommendations also highlight workloads whose configuration might lead to cluster health issues.
|
||||
|
||||
The results of the Insights analysis are available in the Insights advisor service on {hybrid-console}. In the {hybrid-console}, you can perform the following actions:
|
||||
The results of the {red-hat-lightspeed} analysis are available in the {red-hat-lightspeed} advisor service on {hybrid-console}. In the {hybrid-console}, you can perform the following actions:
|
||||
|
||||
|
||||
* View clusters and workloads affected by specific recommendations.
|
||||
@@ -20,5 +20,4 @@ The results of the Insights analysis are available in the Insights advisor servi
|
||||
|
||||
.Additional resources
|
||||
|
||||
* link:https://docs.redhat.com/en/documentation/red_hat_insights_for_openshift/1-latest/html-single/monitoring_your_openshift_cluster_health_with_insights_advisor/index#using-the-deployment-validation-operator[Using the Deployment Validation Operator in your Red Hat Insights for OpenShift workflow]
|
||||
|
||||
* link:https://docs.redhat.com/en/documentation/red_hat_lightspeed/1-latest/html-single/monitoring_your_openshift_cluster_health_with_red_hat_lightspeed_advisor/index#using-the-deployment-validation-operator[Using the Deployment Validation Operator in your {red-hat-lightspeed} workflow]
|
||||
|
||||
@@ -4,12 +4,12 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="insights-operator-advisor-recommendations_{context}"]
|
||||
= Understanding Insights Advisor recommendations
|
||||
= Understanding {red-hat-lightspeed} advisor service recommendations
|
||||
|
||||
The Insights advisor service bundles information about various cluster states and component configurations that can negatively affect the service availability, fault tolerance, performance, or security of your clusters and workloads. This information set is called a recommendation in the Insights advisor service. Recommendations for clusters includes the following information:
|
||||
The {red-hat-lightspeed} advisor service bundles information about various cluster states and component configurations that can negatively affect the service availability, fault tolerance, performance, or security of your clusters and workloads. This information set is called a recommendation in the {red-hat-lightspeed} advisor service. Recommendations for clusters includes the following information:
|
||||
|
||||
* *Name:* A concise description of the recommendation
|
||||
* *Added:* When the recommendation was published to the Insights Advisor service archive
|
||||
* *Added:* When the recommendation was published to the {red-hat-lightspeed} advisor service archive
|
||||
* *Category:* Whether the issue has the potential to negatively affect service availability, fault tolerance, performance, or security
|
||||
* *Total risk:* A value derived from the _likelihood_ that the condition will negatively affect your cluster or workload, and the _impact_ on operations if that were to happen
|
||||
* *Clusters:* A list of clusters on which a recommendation is detected
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
[id="insights-operator-configuring-sca_{context}"]
|
||||
= Configuring simple content access import interval
|
||||
|
||||
You can configure how often the Insights Operator imports the simple content access (sca) entitlements by using the *insights-config* `ConfigMap` object in the `openshift-insights` namespace. The entitlement import normally occurs every eight hours, but you can shorten this sca interval if you update your simple content access configuration in the *insights-config* `ConfigMap` object.
|
||||
You can configure how often the {insights-operator} imports the simple content access (sca) entitlements by using the *insights-config* `ConfigMap` object in the `openshift-insights` namespace. The entitlement import normally occurs every eight hours, but you can shorten this sca interval if you update your simple content access configuration in the *insights-config* `ConfigMap` object.
|
||||
|
||||
This procedure describes how to update the import interval to two hours (2h). You can specify hours (h) or hours and minutes, for example: 2h30m.
|
||||
|
||||
|
||||
@@ -5,23 +5,23 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="insights-operator-configuring_{context}"]
|
||||
= Configuring Insights Operator
|
||||
= Configuring {insights-operator}
|
||||
|
||||
Insights Operator configuration is a combination of the default Operator configuration and the configuration that is stored in either the *insights-config* `ConfigMap` object in the `openshift-insights` namespace, OR in the support secret in the `openshift-config` namespace.
|
||||
{insights-operator} configuration is a combination of the default Operator configuration and the configuration that is stored in either the *insights-config* `ConfigMap` object in the `openshift-insights` namespace, OR in the support secret in the `openshift-config` namespace.
|
||||
|
||||
When a `ConfigMap` object or support secret exists, the contained attribute values override the default Operator configuration values. If both a `ConfigMap` object _and_ a support secret exist, the Operator reads the `ConfigMap` object.
|
||||
|
||||
The `ConfigMap` object does not exist by default, so an {product-title} cluster administrator must create it.
|
||||
The `ConfigMap` object does not exist by default, so an {product-title} cluster administrator must create it.
|
||||
|
||||
//[NOTE]
|
||||
//====
|
||||
//Red Hat Insights encourages cluster administrators to use the config-map configuration method. Support secrets will continue to be supported in the near future but will eventually be deprecated.
|
||||
//{red-hat-lightspeed} encourages cluster administrators to use the config-map configuration method. Support secrets will continue to be supported in the near future but will eventually be deprecated.
|
||||
//====
|
||||
|
||||
.ConfigMap object configuration structure
|
||||
This example of an *insights-config* `ConfigMap` object (`config.yaml` configuration) shows configuration options by using standard YAML formatting.
|
||||
|
||||
image::insights-operator-configmap-example.png[Example of Insights Operator ConfigMap object]
|
||||
image::insights-operator-configmap-example.png[Example of {insights-operator} ConfigMap object]
|
||||
|
||||
.Configurable attributes and default values
|
||||
The following table describes the available configuration attributes:
|
||||
@@ -31,24 +31,24 @@ The following table describes the available configuration attributes:
|
||||
The *insights-config* `ConfigMap` object follows standard YAML formatting, wherein child values are below the parent attribute and indented two spaces. For the *Obfuscation* attribute, enter values as bulleted children of the parent attribute.
|
||||
====
|
||||
|
||||
.Insights Operator configurable attributes
|
||||
.{insights-operator} configurable attributes
|
||||
[cols=".^2l,.^3a,.^1a,.^1a",options="header"]
|
||||
|====
|
||||
|Attribute name|Description|Value type|Default value
|
||||
|
||||
|alerting:
|
||||
|alerting:
|
||||
disabled: false
|
||||
|Disables Insights Operator alerts to the cluster Prometheus instance.
|
||||
|Disables {insights-operator} alerts to the cluster Prometheus instance.
|
||||
|Boolean
|
||||
|`false`
|
||||
|
||||
|clusterTransfer:
|
||||
|clusterTransfer:
|
||||
endpoint: <url>
|
||||
|The endpoint for checking and downloading cluster transfer data.
|
||||
|URL
|
||||
|https://api.openshift.com/api/accounts_mgmt/v1/cluster_transfers/
|
||||
|
||||
|clusterTransfer:
|
||||
|clusterTransfer:
|
||||
interval: 1h0m0s
|
||||
|Sets the frequency for checking available cluster transfers.
|
||||
|Time interval
|
||||
@@ -74,7 +74,7 @@ The *insights-config* `ConfigMap` object follows standard YAML formatting, where
|
||||
|
||||
|dataReporting:
|
||||
downloadEndpoint: <url>
|
||||
|Specifies the endpoint for downloading the latest Insights analysis.
|
||||
|Specifies the endpoint for downloading the latest {red-hat-lightspeed} analysis.
|
||||
|URL
|
||||
|https://console.redhat.com/api/ingress/v1/download
|
||||
|
||||
@@ -99,27 +99,27 @@ The *insights-config* `ConfigMap` object follows standard YAML formatting, where
|
||||
|String
|
||||
|Not applicable
|
||||
|
||||
|proxy:
|
||||
|proxy:
|
||||
httpProxy: http://example.com,
|
||||
httpsProxy: http://example.com,
|
||||
noProxy: test.org
|
||||
|Set custom proxy for Insights Operator.
|
||||
|Set custom proxy for {insights-operator}.
|
||||
|URL
|
||||
|No default
|
||||
|
||||
|sca:
|
||||
|sca:
|
||||
interval: 8h0m0s
|
||||
|Specifies the frequency of the simple content access (SCA) entitlements download.
|
||||
|Time interval
|
||||
|`2h`
|
||||
|
||||
|sca:
|
||||
|sca:
|
||||
endpoint: <url>
|
||||
|Specifies the endpoint for downloading the simple content access (SCA) entitlements.
|
||||
|URL
|
||||
|https://api.openshift.com/api/accounts_mgmt/v1/entitlement_certificates
|
||||
|
||||
|sca:
|
||||
|sca:
|
||||
disabled: false
|
||||
|Disables the simple content access entitlements download.
|
||||
|Boolean
|
||||
@@ -131,11 +131,11 @@ The *insights-config* `ConfigMap` object follows standard YAML formatting, where
|
||||
[id="creating-insights-config-configmap_{context}"]
|
||||
== Creating the insights-config ConfigMap object
|
||||
|
||||
This procedure describes how to create the *insights-config* `ConfigMap` object for the Insights Operator to set custom configurations.
|
||||
This procedure describes how to create the *insights-config* `ConfigMap` object for the {insights-operator} to set custom configurations.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Red Hat recommends you consult Red Hat Support before making changes to the default Insights Operator configuration.
|
||||
Red{nbsp}Hat recommends you consult Red{nbsp}Hat Support before making changes to the default {insights-operator} configuration.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
@@ -175,4 +175,4 @@ immutable: false
|
||||
. In the *ConfigMap Name* field, enter *insights-config*.
|
||||
. In the *Key* field, enter *config.yaml*.
|
||||
. For the *Value* field, either browse for a file to drag and drop into the field or enter your configuration parameters manually.
|
||||
. Click *Create* and you can see the `ConfigMap` object and configuration information.
|
||||
. Click *Create* and you can see the `ConfigMap` object and configuration information.
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="insights-operator-downloading-archive_{context}"]
|
||||
= Downloading your Insights Operator archive
|
||||
= Downloading your {insights-operator} archive
|
||||
|
||||
Insights Operator stores gathered data in an archive located in the `openshift-insights` namespace of your cluster. You can download and review the data that is gathered by the Insights Operator.
|
||||
{insights-operator} stores gathered data in an archive located in the `openshift-insights` namespace of your cluster. You can download and review the data that is gathered by the {insights-operator}.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
@@ -19,14 +19,14 @@ endif::openshift-rosa,openshift-dedicated[]
|
||||
|
||||
.Procedure
|
||||
|
||||
. Find the name of the running pod for the Insights Operator:
|
||||
. Find the name of the running pod for the {insights-operator}:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ 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:
|
||||
. Copy the recent data archives collected by the {insights-operator}:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
@@ -34,4 +34,4 @@ $ oc cp openshift-insights/<insights_operator_pod_name>:/var/lib/insights-operat
|
||||
----
|
||||
<1> Replace `<insights_operator_pod_name>` with the pod name output from the preceding command.
|
||||
|
||||
The recent Insights Operator archives are now available in the `insights-data` directory.
|
||||
The recent {insights-operator} archives are now available in the `insights-data` directory.
|
||||
|
||||
@@ -6,16 +6,16 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="insights-operator-enable-obfuscation_{context}"]
|
||||
= Enabling Insights Operator data obfuscation
|
||||
= Enabling {insights-operator} data obfuscation
|
||||
|
||||
You can enable obfuscation to mask sensitive and identifiable IPv4 addresses and cluster base domains that the Insights Operator sends to link:https://console.redhat.com[console.redhat.com].
|
||||
You can enable obfuscation to mask sensitive and identifiable IPv4 addresses and cluster base domains that the {insights-operator} sends to link:https://console.redhat.com[console.redhat.com].
|
||||
|
||||
[WARNING]
|
||||
====
|
||||
Although this feature is available, Red Hat recommends keeping obfuscation disabled for a more effective support experience.
|
||||
====
|
||||
|
||||
Obfuscation assigns non-identifying values to cluster IPv4 addresses, and uses a translation table that is retained in memory to change IP addresses to their obfuscated versions throughout the Insights Operator archive before uploading the data to link:https://console.redhat.com[console.redhat.com].
|
||||
Obfuscation assigns non-identifying values to cluster IPv4 addresses, and uses a translation table that is retained in memory to change IP addresses to their obfuscated versions throughout the {insights-operator} archive before uploading the data to link:https://console.redhat.com[console.redhat.com].
|
||||
|
||||
For cluster base domains, obfuscation changes the base domain to a hardcoded substring. For example, `cluster-api.openshift.example.com` becomes `cluster-api.<CLUSTER_BASE_DOMAIN>`.
|
||||
|
||||
@@ -46,4 +46,4 @@ The following procedure enables obfuscation using the `support` secret in the `o
|
||||
|
||||
If the `obfuscation-translation-table` secret exists, then obfuscation is enabled and working.
|
||||
|
||||
Alternatively, you can inspect `/insights-operator/gathers.json` in your Insights Operator archive for the value `"is_global_obfuscation_enabled": true`.
|
||||
Alternatively, you can inspect `/insights-operator/gathers.json` in your {insights-operator} archive for the value `"is_global_obfuscation_enabled": true`.
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
[id="insights-operator-enabling-sca_{context}"]
|
||||
= Enabling a previously disabled simple content access import
|
||||
|
||||
If the importing of simple content access entitlements is disabled, the Insights Operator does not import simple content access entitlements. You can change this behavior.
|
||||
If the importing of simple content access entitlements is disabled, the {insights-operator} does not import simple content access entitlements. You can change this behavior.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
|
||||
@@ -4,20 +4,20 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="insights-operator-gather-duration_{context}"]
|
||||
= Viewing Insights Operator gather durations
|
||||
= Viewing {insights-operator} gather durations
|
||||
|
||||
You can view the time it takes for the Insights Operator to gather the information contained in the archive. This helps you to understand Insights Operator resource usage and issues with Insights Advisor.
|
||||
You can view the time it takes for the {insights-operator} to gather the information contained in the archive. This helps you to understand {insights-operator} resource usage and issues with {red-hat-lightspeed} Advisor.
|
||||
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* A recent copy of your Insights Operator archive.
|
||||
* A recent copy of your {insights-operator} archive.
|
||||
|
||||
.Procedure
|
||||
|
||||
. From your archive, open `/insights-operator/gathers.json`.
|
||||
+
|
||||
The file contains a list of Insights Operator gather operations:
|
||||
The file contains a list of {insights-operator} gather operations:
|
||||
+
|
||||
[source,json]
|
||||
----
|
||||
|
||||
@@ -6,15 +6,15 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="insights-operator-manual-upload_{context}"]
|
||||
= Uploading an Insights Operator archive
|
||||
= Uploading an {insights-operator} archive
|
||||
|
||||
You can manually upload an Insights Operator archive to link:https://console.redhat.com[console.redhat.com] to diagnose potential issues.
|
||||
You can manually upload an {insights-operator} archive to link:https://console.redhat.com[console.redhat.com] to diagnose potential issues.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You are logged in to {product-title} as `cluster-admin`.
|
||||
* You have a workstation with unrestricted internet access.
|
||||
* You have created a copy of the Insights Operator archive.
|
||||
* You have created a copy of the {insights-operator} archive.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -44,7 +44,7 @@ $ oc extract secret/pull-secret -n openshift-config --to=.
|
||||
----
|
||||
$ curl -v -H "User-Agent: insights-operator/one10time200gather184a34f6a168926d93c330 cluster/_<cluster_id>_" -H "Authorization: Bearer _<your_token>_" -F "upload=@_<path_to_archive>_; type=application/vnd.redhat.openshift.periodic+tar" https://console.redhat.com/api/ingress/v1/upload
|
||||
----
|
||||
where `_<cluster_id>_` is your cluster ID, `_<your_token>_` is the token from your pull secret, and `_<path_to_archive>_` is the path to the Insights Operator archive.
|
||||
where `_<cluster_id>_` is your cluster ID, `_<your_token>_` is the token from your pull secret, and `_<path_to_archive>_` is the path to the {insights-operator} archive.
|
||||
+
|
||||
If the operation is successful, the command returns a `"request_id"` and `"account_number"`:
|
||||
+
|
||||
@@ -64,10 +64,10 @@ If the operation is successful, the command returns a `"request_id"` and `"accou
|
||||
|
||||
. To display the details of the cluster, click the cluster name.
|
||||
|
||||
. Open the *Insights Advisor* tab of the cluster.
|
||||
. Open the *{red-hat-lightspeed} Advisor* tab of the cluster.
|
||||
+
|
||||
If the upload was successful, the tab displays one of the following:
|
||||
+
|
||||
* *Your cluster passed all recommendations*, if Insights Advisor did not identify any issues.
|
||||
* *Your cluster passed all recommendations*, if the {red-hat-lightspeed} advisor service did not identify any issues.
|
||||
|
||||
* A list of issues that Insights Advisor has detected, prioritized by risk (low, moderate, important, and critical).
|
||||
* A list of issues that the {red-hat-lightspeed} advisor service has detected, prioritized by risk (low, moderate, important, and critical).
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
[id="insights-operator-new-pull-secret_{context}"]
|
||||
= Disabling remote health reporting
|
||||
|
||||
You can change your existing global cluster pull secret to disable remote health reporting. This configuration disables both Telemetry and the Insights Operator.
|
||||
You can change your existing global cluster pull secret to disable remote health reporting. This configuration disables both Telemetry and the {insights-operator}.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
|
||||
@@ -71,7 +71,7 @@ You might need to wait several minutes for the secret to update and your cluster
|
||||
+
|
||||
.. Go to the *Overview* page on the {product-title} web console.
|
||||
+
|
||||
.. View the *Insights* section in the *Status* tile that reports the number of issues found.
|
||||
.. View the *{red-hat-lightspeed}* section in the *Status* tile that reports the number of issues found.
|
||||
|
||||
. For a verification check from the {oc-first}, enter the following command and then check that the value of the `status` parameter states `false`:
|
||||
+
|
||||
@@ -79,4 +79,3 @@ You might need to wait several minutes for the secret to update and your cluster
|
||||
----
|
||||
$ oc get co insights -o jsonpath='{.status.conditions[?(@.type=="Disabled")]}'
|
||||
----
|
||||
|
||||
|
||||
@@ -6,9 +6,9 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="insights-operator-one-time-gather_{context}"]
|
||||
= Running an Insights Operator gather operation
|
||||
= Running an {insights-operator} gather operation
|
||||
|
||||
You must run a gather operation to create an Insights Operator archive.
|
||||
You must run a gather operation to create an {insights-operator} archive.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="insights-operator-showing-data-collected-from-the-cluster_{context}"]
|
||||
= Showing data collected by the Insights Operator
|
||||
= Showing data collected by the {insights-operator}
|
||||
|
||||
You can review the data that is collected by the Insights Operator.
|
||||
You can review the data that is collected by the {insights-operator}.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
@@ -14,18 +14,18 @@ You can review the data that is collected by the Insights Operator.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Find the name of the currently running pod for the Insights Operator:
|
||||
. Find the name of the currently running pod for the {insights-operator}:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ 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:
|
||||
. Copy the recent data archives collected by the {insights-operator}:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ 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.
|
||||
The recent {insights-operator} archives are now available in the `insights-data` directory.
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="insights-operator-what-information-is-collected_{context}"]
|
||||
= Information collected by the Insights Operator
|
||||
= Information collected by the {insights-operator}
|
||||
|
||||
The following information is collected by the Insights Operator:
|
||||
The following information is collected by the {insights-operator}:
|
||||
|
||||
* General information about your cluster and its components to identify issues that are specific to your {product-title} version and environment.
|
||||
* Configuration files, such as the image registry configuration, of your cluster to determine incorrect settings and issues that are specific to parameters you set.
|
||||
|
||||
@@ -20,18 +20,18 @@ ifdef::operator-ref[]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The Insights Operator is an optional cluster capability that can be disabled by cluster administrators during installation. For more information about optional cluster capabilities, see "Cluster capabilities" in _Installing_.
|
||||
The {insights-operator} is an optional cluster capability that can be disabled by cluster administrators during installation. For more information about optional cluster capabilities, see "Cluster capabilities" in _Installing_.
|
||||
====
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
|
||||
The Insights Operator provides the features for the `Insights` capability.
|
||||
The {insights-operator} provides the features for the `Insights` capability.
|
||||
|
||||
endif::cluster-caps[]
|
||||
|
||||
The Insights Operator gathers {product-title} configuration data and sends it to Red Hat. The data is used to produce proactive insights recommendations about potential issues that a cluster might be exposed to. These insights are communicated to cluster administrators through the Insights advisor service on link:https://console.redhat.com/[console.redhat.com].
|
||||
The {insights-operator} gathers {product-title} configuration data and sends it to Red{nbsp}Hat. The data is used to produce proactive insights recommendations about potential issues that a cluster might be exposed to. These insights are communicated to cluster administrators through the {red-hat-lightspeed} advisor service on link:https://console.redhat.com/[console.redhat.com].
|
||||
|
||||
ifdef::operator-ref[]
|
||||
|
||||
@@ -50,7 +50,7 @@ endif::operator-ref[]
|
||||
|
||||
== Notes
|
||||
|
||||
Insights Operator complements {product-title} Telemetry.
|
||||
{insights-operator} complements {product-title} Telemetry.
|
||||
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operator-ref:
|
||||
|
||||
@@ -133,7 +133,7 @@ Using a {cluster-manager-url-pull} is not required. You can use a pull secret fo
|
||||
If you do not use the {cluster-manager-url-pull}:
|
||||
+
|
||||
* Red{nbsp}Hat Operators are not available.
|
||||
* The Telemetry and Insights operators do not send data to Red{nbsp}Hat.
|
||||
* The Telemetry and {insights-operator}s do not send data to Red{nbsp}Hat.
|
||||
* Content from the link:https://catalog.redhat.com/software/containers/explore[Red{nbsp}Hat Ecosystem Catalog Container images] registry, such as image streams and Operators, are not available.
|
||||
endif::openshift-origin[]
|
||||
|
||||
|
||||
@@ -7,8 +7,8 @@
|
||||
[id="obfuscating-deployment-validation-operator-data_{context}"]
|
||||
= Obfuscating Deployment Validation Operator data
|
||||
|
||||
By default, when you install the Deployment Validation Operator (DVO), the name and unique identifier (UID) of a resource are included in the data that is captured and processed by the Insights Operator for {product-title}.
|
||||
If you are a cluster administrator, you can configure the Insights Operator to obfuscate data from the Deployment Validation Operator (DVO).
|
||||
By default, when you install the Deployment Validation Operator (DVO), the name and unique identifier (UID) of a resource are included in the data that is captured and processed by the {insights-operator} for {product-title}.
|
||||
If you are a cluster administrator, you can configure the {insights-operator} to obfuscate data from the Deployment Validation Operator (DVO).
|
||||
For example, you can obfuscate workload names in the archive file that is then sent to Red{nbsp}Hat.
|
||||
|
||||
To obfuscate the name of resources, you must manually set the `obfuscation` attribute in the `insights-config` `ConfigMap` object to include the `workload_names` value, as outlined in the following procedure.
|
||||
|
||||
@@ -4,6 +4,6 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="ocm-insightsadvisor-tab_{context}"]
|
||||
= Insights Advisor tab
|
||||
= {red-hat-lightspeed} Advisor tab
|
||||
|
||||
The **Insights Advisor** tab uses the Remote Health functionality of the OpenShift Container Platform to identify and mitigate risks to security, performance, availability, and stability. See link:https://docs.openshift.com/container-platform/latest/support/getting-support.html[Using Insights to identify issues with your cluster] in the {OCP} documentation.
|
||||
The **{red-hat-lightspeed} Advisor** tab uses the Remote Health functionality of the OpenShift Container Platform to identify and mitigate risks to security, performance, availability, and stability. See link:https://docs.openshift.com/container-platform/latest/support/getting-support.html[Using {red-hat-lightspeed} to identify issues with your cluster] in the {OCP} documentation.
|
||||
|
||||
@@ -51,4 +51,4 @@ endif::openshift-rosa[]
|
||||
* **Network** field shows the address and prefixes for network connectivity.
|
||||
* **OIDC configuration** field shows the Open ID Connect configuration for the cluster.
|
||||
* **Resource usage** section of the tab displays the resources in use with a graph.
|
||||
* **Advisor recommendations** section gives insight in relation to security, performance, availability, and stability. This section requires the use of remote health functionality. See _Using Insights to identify issues with the cluster_ in the _Additional resources_ section.
|
||||
* **Advisor recommendations** section gives insight in relation to security, performance, availability, and stability. This section requires the use of remote health functionality. See _Using {red-hat-lightspeed} to identify issues with the cluster_ in the _Additional resources_ section.
|
||||
|
||||
@@ -131,7 +131,7 @@ endif::[]
|
||||
|
||||
|`console.redhat.com`
|
||||
|443
|
||||
|Required for telemetry and Red{nbsp}Hat Insights.
|
||||
|Required for telemetry and {red-hat-lightspeed}.
|
||||
|
||||
|`observatorium-mst.api.openshift.com`
|
||||
|443
|
||||
@@ -250,4 +250,4 @@ Alternatively, if you choose to not use a wildcard for Amazon Web Services (AWS)
|
||||
|`sftp.access.redhat.com` (Recommended)
|
||||
|22
|
||||
|The SFTP server used by `must-gather-operator` to upload diagnostic logs to help troubleshoot issues with the cluster.
|
||||
|===
|
||||
|===
|
||||
|
||||
@@ -99,7 +99,7 @@ Only {product-title} on {GCP} clusters deployed with Private Service Connect can
|
||||
|
||||
|`console.redhat.com`
|
||||
|443
|
||||
|Required for telemetry and Red{nbsp}Hat Insights.
|
||||
|Required for telemetry and {red-hat-lightspeed}.
|
||||
|
||||
|`observatorium-mst.api.openshift.com`
|
||||
|443
|
||||
@@ -198,4 +198,4 @@ OR
|
||||
[NOTE]
|
||||
====
|
||||
Required Google APIs can be exposed using the link:https://cloud.google.com/vpc-service-controls/docs/restricted-vip-services[Private Google Access restricted virtual IP (VIP)], with the exception of the Service Usage API (serviceusage.googleapis.com). To circumvent this, you must expose the Service Usage API using the link:https://cloud.google.com/vpc/docs/configure-private-google-access#domain-options[Private Google Access private VIP].
|
||||
====
|
||||
====
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="removing-filters-from-insights-recommendations_{context}"]
|
||||
= Removing filters from Insights advisor service recommendations
|
||||
= Removing filters from {red-hat-lightspeed} advisor service recommendations
|
||||
|
||||
You can apply multiple filters to the list of recommendations. When ready, you can remove them individually or completely reset them.
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ To view the history for your cluster, click the *Cluster history* tab.
|
||||
+
|
||||
* The cluster's resource usage
|
||||
|
||||
. Optional: You can view information about your cluster that Red Hat Insights collects by navigating to the *Overview* menu. From this menu you can view the following information:
|
||||
. Optional: You can view information about your cluster that {red-hat-lightspeed} collects by navigating to the *Overview* menu. From this menu you can view the following information:
|
||||
* Potential issues that your cluster might be exposed to, categorized by risk level
|
||||
+
|
||||
* Health-check status by category
|
||||
@@ -5,9 +5,9 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="running-insights-operator-gather-openshift-cli_{context}"]
|
||||
= Gathering data on demand with the Insights Operator from the OpenShift CLI
|
||||
= Gathering data on demand with the {insights-operator} from the OpenShift CLI
|
||||
|
||||
You can run a custom Insights Operator gather operation on-demand from the {product-title} command-line interface (CLI).
|
||||
You can run a custom {insights-operator} gather operation on-demand from the {product-title} command-line interface (CLI).
|
||||
An on-demand `DataGather` operation is useful for one-off data collections that require different configurations to the periodic data gathering (`InsightsDataGather`) specification.
|
||||
|
||||
Use the following procedure to create a `DataGather` custom resource definition (CRD), and then run the data gather operation on demand from the CLI.
|
||||
@@ -37,7 +37,7 @@ spec:
|
||||
[IMPORTANT]
|
||||
====
|
||||
* The name you specify for your gather operation, `<your_data_gather>`, must be unique and must not include a prefix of `periodic-gathering-` because this string is reserved for other administrative operations and might impact the intended gather operation.
|
||||
* If the `spec` of `DataGather` CRD is undefined, the default Insights Operator data collection job will run. This means that all gather operations will run, the collected data will be unobfuscated and the archive file will not be retained.
|
||||
* If the `spec` of `DataGather` CRD is undefined, the default {insights-operator} data collection job will run. This means that all gather operations will run, the collected data will be unobfuscated and the archive file will not be retained.
|
||||
====
|
||||
+
|
||||
. Optional: To customize the data gather operation, you can configure any of the following options in your `DataGather` YAML file:
|
||||
@@ -108,4 +108,4 @@ $ oc apply -f <your_data_gather_definition>.yaml
|
||||
|
||||
.Verification
|
||||
|
||||
* Check that your new gather operation is prefixed with your chosen name under the list of pods in the `openshift-insights` project. Upon completion, the Insights Operator automatically uploads the data to Red Hat for processing.
|
||||
* Check that your new gather operation is prefixed with your chosen name under the list of pods in the `openshift-insights` project. Upon completion, the {insights-operator} automatically uploads the data to Red Hat for processing.
|
||||
@@ -6,9 +6,9 @@
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
|
||||
[id="running-insights-operator-gather-web-console_{context}"]
|
||||
= Gathering data on demand with the Insights Operator from the web console
|
||||
= Gathering data on demand with the {insights-operator} from the web console
|
||||
|
||||
You can run a custom Insights Operator gather operation on-demand from the {product-title} web console. An on-demand `DataGather` operation is useful for one-off data collections that require different configurations to the periodic data gathering (`InsightsDataGather`) specification.
|
||||
You can run a custom {insights-operator} gather operation on-demand from the {product-title} web console. An on-demand `DataGather` operation is useful for one-off data collections that require different configurations to the periodic data gathering (`InsightsDataGather`) specification.
|
||||
|
||||
Use the following procedure to create a `DataGather` custom resource definition (CRD), and then run the data gather operation on demand from the web console.
|
||||
|
||||
@@ -41,7 +41,7 @@ spec:
|
||||
[IMPORTANT]
|
||||
====
|
||||
* The name you specify for your gather operation, `<your_data_gather>`, must be unique and must not include a prefix of `periodic-gathering-` because this string is reserved for other administrative operations and might impact the intended gather operation.
|
||||
* If the `spec` of `DataGather` CRD is undefined, the default Insights Operator data collection job will run. This means that all gather operations will run, the collected data will be unobfuscated and the archive file will not be retained.
|
||||
* If the `spec` of `DataGather` CRD is undefined, the default {insights-operator} data collection job will run. This means that all gather operations will run, the collected data will be unobfuscated and the archive file will not be retained.
|
||||
====
|
||||
+
|
||||
. Optional: To customize the data gather operation, you can configure any of the following options in your `DataGather` YAML file:
|
||||
@@ -108,4 +108,4 @@ spec:
|
||||
. On the console, select to *Workloads* > *Pods*.
|
||||
. On the Pods page, go to the *Project* pull-down menu, and then select *Show default projects*.
|
||||
. Select the `openshift-insights` project from the *Project* pull-down menu.
|
||||
. Check that your new gather operation is prefixed with your chosen name under the list of pods in the `openshift-insights` project. Upon completion, the Insights Operator automatically uploads the data to Red Hat for processing.
|
||||
. Check that your new gather operation is prefixed with your chosen name under the list of pods in the `openshift-insights` project. Upon completion, the {insights-operator} automatically uploads the data to Red Hat for processing.
|
||||
|
||||
@@ -33,7 +33,7 @@ From the Customer Portal, you can:
|
||||
* Access other product documentation.
|
||||
|
||||
ifndef::microshift[]
|
||||
To identify issues with your cluster, you can use Insights in {cluster-manager-url}. Insights provides details about issues and, if available, information on how to solve a problem.
|
||||
To identify issues with your cluster, you can use {red-hat-lightspeed} in {cluster-manager-url}. {red-hat-lightspeed} provides details about issues and, if available, information on how to solve a problem.
|
||||
|
||||
// TODO: verify that these settings apply for Service Mesh and OpenShift virtualization, etc.
|
||||
If you have a suggestion for improving this documentation or have found an
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
[id="telemetry-consequences-of-disabling-telemetry_{context}"]
|
||||
= Consequences of disabling remote health reporting
|
||||
|
||||
In {product-title}, customers can disable reporting usage information.
|
||||
In {product-title}, customers can disable reporting usage information.
|
||||
|
||||
Before you disable remote health reporting, read the following benefits of a connected cluster:
|
||||
|
||||
* Red{nbsp}Hat can react more quickly to problems and better support our customers.
|
||||
* Red{nbsp}Hat can better understand how product upgrades impact clusters.
|
||||
* Red{nbsp}Hat can better understand how product upgrades impact clusters.
|
||||
* Connected clusters help to simplify the subscription and entitlement process.
|
||||
* Connected clusters enable the {cluster-manager} service to offer an overview of your clusters and their subscription status.
|
||||
|
||||
@@ -26,4 +26,4 @@ ifndef::openshift-origin[]
|
||||
* You must manually enter your subscription information in the `console.redhat.com` web console without the benefit of automatic usage reporting.
|
||||
endif::[]
|
||||
|
||||
In restricted networks, Telemetry and Insights data still gets gathered through the appropriate configuration of your proxy.
|
||||
In restricted networks, Telemetry and {red-hat-lightspeed} data still gets gathered through the appropriate configuration of your proxy.
|
||||
|
||||
@@ -5,20 +5,20 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="understanding-insights-operator-alerts_{context}"]
|
||||
= Understanding Insights Operator alerts
|
||||
= Understanding {insights-operator} alerts
|
||||
|
||||
The Insights Operator declares alerts through the Prometheus monitoring system to the Alertmanager. You can view these alerts in the Alerting UI in the {product-title} web console by using one of the following methods:
|
||||
The {insights-operator} declares alerts through the Prometheus monitoring system to the Alertmanager. You can view these alerts in the Alerting UI in the {product-title} web console by using one of the following methods:
|
||||
|
||||
* In the *Administrator* perspective, click *Observe* -> *Alerting*.
|
||||
* In the *Developer* perspective, click *Observe* -> <project_name> -> *Alerts* tab.
|
||||
|
||||
Currently, Insights Operator sends the following alerts when the conditions are met:
|
||||
Currently, {insights-operator} sends the following alerts when the conditions are met:
|
||||
|
||||
.Insights Operator alerts
|
||||
.{insights-operator} alerts
|
||||
[options="header"]
|
||||
|====
|
||||
|Alert|Description
|
||||
|`InsightsDisabled`|Insights Operator is disabled.
|
||||
|`InsightsDisabled`|{insights-operator} is disabled.
|
||||
|`SimpleContentAccessNotAvailable`|Simple content access is not enabled in Red Hat Subscription Management.
|
||||
|`InsightsRecommendationActive`|Insights has an active recommendation for the cluster.
|
||||
|`InsightsRecommendationActive`|{red-hat-lightspeed} has an active recommendation for the cluster.
|
||||
|====
|
||||
|
||||
@@ -4,18 +4,18 @@
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="understanding-telemetry-and-insights-operator-data-flow_{context}"]
|
||||
= Understanding Telemetry and Insights Operator data flow
|
||||
= Understanding Telemetry and {insights-operator} data flow
|
||||
|
||||
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.
|
||||
|
||||
The Insights Operator gathers selected data from the Kubernetes API and the Prometheus API into an archive. The archive is uploaded to {cluster-manager-url} every two hours for processing. The Insights Operator also downloads the latest Insights analysis from {cluster-manager-url}. This is used to populate the *Insights status* pop-up that is included in the *Overview* page in the {product-title} web console.
|
||||
The {insights-operator} gathers selected data from the Kubernetes API and the Prometheus API into an archive. The archive is uploaded to {cluster-manager-url} every two hours for processing. The {insights-operator} also downloads the latest {red-hat-lightspeed} analysis from {cluster-manager-url}. This is used to populate the *{red-hat-lightspeed} status* pop-up that is included in the *Overview* page in the {product-title} web console.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
.Telemetry and Insights Operator data flow
|
||||
image:telmetry-and-insights-operator-data-flow.png[Telemetry and Insights Operator data flow]
|
||||
.Telemetry and {insights-operator} data flow
|
||||
image:telmetry-and-insights-operator-data-flow.png[Telemetry and {insights-operator} data flow]
|
||||
|
||||
ifdef::openshift-dedicated[]
|
||||
// TODO: Not critical for now, but should this diagram be updated to say "OpenShift Dedicated" instead of "OpenShift Container Platform"?
|
||||
|
||||
@@ -20,11 +20,11 @@ For more information about the features activated by the `TechPreviewNoUpgrade`
|
||||
|
||||
** xref:../../machine_management/cluster_api_machine_management/cluster-api-about.adoc#cluster-api-about[Managing machines with the Cluster API]
|
||||
|
||||
** xref:../../support/remote_health_monitoring/using-insights-operator.adoc#disabling-insights-operator-gather_using-insights-operator[Disabling the Insights Operator gather operations]
|
||||
** xref:../../support/remote_health_monitoring/using-insights-operator.adoc#disabling-insights-operator-gather_using-insights-operator[Disabling the {insights-operator} gather operations]
|
||||
|
||||
** xref:../../support/remote_health_monitoring/using-insights-operator.adoc#enabling-insights-operator-gather_using-insights-operator[Enabling the Insights Operator gather operations]
|
||||
** xref:../../support/remote_health_monitoring/using-insights-operator.adoc#enabling-insights-operator-gather_using-insights-operator[Enabling the {insights-operator} gather operations]
|
||||
|
||||
** xref:../../support/remote_health_monitoring/using-insights-operator.adoc#running-insights-operator-gather_using-insights-operator[Running an Insights Operator gather operation]
|
||||
** xref:../../support/remote_health_monitoring/using-insights-operator.adoc#running-insights-operator-gather_using-insights-operator[Running an {insights-operator} gather operation]
|
||||
|
||||
** xref:../../storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc#persistent-storage-csi-sc-manage[Managing the default storage class]
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ ifdef::openshift-rosa,openshift-rosa-hcp[]
|
||||
endif::[]
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
* xref:../observability/monitoring/about-ocp-monitoring/monitoring-stack-architecture.adoc#understanding-the-monitoring-stack_monitoring-stack-architecture[Understanding the monitoring stack]
|
||||
* xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster]
|
||||
* xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using {red-hat-lightspeed} to identify issues with your cluster]
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifdef::openshift-dedicated[]
|
||||
* xref:../osd_cluster_admin/osd-cluster-notifications.adoc#add-notification-contact_osd-cluster-notifications[Adding cluster notification contacts]
|
||||
|
||||
@@ -9,4 +9,4 @@ toc::[]
|
||||
|
||||
[role="_abstract"]
|
||||
[.lead]
|
||||
Welcome to the official {product-title} documentation, where you can learn about {product-title} and start exploring its features.
|
||||
Welcome to the official {product-title} documentation, where you can learn about {product-title} and start exploring its features.
|
||||
|
||||
@@ -18,7 +18,7 @@ See xref:../upgrading/rosa-hcp-upgrading.adoc#rosa-hcp-upgrading[Upgrading {prod
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Clusters created in restricted network environments may be unable to use certain {product-title} features including Red Hat Insights and Telemetry. These clusters may also experience potential failures for workloads that require public access to registries such as `quay.io`. When using clusters installed with {egress-zero}, you can also install Red Hat-owned Operators from the software catalog. For a complete list of Red Hat-owned Operators, see the link:https://catalog.redhat.com/search?searchType=software&target_platforms=Red%20Hat%20OpenShift&deployed_as=Operator&p=1&partnerName=Red%20Hat%2C%20Inc.%7CRed%20Hat[Red{nbsp}Hat Ecosystem Catalog]. Only the default Operator channel is mirrored for any Operator that is installed with {egress-zero}.
|
||||
Clusters created in restricted network environments may be unable to use certain {product-title} features including {red-hat-lightspeed} and Telemetry. These clusters may also experience potential failures for workloads that require public access to registries such as `quay.io`. When using clusters installed with {egress-zero}, you can also install Red Hat-owned Operators from the software catalog. For a complete list of Red Hat-owned Operators, see the link:https://catalog.redhat.com/search?searchType=software&target_platforms=Red%20Hat%20OpenShift&deployed_as=Operator&p=1&partnerName=Red%20Hat%2C%20Inc.%7CRed%20Hat[Red{nbsp}Hat Ecosystem Catalog]. Only the default Operator channel is mirrored for any Operator that is installed with {egress-zero}.
|
||||
====
|
||||
|
||||
[id="rosa-glossary-disconnected_{context}"]
|
||||
|
||||
@@ -20,4 +20,4 @@ include::modules/support-submitting-a-case.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
== Additional resources
|
||||
|
||||
* For details about identifying issues with your cluster, see xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster].
|
||||
* For details about identifying issues with your cluster, see xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using {red-hat-lightspeed} to identify issues with your cluster].
|
||||
|
||||
@@ -16,7 +16,7 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
[id='support-overview-remote-health-monitoring']
|
||||
== Remote health monitoring issues
|
||||
xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[Remote health monitoring issues]:
|
||||
{product-title} collects telemetry and configuration data about your cluster and reports it to Red Hat by using the Telemeter Client and the Insights Operator. Red Hat uses this data to understand and resolve issues in a _connected cluster_. Similar to connected clusters, you can xref:../support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc#remote-health-reporting-from-restricted-network[Use remote health monitoring in a restricted network]. {product-title} collects data and monitors health using the following:
|
||||
{product-title} collects telemetry and configuration data about your cluster and reports it to Red Hat by using the Telemeter Client and the {insights-operator}. Red Hat uses this data to understand and resolve issues in a _connected cluster_. Similar to connected clusters, you can xref:../support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc#remote-health-reporting-from-restricted-network[Use remote health monitoring in a restricted network]. {product-title} collects data and monitors health using the following:
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
// Removed sentence on restricted networks, not supported in ROSA/OSD
|
||||
@@ -24,7 +24,7 @@ ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
[id='support-overview-remote-health-monitoring']
|
||||
== Remote health monitoring issues
|
||||
xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[Remote health monitoring issues]:
|
||||
{product-title} collects telemetry and configuration data about your cluster and reports it to Red Hat by using the Telemeter Client and the Insights Operator. Red Hat uses this data to understand and resolve issues in a _connected cluster_. {product-title} collects data and monitors health using the following:
|
||||
{product-title} collects telemetry and configuration data about your cluster and reports it to Red{nbsp}Hat by using the Telemeter Client and the {insights-operator}. Red{nbsp}Hat uses this data to understand and resolve issues in a _connected cluster_. {product-title} collects data and monitors health using the following:
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
* *Telemetry*: The Telemetry Client gathers and uploads the metrics values to Red Hat every four minutes and thirty seconds. Red Hat uses this data to:
|
||||
@@ -33,7 +33,7 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
** Roll out {product-title} upgrades.
|
||||
** Improve the upgrade experience.
|
||||
|
||||
* *Insights Operator*: By default, {product-title} installs and enables the Insights Operator, which reports configuration and component failure status every two hours. The Insights Operator helps to:
|
||||
* *{insights-operator}*: By default, {product-title} installs and enables the {insights-operator}, which reports configuration and component failure status every two hours. The {insights-operator} helps to:
|
||||
|
||||
** Identify potential cluster issues proactively.
|
||||
** Provide a solution and preventive action in {cluster-manager-first}.
|
||||
@@ -41,7 +41,7 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
You can xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring[review telemetry information].
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
If you have enabled remote health reporting, xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Use Insights to identify issues with your cluster]. You can optionally disable remote health reporting.
|
||||
If you have enabled remote health reporting, xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using {red-hat-lightspeed} to identify issues with your cluster]. You can optionally disable remote health reporting.
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
[id='support-overview-gather-data-cluster']
|
||||
|
||||
@@ -9,19 +9,19 @@ endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
{product-title} collects telemetry and configuration data about your cluster and reports it to Red Hat by using the Telemeter Client and the Insights Operator. The data that is provided to Red Hat enables the benefits outlined in this document.
|
||||
{product-title} collects telemetry and configuration data about your cluster and reports it to Red{nbsp}Hat by using the Telemeter Client and the {insights-operator}. The data that is provided to Red{nbsp}Hat enables the benefits outlined in this document.
|
||||
|
||||
A cluster that reports data to Red Hat through Telemetry and the Insights Operator is considered a _connected cluster_.
|
||||
A cluster that reports data to Red Hat through Telemetry and the {insights-operator} is considered a _connected cluster_.
|
||||
|
||||
*Telemetry* is the term that Red Hat uses to describe the information being sent to Red Hat by the {product-title} Telemeter Client. Lightweight attributes are sent from connected clusters to Red Hat to enable subscription management automation, monitor the health of clusters, assist with support, and improve customer experience.
|
||||
|
||||
The *Insights Operator* gathers {product-title} configuration data and sends it to Red Hat. The data is used to produce insights about potential issues that a cluster might be exposed to. These insights are communicated to cluster administrators on {cluster-manager-url}.
|
||||
The *{insights-operator}* gathers {product-title} configuration data and sends it to Red{nbsp}Hat. The data is used to produce insights about potential issues that a cluster might be exposed to. These insights are communicated to cluster administrators on {cluster-manager-url}.
|
||||
|
||||
More information is provided in this document about these two processes.
|
||||
|
||||
.Telemetry and Insights Operator benefits
|
||||
.Telemetry and {insights-operator} benefits
|
||||
|
||||
Telemetry and the Insights Operator enable the following benefits for end-users:
|
||||
Telemetry and the {insights-operator} enable the following benefits for end-users:
|
||||
|
||||
* *Enhanced identification and resolution of issues*. Events that might seem normal to an end-user can be observed by Red Hat from a broader perspective across a fleet of clusters. Some issues can be more rapidly identified from this point of view and resolved without an end-user needing to open a support case or file a link:https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330&summary=Summary&issuetype=1&priority=10200&versions=12385624[Jira issue].
|
||||
|
||||
@@ -83,7 +83,7 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* The Insights Operator is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting].
|
||||
* The {insights-operator} is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting].
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
include::modules/insights-operator-what-information-is-collected.adoc[leveloffset=+2]
|
||||
@@ -92,16 +92,16 @@ include::modules/insights-operator-what-information-is-collected.adoc[leveloffse
|
||||
.Additional resources
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* See xref:../../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the Insights Operator] for details about how to review the data that is collected by the Insights Operator.
|
||||
* See xref:../../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the {insights-operator}] for details about how to review the data that is collected by the {insights-operator}.
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
* link:https://access.redhat.com/solutions/7066188[What data is being collected by the Insights Operator in OpenShift?]
|
||||
* link:https://access.redhat.com/solutions/7066188[What data is being collected by the {insights-operator} in OpenShift?]
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
* The Insights Operator source code is available for review and contribution. See the link:https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md[Insights Operator upstream project] for a list of the items collected by the Insights Operator.
|
||||
* The {insights-operator} source code is available for review and contribution. See the link:https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md[{insights-operator} upstream project] for a list of the items collected by the {insights-operator}.
|
||||
|
||||
include::modules/understanding-telemetry-and-insights-operator-data-flow.adoc[leveloffset=+1]
|
||||
|
||||
@@ -112,14 +112,14 @@ ifndef::openshift-rosa-hcp[]
|
||||
|
||||
* See xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] for more information about the {product-title} monitoring stack.
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
* See xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] for details about configuring a firewall and enabling endpoints for Telemetry and Insights
|
||||
* See xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] for details about configuring a firewall and enabling endpoints for Telemetry and {red-hat-lightspeed}
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
[id="additional-details-about-how-remote-health-monitoring-data-is-used"]
|
||||
== Additional details about how remote health monitoring data is used
|
||||
|
||||
The information collected to enable remote health monitoring is detailed in xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#what-information-is-collected_about-remote-health-monitoring[Information collected by Telemetry] and xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#insights-operator-what-information-is-collected_about-remote-health-monitoring[Information collected by the Insights Operator].
|
||||
The information collected to enable remote health monitoring is detailed in xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#what-information-is-collected_about-remote-health-monitoring[Information collected by Telemetry] and xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#insights-operator-what-information-is-collected_about-remote-health-monitoring[Information collected by the {insights-operator}].
|
||||
|
||||
As further described in the preceding sections of this document, Red Hat collects data about your use of the Red Hat Product(s) for purposes such as providing support and upgrades, optimizing performance or configuration, minimizing service impacts, identifying and remediating threats, troubleshooting, improving the offerings and user experience, responding to issues, and for billing purposes if applicable.
|
||||
|
||||
@@ -129,7 +129,7 @@ Red Hat employs technical and organizational measures designed to protect the te
|
||||
|
||||
.Sharing
|
||||
|
||||
Red Hat may share the data collected through Telemetry and the Insights Operator internally within Red Hat to improve your user experience. Red Hat may share telemetry and configuration data with its business partners in an aggregated form that does not identify customers to help the partners better understand their markets and their customers' use of Red Hat offerings or to ensure the successful integration of products jointly supported by those partners.
|
||||
Red{nbsp}Hat might share the data collected through Telemetry and the {insights-operator} internally within Red Hat to improve your user experience. Red{nbsp}Hat might share telemetry and configuration data with its business partners in an aggregated form that does not identify customers to help the partners better understand their markets and their customers' use of Red{nbsp}Hat offerings or to ensure the successful integration of products jointly supported by those partners.
|
||||
|
||||
.Third parties
|
||||
|
||||
@@ -138,5 +138,5 @@ Red Hat may engage certain third parties to assist in the collection, analysis,
|
||||
.User control / enabling and disabling telemetry and configuration data collection
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
You may disable {product-title} Telemetry and the Insights Operator by following the instructions in xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting].
|
||||
You may disable {product-title} Telemetry and the {insights-operator} by following the instructions in xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting].
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="insights-operator-simple-access"]
|
||||
= Importing simple content access entitlements with Insights Operator
|
||||
= Importing simple content access entitlements with {insights-operator}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: remote-health-reporting-from-restricted-network
|
||||
:FeatureName: `InsightsOperatorPullingSCA`
|
||||
|
||||
toc::[]
|
||||
|
||||
Insights Operator periodically imports your simple content access entitlements from {cluster-manager-url} and stores them in the `etc-pki-entitlement` secret in the `openshift-config-managed` namespace. Simple content access is a capability in Red Hat subscription tools which simplifies the behavior of the entitlement tooling. This feature makes it easier to consume the content provided by your Red Hat subscriptions without the complexity of configuring subscription tooling.
|
||||
{insights-operator} periodically imports your simple content access entitlements from {cluster-manager-url} and stores them in the `etc-pki-entitlement` secret in the `openshift-config-managed` namespace. Simple content access is a capability in Red{nbsp}Hat subscription tools that simplifies the behavior of the entitlement tooling. This feature makes it easier to consume the content provided by your Red{nbsp}Hat subscriptions without the complexity of configuring subscription tooling.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Previously, a cluster administrator would create or edit the Insights Operator configuration using a *support secret* in the `openshift-config` namespace. Red Hat Insights now supports the creation of a `ConfigMap` object to configure the Operator. The Operator gives preference to the config map configuration over the support secret if both exist.
|
||||
Previously, a cluster administrator would create or edit the {insights-operator} configuration using a *support secret* in the `openshift-config` namespace. {red-hat-lightspeed} now supports the creation of a `ConfigMap` object to configure the {insights-operator}. The {insights-operator} gives preference to the config map configuration over the support secret if both exist.
|
||||
====
|
||||
|
||||
The Insights Operator imports simple content access entitlements every eight hours, but can be configured or disabled using the *insights-config* `ConfigMap` object in the `openshift-insights` namespace.
|
||||
The {insights-operator} imports simple content access entitlements every eight hours, but can be configured or disabled using the *insights-config* `ConfigMap` object in the `openshift-insights` namespace.
|
||||
|
||||
[NOTE]
|
||||
=====
|
||||
@@ -34,4 +34,4 @@ include::modules/insights-operator-configuring-sca.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/insights-operator-disabling-sca.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/insights-operator-enabling-sca.adoc[leveloffset=+1]
|
||||
include::modules/insights-operator-enabling-sca.adoc[leveloffset=+1]
|
||||
|
||||
@@ -6,14 +6,14 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
You can manually gather and upload Insights Operator archives to diagnose issues from a restricted network.
|
||||
You can manually gather and upload {insights-operator} archives to diagnose issues from a restricted network.
|
||||
|
||||
To use the Insights Operator in a restricted network, you must:
|
||||
To use the {insights-operator} in a restricted network, you must:
|
||||
|
||||
* Create a copy of your Insights Operator archive.
|
||||
* Upload the Insights Operator archive to link:https://console.redhat.com[console.redhat.com].
|
||||
* Create a copy of your {insights-operator} archive.
|
||||
* Upload the {insights-operator} archive to link:https://console.redhat.com[console.redhat.com].
|
||||
|
||||
Additionally, you can select to xref:../../support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc#insights-operator-enable-obfuscation_remote-health-reporting-from-restricted-network[obfuscate] the Insights Operator data before upload.
|
||||
Additionally, you can select to xref:../../support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc#insights-operator-enable-obfuscation_remote-health-reporting-from-restricted-network[obfuscate] the {insights-operator} data before upload.
|
||||
|
||||
include::modules/insights-operator-one-time-gather.adoc[leveloffset=+1]
|
||||
|
||||
@@ -24,4 +24,4 @@ include::modules/insights-operator-enable-obfuscation.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* For more information on how to download your Insights Operator archive, see xref:../../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the Insights Operator].
|
||||
* For more information on how to download your {insights-operator} archive, see xref:../../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the {insights-operator}].
|
||||
|
||||
@@ -9,7 +9,7 @@ endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
As an administrator, you can review the metrics collected by Telemetry and the Insights Operator.
|
||||
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]
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="using-insights-operator"]
|
||||
= Using the Insights Operator
|
||||
= Using the {insights-operator}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
ifdef::openshift-dedicated[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
@@ -9,16 +9,16 @@ endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
The Insights Operator periodically gathers configuration and component failure status and, by default, reports that data every two hours to Red Hat. This information enables Red Hat to assess configuration and deeper failure data than is reported through Telemetry. Users of {product-title} can display the report in the {insights-advisor-url} service on {hybrid-console}.
|
||||
The {insights-operator} periodically gathers configuration and component failure status and, by default, reports that data every two hours to Red{nbsp}Hat. This information enables Red{nbsp}Hat to assess configuration and deeper failure data than is reported through Telemetry. Users of {product-title} can display the report in the {insights-advisor-url} service on {hybrid-console}.
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* The Insights Operator is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting].
|
||||
* The {insights-operator} is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting].
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
* For more information on using the Insights advisor service to identify issues with your cluster, see xref:../../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster].
|
||||
* For more information on using the {red-hat-lightspeed} advisor service to identify issues with your cluster, see xref:../../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using {red-hat-lightspeed} to identify issues with your cluster].
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
include::modules/insights-operator-configuring.adoc[leveloffset=+1]
|
||||
@@ -41,9 +41,9 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
// tech preview feature
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
[id="running-insights-operator-gather_using-insights-operator"]
|
||||
== Running an Insights Operator gather operation on-demand
|
||||
== Running an {insights-operator} gather operation on-demand
|
||||
|
||||
Instead of waiting for the next periodic data gather operation, you can run a custom on-demand Insights Operator data gather operation by using the {product-title} web console or command-line interface (CLI).
|
||||
Instead of waiting for the next periodic data gather operation, you can run a custom on-demand {insights-operator} data gather operation by using the {product-title} web console or command-line interface (CLI).
|
||||
|
||||
A periodic data gather operation uses the `InsightsDataGather` custom resource definition (CRD) for configuration instructions, whereas an on-demand equivalent requires a `DataGather` CRD to be configured.
|
||||
|
||||
@@ -56,21 +56,21 @@ An on-demand `DataGather` operation is:
|
||||
|
||||
You can optionally customize the following items for the on-demand data gather operation:
|
||||
|
||||
* *Enable and define data obfuscation:* By defining the `DataGather` `dataPolicy` specification, you can enable additional obfuscation of the Insights archive data, for example, the IP address or workload names.
|
||||
* *Enable and define data obfuscation:* By defining the `DataGather` `dataPolicy` specification, you can enable additional obfuscation of the {red-hat-lightspeed} archive data, for example, the IP address or workload names.
|
||||
|
||||
* *Enable persistant storage:* By default, the Insights Operator uses ephemeral storage, which means that a new pod will be created for each gather operation and the history of gather operations and data collected is not retained. You can switch to persistent storage to retain the data and history for up to the last 10 gather operations by defining the `DataGather` `storage` specification in the CRD.
|
||||
* *Enable persistant storage:* By default, the {insights-operator} uses ephemeral storage, which means that a new pod will be created for each gather operation and the history of gather operations and data collected is not retained. You can switch to persistent storage to retain the data and history for up to the last 10 gather operations by defining the `DataGather` `storage` specification in the CRD.
|
||||
|
||||
* *Exclude specific data gather operations:* You can choose to disable specific gather operations from running by defining the `DataGather` `gatherers` specification. For example, you can choose to disable the cluster authentication operation or the workload data operation.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Excluding gather operations from the default list might reduce or limit the recommendations offered by the Insights Advisor for your cluster.
|
||||
Excluding gather operations from the default list might reduce or limit the recommendations offered by the {red-hat-lightspeed} advisor service for your cluster.
|
||||
====
|
||||
|
||||
|
||||
If you do not configure any custom specification options in the `DataGather` CRD, the default Insights Operator data collection job will run. This means that all gather operations will run, the collected data will be unobfuscated and the archive file will not be retained.
|
||||
If you do not configure any custom specification options in the `DataGather` CRD, the default {insights-operator} data collection job will run. This means that all gather operations will run, the collected data will be unobfuscated and the archive file will not be retained.
|
||||
|
||||
When you run a gather operation on-demand, any configuration that was previously applied to disable Insights Operator gather operations for your cluster will be overridden.
|
||||
When you run a gather operation on-demand, any configuration that was previously applied to disable {insights-operator} gather operations for your cluster will be overridden.
|
||||
|
||||
|
||||
:FeatureName: The `DataGather` custom resource
|
||||
@@ -78,7 +78,7 @@ include::snippets/technology-preview.adoc[]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If you enable Technology Preview in your cluster, the Insights Operator runs gather operations in individual pods. This is part of the Technology Preview feature set for the Insights Operator and supports the new data gathering features.
|
||||
If you enable Technology Preview in your cluster, the {insights-operator} runs gather operations in individual pods. This is part of the Technology Preview feature set for the {insights-operator} and supports the new data gathering features.
|
||||
====
|
||||
include::modules/insights-operator-gather-duration.adoc[leveloffset=+2]
|
||||
include::modules/running-insights-operator-gather-web-console.adoc[leveloffset=+2]
|
||||
@@ -87,7 +87,7 @@ include::modules/running-insights-operator-gather-cli.adoc[leveloffset=+2]
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md[Insights Operator Gathered Data GitHub repository]
|
||||
* link:https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md[{insights-operator} Gathered Data GitHub repository]
|
||||
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
// cannot list resource "secrets" in API group "" in the namespace "openshift-config"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="using-insights-to-identify-issues-with-your-cluster"]
|
||||
= Using Insights to identify issues with your cluster
|
||||
= Using {red-hat-lightspeed} to identify issues with your cluster
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
ifdef::openshift-dedicated[]
|
||||
include::_attributes/attributes-openshift-dedicated.adoc[]
|
||||
@@ -9,7 +9,7 @@ endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
Insights repeatedly analyzes the data Insights Operator sends, which includes workload recommendations from Deployment Validation Operator (DVO). Users of {product-title} can display the results in the {insights-advisor-url} service on {hybrid-console}.
|
||||
{red-hat-lightspeed} repeatedly analyzes the data {insights-operator} sends, which includes workload recommendations from Deployment Validation Operator (DVO). Users of {product-title} can display the results in the {insights-advisor-url} service on {hybrid-console}.
|
||||
|
||||
include::modules/insights-operator-advisor-overview.adoc[leveloffset=+1]
|
||||
include::modules/insights-operator-advisor-recommendations.adoc[leveloffset=+1]
|
||||
|
||||
@@ -18,7 +18,7 @@ Note the following limitations when working with Windows nodes managed by the WM
|
||||
** Hosted Control Planes
|
||||
|
||||
* The following Red Hat features are not supported on Windows nodes:
|
||||
** link:https://docs.redhat.com/en/documentation/cost_management_service/1-latest[Red Hat Insights cost management]
|
||||
** link:https://docs.redhat.com/en/documentation/cost_management_service/1-latest[{red-hat-lightspeed} cost management]
|
||||
** link:https://developers.redhat.com/products/openshift-local/overview[Red Hat OpenShift Local]
|
||||
|
||||
* Dual NIC is not supported on WMCO-managed Windows instances.
|
||||
|
||||
Reference in New Issue
Block a user