Skip to content

Commit 5a673d5

Browse files
mburke5678mburke5678
authored
Merge pull request #63644 from mburke5678/support-insights-fix-errors
Support Remote Health docs fixes during ROSA review
2 parents 92e47a3 + 2370b4f commit 5a673d5

16 files changed

+272
-33
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -687,7 +687,7 @@ Topics:
687687
File: enabling-remote-health-reporting
688688
- Name: Using Insights to identify issues with your cluster
689689
File: using-insights-to-identify-issues-with-your-cluster
690-
- Name: Using Insights Operator
690+
- Name: Using the Insights Operator
691691
File: using-insights-operator
692692
- Name: Using remote health reporting in a restricted network
693693
File: remote-health-reporting-from-restricted-network

‎modules/disabling-insights-advisor-recommendations.adoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,15 @@ Disabling a recommendation for all of your clusters also applies to any future c
2222
.Procedure
2323

2424
. Navigate to *Advisor* -> *Recommendations* on {cluster-manager-url}.
25-
. Click the name of the recommendation to disable. You are directed to the single recommendation page.
26-
. To disable the recommendation for a single cluster:
27-
.. Click the *Options* menu {kebab} for that cluster, and then click *Disable recommendation for cluster*.
25+
. Optional: Use the *Clusters Impacted* and *Status* filters as needed.
26+
. Disable an alert by using one of the following methods:
27+
+
28+
* To disable an alert:
29+
.. Click the *Options* menu {kebab} for that alert, and then click *Disable recommendation*.
2830
.. Enter a justification note and click *Save*.
29-
. To disable the recommendation for all of your clusters:
30-
.. Click *Actions* -> *Disable recommendation*.
31+
+
32+
* To view the clusters affected by this alert before disabling the alert:
33+
.. Click the name of the recommendation to disable. You are directed to the single recommendation page.
34+
.. Review the list of clusters in the *Affected clusters* section.
35+
.. Click *Actions* -> *Disable recommendation* to disable the alert for all of your clusters.
3136
.. Enter a justification note and click *Save*.

‎modules/disabling-insights-operator-alerts.adoc

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,41 @@
77
[id="disabling-insights-operator-alerts_{context}"]
88
= Disabling Insights Operator alerts
99

10-
You can stop Insights Operator from firing alerts to the cluster Prometheus instance.
10+
ifndef::openshift-rosa,openshift-dedicated[]
11+
To prevent the Insights Operator from sending alerts to the cluster Prometheus instance, you edit the `support` secret. If the `support` secret doesn't exist, you must create it when you first add custom configurations. Note that configurations within the `support` secret take precedence over the default settings defined in the `pod.yaml` file.
12+
endif::openshift-rosa,openshift-dedicated[]
13+
ifndef::openshift-rosa,openshift-dedicated[]
14+
To prevent the Insights Operator from sending alerts to the cluster Prometheus instance, you edit the `support` secret. Note that this `secret` is created by default. The configurations stored in the support secret take precedence over any default settings specified in the `pod.yaml` file.
15+
endif::openshift-rosa,openshift-dedicated[]
16+
17+
.Prerequisites
18+
19+
* Remote health reporting is enabled, which is the default.
20+
ifndef::openshift-rosa,openshift-dedicated[]
21+
* You are logged in to the {product-title} web console as `cluster-admin`.
22+
endif::openshift-rosa,openshift-dedicated[]
23+
ifdef::openshift-rosa,openshift-dedicated[]
24+
* You are logged in to the {product-title} web console as a user with the `dedicated-admin` role.
25+
endif::openshift-rosa,openshift-dedicated[]
26+
27+
.Procedure
1128

1229
. Navigate to *Workloads* -> *Secrets*.
1330
. On the *Secrets* page, select *All Projects* from the *Project* list, and then set *Show default projects* to on.
1431
. Select the *openshift-config* project from the *Projects* list.
15-
. Search for the *support* secret using the *Search by name* field. If the secret does not exist, click *Create* -> *Key/value secret* to create it.
32+
. Search for the *support* secret by using the *Search by name* field.
33+
+
34+
* If the secret exists:
1635
. Click the *Options* menu {kebab}, and then click *Edit Secret*.
1736
. Click *Add Key/Value*.
18-
. Enter `disableInsightsAlerts` as the key with the value `True`, and click *Save*.
37+
.. In the *Key* field, enter `disableInsightsAlerts`.
38+
.. In the *Value* field, enter `True`.
39+
+
40+
* If the secret does not exist:
41+
.. Click *Create* -> *Key/value secret*.
42+
... In the *Secret name* field, enter `support`.
43+
... In the *Key* field, enter `disableInsightsAlerts`.
44+
... In the *Value* field, enter `True`.
45+
.. Click *Create*.
1946

20-
After you save the changes, Insights Operator will no longer send alerts to the cluster Prometheus instance.
47+
After you save the changes, Insights Operator no longer sends alerts to the cluster Prometheus instance.

‎modules/disabling-insights-operator-gather.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ endif::openshift-rosa,openshift-dedicated[]
3232
. On the *CustomResourceDefinitions* page, use the *Search by name* field to find the *InsightsDataGather* resource definition and click it.
3333
. On the *CustomResourceDefinition details* page, click the *Instances* tab.
3434
. Click *cluster*, and then click the *YAML* tab.
35-
. To disable all the gather operations, edit the `InsightsDataGather` configuration file:
35+
. Disable the gather operations by performing one of the following edits to the `InsightsDataGather` configuration file:
36+
.. To disable all the gather operations, enter `all` under the `disabledGatherers` key:
3637
+
3738
[source,yaml]
3839
----
@@ -51,7 +52,8 @@ spec: <1>
5152
<1> The `spec` parameter specifies gather configurations.
5253
<2> The `all` value disables all gather operations.
5354
--
54-
To disable individual gather operations, enter their values under the `disabledGatherers` key:
55+
56+
.. To disable individual gather operations, enter their values under the `disabledGatherers` key:
5557
+
5658
[source,yaml]
5759
----

‎modules/displaying-the-insights-status-in-the-web-console.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
4+
// * sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
45

56
:_content-type: PROCEDURE
67
[id="displaying-the-insights-status-in-the-web-console_{context}"]

‎modules/enabling-insights-advisor-recommendations.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="enabling-insights-advisor-recommendations_{context}"]
77
= Enabling a previously disabled Insights Advisor recommendation
88

9-
When a recommendation is disabled for all clusters, you will no longer see the recommendation in Insights Advisor. You can change this behavior.
9+
When a recommendation is disabled for all clusters, you no longer see the recommendation in the Insights Advisor. You can change this behavior.
1010

1111
.Prerequisites
1212

@@ -17,6 +17,9 @@ When a recommendation is disabled for all clusters, you will no longer see the r
1717
.Procedure
1818

1919
. Navigate to *Advisor* -> *Recommendations* on {cluster-manager-url}.
20-
. Filter the recommendations by *Status* -> *Disabled*.
20+
. Filter the recommendations to display on the disabled recommendations:
21+
.. From the *Status* drop-down menu, select *Status*.
22+
.. From the *Filter by status* drop-down menu, select *Disabled*.
23+
.. Optional: Clear the *Clusters impacted* filter.
2124
. Locate the recommendation to enable.
2225
. Click the *Options* menu {kebab}, and then click *Enable recommendation*.

‎modules/enabling-insights-operator-alerts.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * support/remote_health_monitoring/using-insights-operator.adoc
4+
5+
6+
:_content-type: CONCEPT
7+
[id="enabling-insights-operator-alerts_{context}"]
8+
= Enabling Insights Operator alerts
9+
10+
When alerts are disabled, the Insights Operator no longer sends alerts to the cluster Prometheus instance. You can change this behavior.
11+
12+
.Prerequisites
13+
14+
* Remote health reporting is enabled, which is the default.
15+
ifndef::openshift-rosa,openshift-dedicated[]
16+
* You are logged in to the {product-title} web console as `cluster-admin`.
17+
endif::openshift-rosa,openshift-dedicated[]
18+
ifdef::openshift-rosa,openshift-dedicated[]
19+
* You are logged in to the {product-title} web console as a user with the `dedicated-admin` role.
20+
endif::openshift-rosa,openshift-dedicated[]
21+
22+
.Procedure
23+
24+
. Navigate to *Workloads* -> *Secrets*.
25+
. On the *Secrets* page, select *All Projects* from the *Project* list, and then set *Show default projects* to *ON*.
26+
. Select the *openshift-config* project from the *Projects* list.
27+
. Search for the *support* secret by using the *Search by name* field.
28+
. Click the *Options* menu {kebab}, and then click *Edit Secret*.
29+
. For the `disableInsightsAlerts` key, set the *Value* field to `false`.
30+
31+
After you save the changes, Insights Operator again sends alerts to the cluster Prometheus instance.

‎modules/enabling-insights-operator-gather.adoc

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * support/remote_health_monitoring/using-insights-operator.adoc
4+
5+
6+
:_content-type: PROCEDURE
7+
[id="enabling-insights-operator-gather_{context}"]
8+
= Enabling the Insights Operator gather operations
9+
10+
You can enable the Insights Operator gather operations, if the gather operations have been disabled.
11+
12+
:FeatureName: The `InsightsDataGather` custom resource
13+
include::snippets/technology-preview.adoc[]
14+
15+
.Prerequisites
16+
17+
ifndef::openshift-rosa,openshift-dedicated[]
18+
* You are logged in to the {product-title} web console as a user with the `cluster-admin` role.
19+
endif::openshift-rosa,openshift-dedicated[]
20+
ifdef::openshift-rosa,openshift-dedicated[]
21+
* You are logged in to the {product-title} web console as a user with the `dedicated-admin` role.
22+
endif::openshift-rosa,openshift-dedicated[]
23+
24+
.Procedure
25+
26+
. Navigate to *Administration* -> *CustomResourceDefinitions*.
27+
. On the *CustomResourceDefinitions* page, use the *Search by name* field to find the *InsightsDataGather* resource definition and click it.
28+
. On the *CustomResourceDefinition details* page, click the *Instances* tab.
29+
. Click *cluster*, and then click the *YAML* tab.
30+
. Enable the gather operations by performing one of the following edits:
31+
32+
** To enable all disabled gather operations, remove the `gatherConfig` stanza:
33+
+
34+
[source,yaml]
35+
----
36+
apiVersion: config.openshift.io/v1alpha1
37+
kind: InsightsDataGather
38+
metadata:
39+
....
40+
41+
spec:
42+
gatherConfig: <1>
43+
disabledGatherers: all
44+
----
45+
+
46+
--
47+
<1> Remove the `gatherConfig` stanza to enable all gather operations.
48+
--
49+
50+
** To enable individual gather operations, remove their values under the `disabledGatherers` key:
51+
+
52+
[source,yaml]
53+
----
54+
spec:
55+
gatherConfig:
56+
disabledGatherers:
57+
- clusterconfig/container_images <1>
58+
- clusterconfig/host_subnets
59+
- workloads/workload_info
60+
----
61+
+
62+
--
63+
<1> Remove one or more gather operations.
64+
--
65+
+
66+
. Click *Save*.
67+
+
68+
After you save the changes, the Insights Operator gather configurations are updated and the affected gather operations start.
69+
70+
[NOTE]
71+
====
72+
Disabling gather operations degrades Insights Advisor's ability to offer effective recommendations for your cluster.
73+
====

‎modules/insights-operator-configuring-sca.adoc

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[id="insights-operator-configuring-sca_{context}"]
88
= Configuring simple content access import interval
99

10-
You can configure how often the Insights Operator imports the simple content access entitlements using the `support` secret in the `openshift-config` namespace. The entitlement import normally occurs every eight hours, but you can shorten this interval if you update your simple content access configuration in Red Hat Subscription Management.
10+
You can configure how often the Insights Operator imports the simple content access entitlements by using the `support` secret in the `openshift-config` namespace. The entitlement import normally occurs every eight hours, but you can shorten this interval if you update your simple content access configuration in Red Hat Subscription Management.
1111

1212
This procedure describes how to update the import interval to one hour.
1313

@@ -24,10 +24,22 @@ endif::openshift-rosa,openshift-dedicated[]
2424

2525
. Navigate to *Workloads* -> *Secrets*.
2626
. Select the *openshift-config* project.
27-
. Search for the *support* secret using the *Search by name* field. If it does not exist, click *Create* -> *Key/value secret* to create it.
27+
. Search for the *support* secret by using the *Search by name* field. If it does not exist, click *Create* -> *Key/value secret* to create it.
28+
+
29+
--
30+
* If the secret exists:
2831
. Click the *Options* menu {kebab}, and then click *Edit Secret*.
2932
. Click *Add Key/Value*.
30-
. Create a key named `scaInterval` with a value of `1h`, and click *Save*.
33+
.. In the *Key* field, enter `scaInterval`.
34+
.. In the *Value* field, enter `1h`.
35+
+
36+
* If the secret does not exist:
37+
.. Click *Create* -> *Key/value secret*.
38+
... In the *Secret name* field, enter `support`.
39+
... In the *Key* field, enter `scaInterval`.
40+
... In the *Value* field, enter `1h`.
41+
.. Click *Create*.
42+
--
3143
+
3244
[NOTE]
3345
====

‎modules/insights-operator-configuring.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55

66
:_content-type: PROCEDURE
7-
[id="insights-operator-configuring-sca_{context}"]
7+
[id="insights-operator-configuring_{context}"]
88
= Configuring Insights Operator
99

1010
You can configure Insights Operator to meet the needs of your organization. The Insights Operator is configured using a combination of the default configurations in the `pod.yaml` file in the Insights Operator `Config` directory and the configurations stored in the `support` secret in the `openshift-config` namespace. The `support` secret does not exist by default and must be created when adding custom configurations for the first time. Configurations in the `support` secret override the defaults set in the `pod.yaml` file.

0 commit comments

Comments
 (0)