From 0fd13456d893776db5480332b33f8f062ad3f5c8 Mon Sep 17 00:00:00 2001 From: Frances_McDonald Date: Fri, 10 Jul 2026 13:20:49 +0100 Subject: [PATCH] fixing conflict added dara change from pull/114766/ --- ...sights-operator-configuring-configmap.adoc | 145 ++++++++++++++ modules/insights-operator-configuring.adoc | 185 +----------------- 2 files changed, 146 insertions(+), 184 deletions(-) create mode 100644 modules/insights-operator-configuring-configmap.adoc diff --git a/modules/insights-operator-configuring-configmap.adoc b/modules/insights-operator-configuring-configmap.adoc new file mode 100644 index 000000000000..1be36f714ee3 --- /dev/null +++ b/modules/insights-operator-configuring-configmap.adoc @@ -0,0 +1,145 @@ +// Module included in the following assemblies: +// +// * support/remote_health_monitoring/using-insights-operator.adoc + +:_mod-docs-content-type: REFERENCE +[id="insights-operator-configuring-configmap_{context}"] += ConfigMap object configuration structure + +[role="_abstract"] +View the example of an `insights-config` `ConfigMap` object (`config.yaml` configuration) to better understand the configuration options for the `ConfigMap` object. + +.Example insights-config ConfigMap object +[source,yaml] +---- +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 + disableRuntimeExtractor: true + 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.org +---- + +The following table 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 +[cols=".^2l,.^3a,.^1a,.^1a",options="header"] +|==== +|Attribute name|Description|Value type|Default value + +|alerting: + disabled: false +|Disables {insights-operator} alerts to the cluster Prometheus instance. +|Boolean +|`false` + +|clusterTransfer: + endpoint: +|The endpoint for checking and downloading cluster transfer data. +|URL +|https://api.openshift.com/api/accounts_mgmt/v1/cluster_transfers/ + +|clusterTransfer: + interval: 1h0m0s +|Sets the frequency for checking available cluster transfers. +|Time interval +|`24h` + +|dataReporting: + interval: 30m0s +|Sets the data gathering and upload frequency. +|Time interval +|`2h` + +|dataReporting: + uploadEndpoint: +|Sets the upload endpoint. +|URL +|https://console.redhat.com/api/ingress/v1/upload + +|dataReporting: + storagePath: +|Configures the path where archived data gets stored. +|File path +|/var/lib/insights-operator + +|dataReporting: + downloadEndpoint: +|Specifies the endpoint for downloading the latest {red-hat-lightspeed} analysis. +|URL +|https://console.redhat.com/api/ingress/v1/download + +|dataReporting: + conditionalGathererEndpoint: +|Sets the endpoint for providing conditional gathering rule definitions. +|URL +|https://console.redhat.com/api/gathering/gathering_rules + +|dataReporting: + disableRuntimeExtractor: true +|When set to true, it disables the deployment and management of all insights-runtime-extractor resources. +|Boolean +|`false` + +|dataReporting: + obfuscation: + - networking +|Enables the global obfuscation of IP addresses and the cluster domain name. +|String +|Not applicable + +|dataReporting: + obfuscation: + - workload_names +|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 + +|proxy: + httpProxy: http://example.com + httpsProxy: http://example.com + noProxy: test.org +|Set custom proxy for {insights-operator}. +|URL +|No default + +|sca: + interval: 8h0m0s +|Specifies the frequency of the simple content access (SCA) entitlements download. +|Time interval +|`2h` + +|sca: + endpoint: +|Specifies the endpoint for downloading the simple content access (SCA) entitlements. +|URL +|https://api.openshift.com/api/accounts_mgmt/v1/entitlement_certificates + +|sca: + disabled: false +|Disables the simple content access entitlements download. +|Boolean +|`false` +|==== diff --git a/modules/insights-operator-configuring.adoc b/modules/insights-operator-configuring.adoc index 512849d2cc16..d0a7d3f12a90 100644 --- a/modules/insights-operator-configuring.adoc +++ b/modules/insights-operator-configuring.adoc @@ -15,188 +15,5 @@ The `ConfigMap` object does not exist by default, so an {product-title} cluster //[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. +//{red-hat-lightspeed} 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 by using standard YAML formatting. - -[source,yaml] ----- -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.org ----- - -.Configurable attributes and default values -The following table 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 -[cols=".^2l,.^3a,.^1a,.^1a",options="header"] -|==== -|Attribute name|Description|Value type|Default value - -|alerting: - disabled: false -|Disables Insights Operator alerts to the cluster Prometheus instance. -|Boolean -|`false` - -|clusterTransfer: - endpoint: -|The endpoint for checking and downloading cluster transfer data. -|URL -|https://api.openshift.com/api/accounts_mgmt/v1/cluster_transfers/ - -|clusterTransfer: - interval: 1h0m0s -|Sets the frequency for checking available cluster transfers. -|Time interval -|`24h` - -|dataReporting: - interval: 30m0s -|Sets the data gathering and upload frequency. -|Time interval -|`2h` - -|dataReporting: - uploadEndpoint: -|Sets the upload endpoint. -|URL -|https://console.redhat.com/api/ingress/v1/upload - -|dataReporting: - storagePath: -|Configures the path where archived data gets stored. -|File path -|/var/lib/insights-operator - -|dataReporting: - downloadEndpoint: -|Specifies the endpoint for downloading the latest Insights analysis. -|URL -|https://console.redhat.com/api/ingress/v1/download - -|dataReporting: - conditionalGathererEndpoint: -|Sets the endpoint for providing conditional gathering rule definitions. -|URL -|https://console.redhat.com/api/gathering/gathering_rules - - -|dataReporting: - obfuscation: - - networking -|Enables the global obfuscation of IP addresses and the cluster domain name. -|String -|Not applicable - -|dataReporting: - obfuscation: - - workload_names -|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 - -|proxy: - httpProxy: http://example.com - httpsProxy: http://example.com - noProxy: test.org -|Set custom proxy for Insights Operator. -|URL -|No default - -|sca: - interval: 8h0m0s -|Specifies the frequency of the simple content access (SCA) entitlements download. -|Time interval -|`2h` - -|sca: - endpoint: -|Specifies the endpoint for downloading the simple content access (SCA) entitlements. -|URL -|https://api.openshift.com/api/accounts_mgmt/v1/entitlement_certificates - -|sca: - disabled: false -|Disables the simple content access entitlements download. -|Boolean -|`false` -|==== - - -:_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. \ No newline at end of file