Skip to content

OCPBUGS-59206-15: Added proxy attribute to the Insights Operator configu #97880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 29, 2025
Merged

OCPBUGS-59206-15: Added proxy attribute to the Insights Operator configu #97880

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 75 additions & 9 deletions modules/insights-operator-configuring.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand All @@ -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"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description table renders really small. Could you expand it? maybe something else could be reduced if there's a size limitation?

Then again, I'm not exactly sure how this will render on docs.rh

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review, Steve. I have Value type and Default value columns at the lowest level. The customer portal has a better experience where a customer can expand the table real estate:

Screenshot From 2025-08-29 16-19-14

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to Gemini:

Screenshot From 2025-08-29 16-29-18

|====
|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 `<cluster_id>` with the unique identified, cluster ID, of your cluster.
|URL
|https://console.redhat.com/api/insights-results-aggregator/v2/cluster/<cluster_id>/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}"]
Expand Down