You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
11
+
To prevent the Insights Operator from sending alerts to the cluster Prometheus instance, you create or edit the *insights-config*`ConfigMap` object.
12
+
13
+
[NOTE]
14
+
====
15
+
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.
16
+
====
17
+
18
+
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.
15
19
endif::openshift-rosa,openshift-dedicated[]
16
20
21
+
17
22
.Prerequisites
18
23
19
24
* Remote health reporting is enabled, which is the default.
When alerts are disabled, the Insights Operator no longer sends alerts to the cluster Prometheus instance. You can change this behavior.
10
+
When alerts are disabled, the Insights Operator no longer sends alerts to the cluster Prometheus instance. You can reenable them.
11
+
12
+
[NOTE]
13
+
====
14
+
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.
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.
10
+
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.
11
+
12
+
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.
11
13
12
-
This procedure describes how to update the import interval to one hour.
13
14
14
15
.Prerequisites
15
16
17
+
* Remote health reporting is enabled, which is the default.
16
18
ifndef::openshift-rosa,openshift-dedicated[]
17
19
* You are logged in to the {product-title} web console as a user with the `cluster-admin` role.
18
20
endif::openshift-rosa,openshift-dedicated[]
19
21
ifdef::openshift-rosa,openshift-dedicated[]
20
22
* You are logged in to the {product-title} web console as a user with the `dedicated-admin` role.
21
23
endif::openshift-rosa,openshift-dedicated[]
24
+
* The *insights-config*`ConfigMap` object exists in the `openshift-insights` namespace.
25
+
22
26
23
27
.Procedure
24
28
25
-
. Navigate to *Workloads*->*Secrets*.
26
-
. Select the *openshift-config* project.
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:
31
-
. Click the *Options* menu {kebab}, and then click *Edit Secret*.
32
-
. Click *Add Key/Value*.
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
-
--
29
+
. Go to *Workloads*->*ConfigMaps* and select *Project: openshift-insights*.
30
+
. Click on the *insights-config*`ConfigMap` object to open it.
31
+
. Click *Actions* and select *Edit ConfigMap*.
32
+
. Click the *YAML view* radio button.
33
+
. Set the `sca` attribute in the file to `interval: 2h` to import content every two hours.
43
34
+
44
-
[NOTE]
45
-
====
46
-
The interval `1h` can also be entered as `60m` for 60 minutes.
47
-
====
35
+
[source,yaml]
36
+
----
37
+
apiVersion: v1
38
+
kind: ConfigMap
39
+
# ...
40
+
data:
41
+
config.yaml: |
42
+
sca:
43
+
interval: 2h
44
+
# ...
45
+
----
46
+
47
+
. Click *Save*. The *insights-config* config-map details page opens.
48
+
. Verify that the value of the `config.yaml``sca` attribute is set to `interval: 2h`.
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.
10
+
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.
11
+
12
+
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.
13
+
14
+
The `ConfigMap` object does not exist by default, so an {product-title} cluster administrator must create it.
15
+
16
+
//[NOTE]
17
+
//====
18
+
//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.
19
+
//====
11
20
21
+
.ConfigMap object configuration structure
22
+
This example of an *insights-config*`ConfigMap` object (`config.yaml` configuration) shows configuration options using standard YAML formatting.
23
+
24
+
image::insights-operator-configmap-example.png[Example of Insights Operator ConfigMap object]
25
+
26
+
.Configurable attributes and default values
12
27
The table below describes the available configuration attributes:
13
28
29
+
[NOTE]
30
+
====
31
+
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.
32
+
====
33
+
14
34
.Insights Operator configurable attributes
15
35
[options="header"]
16
36
|====
17
37
|Attribute name|Description|Value type|Default value
18
-
|`enableGlobalObfuscation`|Enables the global obfuscation of IP addresses and the cluster domain name|Boolean|`false`
19
-
|`scaInterval`|Specifies the frequency of the simple content access entitlements download|Time interval|`8h`
20
-
|`scaPullDisabled`|Disables the simple content access entitlements download|Boolean|`false`
21
-
|`clusterTransferInterval`|Specifies how often Insights Operator checks OpenShift Cluster Manager for available cluster transfers|Time interval|`24h`
22
-
|`disableInsightsAlerts`|Disables Insights Operator alerts to the cluster Prometheus instance|Boolean|`False`
38
+
|`Obfuscation: - networking`|Enables the global obfuscation of IP addresses and the cluster domain name.|Boolean|`false`
39
+
|`Obfuscation: - workload_names`|Obfuscate data coming from the Deployment Validation Operator if it is installed.|Boolean|`false`
40
+
|`sca: interval`|Specifies the frequency of the simple content access entitlements download.|Time interval|`8h`
41
+
|`sca: disabled`|Disables the simple content access entitlements download.|Boolean|`false`
42
+
|`alerting: disabled`|Disables Insights Operator alerts to the cluster Prometheus instance.|Boolean|`false`
23
43
|====
24
44
25
-
This procedure describes how to set custom Insights Operator configurations.
Copy file name to clipboardExpand all lines: modules/insights-operator-disabling-sca.adoc
+22-25Lines changed: 22 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,36 +7,33 @@
7
7
[id="insights-operator-disabling-sca_{context}"]
8
8
= Disabling simple content access import
9
9
10
-
You can disable the importing of simple content access entitlements by using the `support` secret in the `openshift-config` namespace.
10
+
You can disable the importing of simple content access entitlements by using the *insights-config*`ConfigMap` object in the `openshift-insights` namespace.
11
11
12
12
.Prerequisites
13
13
14
+
* Remote health reporting is enabled, which is the default.
14
15
* You are logged in to the {product-title} web console as `cluster-admin`.
16
+
* The *insights-config*`ConfigMap` object exists in the `openshift-insights` namespace.
15
17
16
18
.Procedure
17
19
18
-
. Navigate to *Workloads*->*Secrets*.
19
-
. Select the *openshift-config* project.
20
-
. Search for the *support* secret using the *Search by name* field.
20
+
. Go to *Workloads*->*ConfigMaps* and select *Project: openshift-insights*.
21
+
. Click on the *insights-config*`ConfigMap` object to open it.
22
+
. Click *Actions* and select *Edit ConfigMap*.
23
+
. Click the *YAML view* radio button.
24
+
. In the file, set the `sca` attribute to `disabled: true`.
21
25
+
22
-
--
23
-
* If the secret exists:
24
-
. Click the *Options* menu {kebab}, and then click *Edit Secret*.
25
-
. Click *Add Key/Value*.
26
-
.. In the *Key* field, enter `scaPullDisabled`.
27
-
.. In the *Value* field, enter `true`.
28
-
+
29
-
* If the secret does not exist:
30
-
.. Click *Create*->*Key/value secret*.
31
-
... In the *Secret name* field, enter `support`.
32
-
... In the *Key* field, enter `scaPullDisabled`.
33
-
... In the *Value* field, enter `true`.
34
-
.. Click *Create*.
35
-
--
36
-
+
37
-
The simple content access entitlement import is now disabled.
38
-
+
39
-
[NOTE]
40
-
====
41
-
To enable the simple content access import again, edit the `support` secret and delete the `scaPullDisabled` key.
42
-
====
26
+
[source,yaml]
27
+
----
28
+
apiVersion: v1
29
+
kind: ConfigMap
30
+
# ...
31
+
data:
32
+
config.yaml: |
33
+
sca:
34
+
disabled: true
35
+
# ...
36
+
----
37
+
38
+
. Click *Save*. The *insights-config* config-map details page opens.
39
+
. Verify that the value of the `config.yaml``sca` attribute is set to `disabled: true`.
0 commit comments