Skip to content

Commit ac32be7

Browse files
xJustinxJustin
committed
CCXDEV-6528 Insights Operator configuration
1 parent 806241c commit ac32be7

File tree

5 files changed

+159
-0
lines changed

5 files changed

+159
-0
lines changed

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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="disabling-insights-operator-alerts_{context}"]
8+
= Disabling Insights Operator alerts
9+
10+
You can stop Insights Operator from firing alerts to the cluster Prometheus instance.
11+
12+
. Navigate to *Workloads* -> *Secrets*.
13+
. On the *Secrets* page, select *All Projects* from the *Project* list, and then set *Show default projects* to on.
14+
. 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.
16+
. Click the *Options* menu {kebab}, and then click *Edit Secret*.
17+
. Click *Add Key/Value*.
18+
. Enter `disableInsightsAlerts` as the key with the value `True`, and click *Save*.
19+
20+
After you save the changes, Insights Operator will no longer send alerts to the cluster Prometheus instance.

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

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
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="disabling-insights-operator-gather_{context}"]
8+
= Disabling the Insights Operator gather operations
9+
10+
You can disable the Insights Operator gather operations. Disabling the gather operations gives you the ability to increase privacy for your organization as Insights Operator will no longer gather and send Insights cluster reports to Red Hat. This will disable Insights analysis and recommendations for your cluster without affecting other core functions that require communication with Red 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 only occur when certain conditions are met and might not appear in your most recent archive.
11+
12+
:FeatureName: The `InsightsDataGather` custom resource
13+
include::snippets/technology-preview.adoc[]
14+
15+
.Prerequisites
16+
17+
* You are logged in to the {product-title} web console as a user with `cluster-admin` role.
18+
19+
.Procedure
20+
21+
. Navigate to *Administration* -> *CustomResourceDefinitions*.
22+
. On the *CustomResourceDefinitions* page, use the *Search by name* field to find the *InsightsDataGather* resource definition and click it.
23+
. On the *CustomResourceDefinition details* page, click the *Instances* tab.
24+
. Click *cluster*, and then click the *YAML* tab.
25+
. To disable all the gather operations, edit the `InsightsDataGather` configuration file:
26+
+
27+
[source,yaml]
28+
----
29+
apiVersion: config.openshift.io/v1alpha1
30+
kind: InsightsDataGather
31+
metadata:
32+
....
33+
34+
spec: <1>
35+
gatherConfig:
36+
disabledGatherers:
37+
- all <2>
38+
----
39+
+
40+
--
41+
<1> The `spec` parameter specifies gather configurations.
42+
<2> The `all` value disables all gather operations.
43+
--
44+
To disable individual gather operations, enter their values under the `disabledGatherers` key:
45+
+
46+
[source,yaml]
47+
----
48+
spec:
49+
gatherConfig:
50+
disabledGatherers:
51+
- clusterconfig/container_images <1>
52+
- clusterconfig/host_subnets
53+
- workloads/workload_info
54+
----
55+
+
56+
--
57+
<1> Example individual gather operation
58+
--
59+
+
60+
. Click *Save*.
61+
+
62+
After you save the changes, the Insights Operator gather configurations are updated and the operations will no longer occur.
63+
64+
[NOTE]
65+
====
66+
Disabling gather operations degrades Insights Advisor's ability to offer effective recommendations for your cluster.
67+
====

‎modules/insights-operator-configuring.adoc

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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="insights-operator-configuring-sca_{context}"]
8+
= Configuring Insights Operator
9+
10+
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.
11+
12+
The table below describes the available configuration attributes:
13+
14+
.Insights Operator configurable attributes
15+
[options="header"]
16+
|====
17+
|Attribute name|Description|Value type|Default value
18+
|`username`|Specifies username for basic authentication with `console.redhat.com` (overrides the default `pull-secret` token authentication when set)|String|Not set
19+
|`password`|Specifies password for basic authentication with `console.redhat.com` (overrides the default `pull-secret` token authentication when set)|String|Not set
20+
|`enableGlobalObfuscation`|Enables the global obfuscation of IP addresses and the cluster domain name|Boolean|`false`
21+
|`scaInterval`|Specifies the frequency of the simple content access entitlements download|Time interval|`8h`
22+
|`scaPullDisabled`|Disables the simple content access entitlements download|Boolean|`false`
23+
|`clusterTransferInterval`|Specifies how often Insights Operator checks OpenShift Cluster Manager for available cluster transfers|Time interval|`24h`
24+
|`disableInsightsAlerts`|Disables Insights Operator alerts to the cluster Prometheus instance|Boolean|`False`
25+
|====
26+
27+
This procedure describes how to set custom Insights Operator configurations.
28+
29+
[IMPORTANT]
30+
====
31+
Red Hat recommends you consult Red Hat Support before making changes to the default Insights Operator configuration.
32+
====
33+
34+
.Prerequisites
35+
36+
* You are logged in to the {product-title} web console as a user with `cluster-admin` role.
37+
38+
.Procedure
39+
40+
. Navigate to *Workloads* -> *Secrets*.
41+
. On the *Secrets* page, select *All Projects* from the *Project* list, and then set *Show default projects* to on.
42+
. Select the *openshift-config* project from the *Project* list.
43+
. Search for the *support* secret using the *Search by name* field. If it does not exist, click *Create* -> *Key/value secret* to create it.
44+
. Click the *Options* menu {kebab} for the secret, and then click *Edit Secret*.
45+
. Click *Add Key/Value*.
46+
. Enter an attribute name with an appropriate value (see table above), and click *Save*.
47+
. Repeat the above steps for any additional configurations.

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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="understanding-insights-operator-alerts_{context}"]
8+
= Understanding Insights Operator alerts
9+
10+
Insights Operator declares alerts through the Prometheus monitoring system to Alertmanager. You can view these alerts in the Alerting UI accessible through the *Administrator* perspective and the *Developer* perspective in the {product-title} web console.
11+
12+
Currently, Insights Operator sends the following alerts when the conditions are met:
13+
14+
.Insights Operator alerts
15+
[options="header"]
16+
|====
17+
|Alert|Description
18+
|`InsightsDisabled`|Insights Operator is disabled.
19+
|`SimpleContentAccessNotAvailable`|Simple content access is not enabled in Red Hat Subscription Management.
20+
|`InsightsRecommendationActive`|Insights has an active recommendation for the cluster.
21+
|====

‎support/remote_health_monitoring/using-insights-operator.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,9 @@ The Insights Operator periodically gathers configuration and component failure s
1818
1919
* 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].
2020
21+
include::modules/understanding-insights-operator-alerts.adoc[leveloffset=+1]
22+
include::modules/disabling-insights-operator-alerts.adoc[leveloffset=+1]
2123
include::modules/insights-operator-downloading-archive.adoc[leveloffset=+1]
2224
include::modules/insights-operator-gather-duration.adoc[leveloffset=+1]
25+
include::modules/disabling-insights-operator-gather.adoc[leveloffset=+1]
26+
include::modules/insights-operator-configuring.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)