Merge pull request #41968 from xJustin/advisor-new-procedures

kalexand-rh · web-flow · commit f6e768487c03 · 2022-03-04T09:52:05.000-05:00
CCXDEV-7143 Assessing and managing issues with advisor
diff --git a/modules/disabling-insights-advisor-recommendations.adoc b/modules/disabling-insights-advisor-recommendations.adoc
@@ -0,0 +1,31 @@
+// Module included in the following assemblies:
+//
+// * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
+
+:_content-type: PROCEDURE
+[id="disabling-insights-advisor-recommendations_{context}"]
+= Disabling Insights Advisor 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. 
+
+[NOTE]
+====
+Disabling a recommendation for all of your clusters also applies to any future clusters. 
+====
+
+.Prerequisites
+
+* Remote health reporting is enabled, which is the default.
+* Your cluster is registered on link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
+* You are logged in to link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
+
+.Procedure
+
+. Navigate to *Advisor* -> *Recommendations* on link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
+. Click the name of the recommendation to disable. You are directed to the single recommendation page. 
+. To disable the recommendation for a single cluster:
+.. Click the *Options* menu {kebab} for that cluster, and then click *Disable recommendation for cluster*.
+.. Enter a justification note and click *Save*. 
+. To disable the recommendation for all of your clusters:
+.. Click *Actions* -> *Disable recommendation*. 
+.. Enter a justification note and click *Save*. 
diff --git a/modules/displaying-all-insights-advisor-recommendations.adoc b/modules/displaying-all-insights-advisor-recommendations.adoc
@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
+
+:_content-type: PROCEDURE
+[id="displaying-all-insights-advisor-recommendations_{context}"]
+= Displaying all Insights Advisor 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.
+
+.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.
+* You are logged in to link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
+
+.Procedure 
+
+. Navigate to *Advisor* -> *Recommendations* on link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
+. Click the *X* icons next to the *Clusters Impacted* and *Status* filters.
++ 
+You can now browse through all of the potential recommendations for your cluster. 
diff --git a/modules/displaying-potential-issues-with-your-cluster.adoc b/modules/displaying-potential-issues-with-your-cluster.adoc
@@ -6,32 +6,28 @@
 [id="displaying-potential-issues-with-your-cluster_{context}"]
 = Displaying potential issues with your cluster
 
-This section describes how to display the Insights report in {cluster-manager-url}.
+This section describes how to display the Insights report in *Insights Advisor* on link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
 
 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.
 
 .Prerequisites
 
-* Your cluster is registered in {cluster-manager-url}.
+* Your cluster is registered on link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
 * Remote health reporting is enabled, which is the default.
-* You are logged in to {cluster-manager-url}.
+* You are logged in to link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
 
 .Procedure
 
-. Click the *Clusters* menu in the left pane.
-
-. Click the cluster's name to display the details of the cluster.
-
-. Open the *Insights* tab of the cluster.
+. Navigate to *Advisor* -> *Recommendations* on link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
 +
-Depending on the result, the tab displays one of the following:
+Depending on the result, Insights Advisor displays one of the following:
 +
-* *Your cluster passed all health checks*, if Insights did not identify any issues.
-
-* A list of issues Insights has detected, prioritized by risk (low, moderate, important, and critical).
-
-* *No health checks to display*, if Insights has not yet analyzed the cluster. The analysis starts shortly after the cluster has been installed and connected to the internet.
+* *No matching recommendations found*, if Insights did not identify any issues.
++
+* A list of issues Insights 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.
 
-. If any issues are displayed on the tab, click the *>* icon in front of the entry for further details.
+. If any issues are displayed, click the *>* icon in front of the entry for more details.
 +
-Depending on the issue, the details can also contain a link to an Red Hat Knowledge Base article. For details and information on how to solve the problem, click *How to remediate this issue*.
+Depending on the issue, the details can also contain a link to more information from Red Hat about the issue.
diff --git a/modules/displaying-the-insights-status-in-the-web-console.adoc b/modules/displaying-the-insights-status-in-the-web-console.adoc
@@ -20,4 +20,4 @@ Insights repeatedly analyzes your cluster and you can display the status of iden
 
 . Click *Insights* on the *Status* card.
 +
-The pop-up window lists potential issues grouped by priority. Click the individual categories or *View all in {product-title}* to display further details.
+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.
diff --git a/modules/enabling-insights-advisor-recommendations.adoc b/modules/enabling-insights-advisor-recommendations.adoc
@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
+
+:_content-type: PROCEDURE
+[id="enabling-insights-advisor-recommendations_{context}"]
+= Enabling a previously disabled Insights Advisor recommendation
+
+When a recommendation is disabled for all clusters, you will no longer see the recommendation in Insights Advisor. You can change this behavior.
+
+.Prerequisites
+
+* Remote health reporting is enabled, which is the default.
+* Your cluster is registered on link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
+* You are logged in to link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
+
+.Procedure
+
+. Navigate to *Advisor* -> *Recommendations* on link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
+. Filter the recommendations by *Status* -> *Disabled*.
+. Locate the recommendation to enable.
+. Click the *Options* menu {kebab}, and then click *Enable recommendation*.
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,9 +9,12 @@ endif::[]
 
 toc::[]
 
-Insights repeatedly analyzes the data Insights Operator sends. Users of {product-title} can display the report on the *Insights* tab of each cluster in {cluster-manager-url}.
+Insights repeatedly analyzes the data Insights Operator sends. Users of {product-title} can display the report in the *Insights* tab of each cluster on link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
 
 include::modules/insights-operator-advisor-overview.adoc[leveloffset=+1]
 include::modules/insights-operator-advisor-recommendations.adoc[leveloffset=+1]
 include::modules/displaying-potential-issues-with-your-cluster.adoc[leveloffset=+1]
+include::modules/displaying-all-insights-advisor-recommendations.adoc[leveloffset=+1]
+include::modules/disabling-insights-advisor-recommendations.adoc[leveloffset=+1]
+include::modules/enabling-insights-advisor-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,4 +20,4 @@ Insights repeatedly analyzes your cluster and you can display the status of iden`
`20`	`20`
`21`	`21`	`. Click Insights on the Status card.`
`22`	`22`	`+`
`23`		`-The pop-up window lists potential issues grouped by priority. Click the individual categories or View all in {product-title} to display further details.`
	`23`	`+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.`