From 28dcbb4c7256dcb0386d06f880b5d01bf172cb0f Mon Sep 17 00:00:00 2001 From: dfitzmau Date: Thu, 21 Aug 2025 11:01:48 +0100 Subject: [PATCH] OCPBUGS-60660-15: Added proxy attribute to the Insights Operator configu --- modules/insights-operator-configuring.adoc | 84 +++++++++++++++++++--- 1 file changed, 75 insertions(+), 9 deletions(-) diff --git a/modules/insights-operator-configuring.adoc b/modules/insights-operator-configuring.adoc index 15c685dfe7db..956eeb8ee1b6 100644 --- a/modules/insights-operator-configuring.adoc +++ b/modules/insights-operator-configuring.adoc @@ -19,12 +19,12 @@ The `ConfigMap` object does not exist by default, so an {product-title} cluster //==== .ConfigMap object configuration structure -This example of an *insights-config* `ConfigMap` object (`config.yaml` configuration) shows configuration options using standard YAML formatting. +This example of an *insights-config* `ConfigMap` object (`config.yaml` configuration) shows configuration options by 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: +The following table describes the available configuration attributes: [NOTE] ==== @@ -33,16 +33,82 @@ The *insights-config* `ConfigMap` object follows standard YAML formatting, where .Insights Operator configurable attributes [options="header"] +[cols=".^2l,.^3a,.^1a,.^1a",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 -|==== +|enableGlobalObfuscation +|Enables the global obfuscation of IP addresses and the cluster domain name. +|Boolean +|`false` + +|endpoint +|Sets the upload endpoint. +|URL +|https://console.redhat.com/api/ingress/v1/upload + +|clusterTransferEndpoint +|The endpoint for checking and downloading cluster transfer data. +|URL +|https://api.openshift.com/api/accounts_mgmt/v1/cluster_transfers/ + +|clusterTransferInterval +|Sets the frequency for checking available cluster transfers. +|Time interval +|`24h` + +|conditionalGathererEndpoint +|Sets the endpoint for providing conditional gathering rule definitions. +|URL +|https://console.redhat.com/api/gathering/gathering_rules + +|httpProxy, + httpsProxy, + noProxy +|Set custom proxy for Insights Operator. +|URL +|No default + +|interval +|Sets the data gathering and upload frequency. +|Time interval +|`2h` + +|reportEndpoint +|Specifies the endpoint for downloading the latest Insights analysis. For the specified default value, ensure that you replace `` with the unique identified, cluster ID, of your cluster. +|URL +|https://console.redhat.com/api/insights-results-aggregator/v2/cluster//reports + +|reportPullingDelay +|Sets the delay between data upload and data download. +|Time interval +|`60s` + +|reportPullingTimeout +|Sets the timeout value for the Insights download request. +|Time interval +|`30s` + +|reportMinRetryTime +|Sets the time for when to retry a request. +|Time interval +|`30s` + +|scaEndpoint +|Specifies the endpoint for downloading the simple content access (SCA) entitlements. +|URL +|https://api.openshift.com/api/accounts_mgmt/v1/entitlement_certificates + +|scaInterval +|Specifies the frequency of the simple content access entitlements download. +|Time interval +|`8h` + +|scaPullDisabled +|Disables the simple content access entitlements download. +|Boolean +|`false` +|==== :_mod-docs-content-type: PROCEDURE [id="creating-insights-config-configmap_{context}"]