红帽全球峰会4.5. Using the Insights Operator
The Insights Operator periodically gathers configuration and component failure status and, by default, reports that data every two hours to Red Hat. This information enables Red Hat to assess configuration and deeper failure data than is reported through Telemetry. Users of OpenShift Container Platform can display the report in the Advisor service on Red Hat Hybrid Cloud Console.
4.5.1. 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 OpenShift Container Platform cluster administrator must create it.
4.5.1.1. ConfigMap object configuration structure
This example of an insights-config ConfigMap object (config.yaml configuration) shows configuration options by using standard YAML formatting.
apiVersion: v1
kind: ConfigMap
metadata:
name: insights-config
namespace: openshift-insights
data:
config.yaml: |
dataReporting:
uploadEndpoint: https://console.redhat.com/api/ingress/v1/upload
storagePath: /var/lib/insights-operator
downloadEndpoint: https://console.redhat.com/api/insights-results-aggregator/v2/cluster/%s/reports
conditionalGathererEndpoint: https://console.redhat.com/api/gathering/gathering_rules
sca:
disabled: false
endpoint: https://api.openshift.com/api/accounts_mgmt/v1/entitlement_certificates
interval: 8h0m0s
alerting:
disabled: false
proxy:
httpProxy: http://example.com
httpsProxy: https://example.com
noProxy: test.orgConfigurable attributes and default values
The following table describes the available configuration attributes:
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.
| Attribute name | Description | Value type | Default value |
|---|---|---|---|
| Disables Insights Operator alerts to the cluster Prometheus instance. | Boolean |
|
| The endpoint for checking and downloading cluster transfer data. | URL | https://api.openshift.com/api/accounts_mgmt/v1/cluster_transfers/ |
| Sets the frequency for checking available cluster transfers. | Time interval |
|
| Sets the data gathering and upload frequency. | Time interval |
|
| Sets the upload endpoint. | URL | |
| Configures the path where archived data gets stored. | File path | /var/lib/insights-operator |
| Specifies the endpoint for downloading the latest Red Hat Lightspeed analysis. | URL | |
| Sets the endpoint for providing conditional gathering rule definitions. | URL | |
| Enables the global obfuscation of IP addresses and the cluster domain name. | String | Not applicable |
| Enables the obfuscation of Data Validation Operator data. The cluster resource ID is only visible in the archive file and not the resource name. | String | Not applicable |
| Set custom proxy for Insights Operator. | URL | No default |
| Specifies the frequency of the simple content access (SCA) entitlements download. | Time interval |
|
| Specifies the endpoint for downloading the simple content access (SCA) entitlements. | URL | https://api.openshift.com/api/accounts_mgmt/v1/entitlement_certificates |
| Disables the simple content access entitlements download. | Boolean |
|
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}