Add DVO, workloads mentions, link to new "Exclude" proc

mmcclaingithub · mmcclaingithub · commit 289cb824c7af · 2025-05-27T03:11:14.000-04:00
- About workloads section

Changed
- Added mentions of workloads and DVO to existing sections
- Added link to DVO and Identifying workloads sections of Insights docs

Add changes based on OpenShift style and attributes

Add an additional style change

Capitalize Concept in content type

Change Insights Advisor to Insights advisor service
diff --git a/installing/install_config/configuring-firewall.adoc b/installing/install_config/configuring-firewall.adoc
@@ -6,8 +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 Insights, the Telemetry service, a cloud to host your cluster, and certain build strategies.
 
 include::modules/configuring-firewall.adoc[leveloffset=+1]
 
diff --git a/modules/about-insights-advisor-workload-recommendations.adoc b/modules/about-insights-advisor-workload-recommendations.adoc
@@ -0,0 +1,16 @@
+// Module included in the following assemblies:
+//
+// * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="about-insights-advisor-workload-recommendations_{context}"]
+= About Insights 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:
+
+* 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]
+
diff --git a/modules/disabling-insights-advisor-recommendations.adoc b/modules/disabling-insights-advisor-recommendations.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="disabling-insights-advisor-recommendations_{context}"]
-= Disabling Insights Advisor recommendations
+= Disabling Insights 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.
 
diff --git a/modules/disabling-insights-operator-gather.adoc b/modules/disabling-insights-operator-gather.adoc
@@ -75,5 +75,5 @@ After you save the changes, the Insights Operator gather configurations are upda
 
 [NOTE]
 ====
-Disabling gather operations degrades Insights Advisor's ability to offer effective recommendations for your cluster.
+Disabling gather operations degrades the Insights advisor service's ability to offer effective recommendations for your cluster.
 ====
diff --git a/modules/displaying-all-insights-advisor-recommendations.adoc b/modules/displaying-all-insights-advisor-recommendations.adoc
@@ -4,14 +4,14 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="displaying-all-insights-advisor-recommendations_{context}"]
-= Displaying all Insights Advisor recommendations
+= Displaying all Insights 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 archive.
+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.
 
 .Prerequisites
 
 * Remote health reporting is enabled, which is the default.
-* Your cluster is link:https://console.redhat.com/openshift/register[registered] on Red Hat Hybrid Cloud Console.
+* Your cluster is link:https://console.redhat.com/openshift/register[registered] on {hybrid-console}.
 * You are logged in to {cluster-manager-url}.
 
 .Procedure
diff --git a/modules/displaying-potential-issues-with-your-cluster.adoc b/modules/displaying-potential-issues-with-your-cluster.adoc
@@ -20,7 +20,7 @@ Note that Insights repeatedly analyzes your cluster and shows the latest results
 
 . Navigate to *Advisor* -> *Recommendations* on {cluster-manager-url}.
 +
-Depending on the result, Insights Advisor displays one of the following:
+Depending on the result, the Insights advisor service displays one of the following:
 +
 * *No matching recommendations found*, if Insights did not identify any issues.
 +
diff --git a/modules/enabling-insights-advisor-recommendations.adoc b/modules/enabling-insights-advisor-recommendations.adoc
@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="enabling-insights-advisor-recommendations_{context}"]
-= Enabling a previously disabled Insights Advisor recommendation
+= Enabling a previously disabled Insights advisor service recommendation
 
-When a recommendation is disabled for all clusters, you no longer see the recommendation in the Insights Advisor. You can change this behavior.
+When a recommendation is disabled for all clusters, you no longer see the recommendation in the Insights advisor service. You can change this behavior.
 
 .Prerequisites
 
diff --git a/modules/filtering-insights-advisor-recommendations.adoc b/modules/filtering-insights-advisor-recommendations.adoc
@@ -4,17 +4,17 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="filtering-unnecessary-advisor-recommendations_{context}"]
-= Filtering Insights advisor recommendations
+= Filtering Insights 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.
 
 The following procedure demonstrates how to set and remove *Category* filters; however, the procedure is applicable to any of the filter types and respective values. 
 
 .Prerequisites
-You are logged in to the https://console.redhat.com/openshift[OpenShift Cluster Manager Hybrid Cloud Console].
+You are logged in to the https://console.redhat.com/openshift[{cluster-manager}] in the {hybrid-console-second}.
 
 .Procedure
-. Go to *Red Hat Hybrid Cloud Console* -> *OpenShift* -> *Advisor recommendations*.
+. Go to link:https://console.redhat.com/openshift/insights/advisor/recommendations?[*OpenShift* > *Advisor* > *Recommendations*].
 . In the main, filter-type drop-down list, select the *Category* filter type.
 . Expand the filter-value drop-down list and select the checkbox next to each category of recommendation you want to view. Leave the checkboxes for unnecessary categories clear.
 . Optional: Add additional filters to further refine the list.
diff --git a/modules/insights-operator-advisor-overview.adoc b/modules/insights-operator-advisor-overview.adoc
@@ -6,11 +6,19 @@
 [id="insights-operator-advisor-overview_{context}"]
 = About Red Hat Insights Advisor for {product-title}
 
-You can use Insights Advisor 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 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.
 
-Using cluster data collected by the Insights Operator, Insights repeatedly compares that data against a library of _recommendations_. Each recommendation is a set of cluster-environment conditions that can leave {product-title} clusters at risk. The results of the Insights analysis are available in the Insights Advisor service on Red Hat Hybrid Cloud Console. In the Console, you can perform the following actions:
+If the cluster has the Deployment Validation Operator (DVO) installed the recommendations also highlight workloads whose configuration might lead to cluster health issues.
 
-* See clusters impacted by a specific recommendation.
+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:
+
+
+* View clusters and workloads affected by specific recommendations.
 * Use robust filtering capabilities to refine your results to those recommendations.
 * Learn more about individual recommendations, details about the risks they present, and get resolutions tailored to your individual clusters.
 * Share results with other stakeholders.
+
+.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]
+
diff --git a/modules/insights-operator-advisor-recommendations.adoc b/modules/insights-operator-advisor-recommendations.adoc
@@ -6,12 +6,11 @@
 [id="insights-operator-advisor-recommendations_{context}"]
 = Understanding Insights Advisor recommendations
 
-Insights Advisor bundles information about various cluster states and component configurations that can negatively affect the service availability, fault tolerance, performance, or security of your clusters. This information set is called a recommendation in Insights Advisor and includes the following information:
+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:
 
 * *Name:* A concise description of the recommendation
-* *Added:* When the recommendation was published to the Insights Advisor archive
+* *Added:* When the recommendation was published to the Insights 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 infrastructure, and the _impact_ on operations if that were to happen
+* *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
 * *Description:* A brief synopsis of the issue, including how it affects your clusters
-* *Link to associated topics:* More information from Red Hat about the issue
diff --git a/modules/insights-operator.adoc b/modules/insights-operator.adoc
@@ -34,7 +34,7 @@ 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 Insights Advisor on link:https://console.redhat.com/[console.redhat.com].
+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].
 
 ifdef::operator-ref[]
 
diff --git a/modules/removing-filters-from-insights-advisor-recommendations.adoc b/modules/removing-filters-from-insights-advisor-recommendations.adoc
@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="removing-filters-from-insights-recommendations_{context}"]
-= Removing filters from Insights Advisor recommendations
+= Removing filters from Insights advisor service recommendations
 
 You can apply multiple filters to the list of recommendations. When ready, you can remove them individually or completely reset them.
 
diff --git a/rest_api/operator_apis/insightsoperator-operator-openshift-io-v1.adoc b/rest_api/operator_apis/insightsoperator-operator-openshift-io-v1.adoc
@@ -472,7 +472,7 @@ Required::
 
 | `state`
 | `string`
-| state determines what the current state of the health check is. Health check is enabled by default and can be disabled by the user in the Insights advisor user interface.
+| state determines what the current state of the health check is. Health check is enabled by default and can be disabled by the user in the Insights advisor service's user interface.
 
 | `totalRisk`
 | `integer`
diff --git a/support/index.adoc b/support/index.adoc
@@ -40,7 +40,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].
 
-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]. 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[Use Insights to identify issues with your cluster]. You can optionally disable remote health reporting.
 
 [id='support-overview-gather-data-cluster']
 == Gather data about your cluster
diff --git a/support/remote_health_monitoring/using-insights-operator.adoc b/support/remote_health_monitoring/using-insights-operator.adoc
@@ -18,7 +18,7 @@ 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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting].
 endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 
-* For more information on using Insights Advisor 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 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].
 
 ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 include::modules/insights-operator-configuring.adoc[leveloffset=+1]
diff --git a/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc b/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
@@ -9,7 +9,7 @@ endif::[]
 
 toc::[]
 
-Insights repeatedly analyzes the data Insights Operator sends. Users of {product-title} can display the report in the {insights-advisor-url} service on {hybrid-console}.
+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}.
 
 include::modules/insights-operator-advisor-overview.adoc[leveloffset=+1]
 include::modules/insights-operator-advisor-recommendations.adoc[leveloffset=+1]
@@ -20,4 +20,5 @@ include::modules/filtering-insights-advisor-recommendations.adoc[leveloffset=+2]
 include::modules/removing-filters-from-insights-advisor-recommendations.adoc[leveloffset=+2]
 include::modules/disabling-insights-advisor-recommendations.adoc[leveloffset=+1]
 include::modules/enabling-insights-advisor-recommendations.adoc[leveloffset=+1]
+include::modules/about-insights-advisor-workload-recommendations.adoc[leveloffset=+1]
 include::modules/displaying-the-insights-status-in-the-web-console.adoc[leveloffset=+1]

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ Note that Insights repeatedly analyzes your cluster and shows the latest results`
`20`	`20`
`21`	`21`	`. Navigate to Advisor -> Recommendations on {cluster-manager-url}.`
`22`	`22`	`+`
`23`		`-Depending on the result, Insights Advisor displays one of the following:`
	`23`	`+Depending on the result, the Insights advisor service displays one of the following:`
`24`	`24`	`+`
`25`	`25`	`* No matching recommendations found, if Insights did not identify any issues.`
`26`	`26`	`+`