mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-07 00:48:01 +01:00
95 lines
4.0 KiB
Plaintext
95 lines
4.0 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * support/remote_health_monitoring/using-insights-operator.adoc
|
|
|
|
|
|
:_mod-docs-content-type: CONCEPT
|
|
[id="insights-operator-configuring_{context}"]
|
|
= Configuring Insights Operator
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
The `ConfigMap` object does not exist by default, so an {product-title} cluster administrator must create it.
|
|
|
|
//[NOTE]
|
|
//====
|
|
//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.
|
|
//====
|
|
|
|
.ConfigMap object configuration structure
|
|
This example of an *insights-config* `ConfigMap` object (`config.yaml` configuration) shows configuration options using standard YAML formatting.
|
|
|
|
image::insights-operator-configmap-example.png[Example of Insights Operator ConfigMap object]
|
|
|
|
.Configurable attributes and default values
|
|
The table below describes the available configuration attributes:
|
|
|
|
[NOTE]
|
|
====
|
|
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.
|
|
====
|
|
|
|
.Insights Operator configurable attributes
|
|
[options="header"]
|
|
|====
|
|
|Attribute name|Description|Value type|Default value
|
|
|`Obfuscation: - networking`|Enables the global obfuscation of IP addresses and the cluster domain name.|Boolean|`false`
|
|
|`Obfuscation: - workload_names`|Obfuscate data coming from the Deployment Validation Operator if it is installed.|Boolean|`false`
|
|
|`sca: interval`|Specifies the frequency of the simple content access entitlements download.|Time interval|`8h`
|
|
|`sca: disabled`|Disables the simple content access entitlements download.|Boolean|`false`
|
|
|`alerting: disabled`|Disables Insights Operator alerts to the cluster Prometheus instance.|Boolean|`false`
|
|
|`httpProxy`, `httpsProxy`, `noProxy`|Set custom proxy for Insights Operator|URL|No default
|
|
|====
|
|
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
[id="creating-insights-config-configmap_{context}"]
|
|
== Creating the insights-config ConfigMap object
|
|
|
|
This procedure describes how to create the *insights-config* `ConfigMap` object for the Insights Operator to set custom configurations.
|
|
|
|
[IMPORTANT]
|
|
====
|
|
Red Hat recommends you consult Red Hat Support before making changes to the default Insights Operator configuration.
|
|
====
|
|
|
|
.Prerequisites
|
|
|
|
* Remote health reporting is enabled, which is the default.
|
|
* You are logged in to the {product-title} web console as a user with `cluster-admin` role.
|
|
|
|
.Procedure
|
|
|
|
. Go to *Workloads* -> *ConfigMaps* and select *Project: openshift-insights*.
|
|
. Click *Create ConfigMap*.
|
|
. Select *Configure via: YAML view* and enter your configuration preferences, for example
|
|
+
|
|
[source,yaml]
|
|
----
|
|
apiVersion: v1
|
|
kind: ConfigMap
|
|
metadata:
|
|
name: insights-config
|
|
namespace: openshift-insights
|
|
data:
|
|
config.yaml: |
|
|
dataReporting:
|
|
obfuscation:
|
|
- networking
|
|
- workload_names
|
|
sca:
|
|
disabled: false
|
|
interval: 2h
|
|
alerting:
|
|
disabled: false
|
|
binaryData: {}
|
|
immutable: false
|
|
----
|
|
|
|
. Optional: Select *Form view* and enter the necessary information that way.
|
|
. In the *ConfigMap Name* field, enter *insights-config*.
|
|
. In the *Key* field, enter *config.yaml*.
|
|
. For the *Value* field, either browse for a file to drag and drop into the field or enter your configuration parameters manually.
|
|
. Click *Create* and you can see the `ConfigMap` object and configuration information. |