Skip to content

Commit c135ee1

Browse files
authored
Merge pull request #97887 from openshift-cherrypick-robot/cherry-pick-97478-to-enterprise-4.19
[enterprise-4.19] : Added proxy attribute to the Insights Operator configu…
2 parents 6bcd4fa + 4edb968 commit c135ee1

File tree

1 file changed

+92
-9
lines changed

1 file changed

+92
-9
lines changed

modules/insights-operator-configuring.adoc

Lines changed: 92 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,111 @@ The `ConfigMap` object does not exist by default, so an {product-title} cluster
1919
//====
2020

2121
.ConfigMap object configuration structure
22-
This example of an *insights-config* `ConfigMap` object (`config.yaml` configuration) shows configuration options using standard YAML formatting.
22+
This example of an *insights-config* `ConfigMap` object (`config.yaml` configuration) shows configuration options by using standard YAML formatting.
2323

2424
image::insights-operator-configmap-example.png[Example of Insights Operator ConfigMap object]
2525

2626
.Configurable attributes and default values
27-
The table below describes the available configuration attributes:
27+
The following table describes the available configuration attributes:
2828

2929
[NOTE]
3030
====
3131
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.
3232
====
3333

3434
.Insights Operator configurable attributes
35-
[options="header"]
35+
[cols=".^2l,.^3a,.^1a,.^1a",options="header"]
3636
|====
3737
|Attribute name|Description|Value type|Default value
38-
|`Obfuscation: - networking`|Enables the global obfuscation of IP addresses and the cluster domain name.|Boolean|`false`
39-
|`Obfuscation: - workload_names`|Obfuscate data coming from the Deployment Validation Operator if it is installed.|Boolean|`false`
40-
|`sca: interval`|Specifies the frequency of the simple content access entitlements download.|Time interval|`8h`
41-
|`sca: disabled`|Disables the simple content access entitlements download.|Boolean|`false`
42-
|`alerting: disabled`|Disables Insights Operator alerts to the cluster Prometheus instance.|Boolean|`false`
43-
|`httpProxy`, `httpsProxy`, `noProxy`|Set custom proxy for Insights Operator|URL|No default
38+
39+
|alerting:
40+
disabled: false
41+
|Disables Insights Operator alerts to the cluster Prometheus instance.
42+
|Boolean
43+
|`false`
44+
45+
|clusterTransfer:
46+
endpoint: <url>
47+
|The endpoint for checking and downloading cluster transfer data.
48+
|URL
49+
|https://api.openshift.com/api/accounts_mgmt/v1/cluster_transfers/
50+
51+
|clusterTransfer:
52+
interval: 1h0m0s
53+
|Sets the frequency for checking available cluster transfers.
54+
|Time interval
55+
|`24h`
56+
57+
|dataReporting:
58+
interval: 30m0s
59+
|Sets the data gathering and upload frequency.
60+
|Time interval
61+
|`2h`
62+
63+
|dataReporting:
64+
uploadEndpoint: <url>
65+
|Sets the upload endpoint.
66+
|URL
67+
|https://console.redhat.com/api/ingress/v1/upload
68+
69+
|dataReporting:
70+
storagePath: <path>
71+
|Configures the path where archived data gets stored.
72+
|File path
73+
|/var/lib/insights-operator
74+
75+
|dataReporting:
76+
downloadEndpoint: <url>
77+
|Specifies the endpoint for downloading the latest Insights analysis.
78+
|URL
79+
|https://console.redhat.com/api/ingress/v1/download
80+
81+
|dataReporting:
82+
conditionalGathererEndpoint: <url>
83+
|Sets the endpoint for providing conditional gathering rule definitions.
84+
|URL
85+
|https://console.redhat.com/api/gathering/gathering_rules
86+
87+
88+
|dataReporting:
89+
obfuscation:
90+
- networking
91+
|Enables the global obfuscation of IP addresses and the cluster domain name.
92+
|String
93+
|Not applicable
94+
95+
|dataReporting:
96+
obfuscation:
97+
- workload_names
98+
|Enables the obfuscation of Data Validation Operator data. The cluster resource the resource ID is only visible in the archive file and not the resource name.
99+
|String
100+
|Not applicable
101+
102+
|proxy:
103+
httpProxy: http://example.com,
104+
httpsProxy: http://example.com,
105+
noProxy: test.org
106+
|Set custom proxy for Insights Operator.
107+
|URL
108+
|No default
109+
110+
|sca:
111+
interval: 8h0m0s
112+
|Specifies the frequency of the simple content access (SCA) entitlements download.
113+
|Time interval
114+
|`2h`
115+
116+
|sca:
117+
endpoint: <url>
118+
|Specifies the endpoint for downloading the simple content access (SCA) entitlements.
119+
|URL
120+
|https://api.openshift.com/api/accounts_mgmt/v1/entitlement_certificates
121+
122+
|sca:
123+
disabled: false
124+
|Disables the simple content access entitlements download.
125+
|Boolean
126+
|`false`
44127
|====
45128

46129

0 commit comments

Comments
 (0)