-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Enterprise 4.19 HCCDOC-5255: Insights Operator: Option to Disable Runtime Extractor #115111
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.
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
Open
fmcdonal
wants to merge
1
commit into
openshift:enterprise-4.19
Choose a base branch
from
fmcdonal:enterprise-4.19
base: enterprise-4.19
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+146
−184
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: <url> | ||
| |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: <url> | ||
| |Sets the upload endpoint. | ||
| |URL | ||
| |https://console.redhat.com/api/ingress/v1/upload | ||
|
|
||
| |dataReporting: | ||
| storagePath: <path> | ||
| |Configures the path where archived data gets stored. | ||
| |File path | ||
| |/var/lib/insights-operator | ||
|
|
||
| |dataReporting: | ||
| downloadEndpoint: <url> | ||
| |Specifies the endpoint for downloading the latest {red-hat-lightspeed} analysis. | ||
| |URL | ||
| |https://console.redhat.com/api/ingress/v1/download | ||
|
|
||
| |dataReporting: | ||
| conditionalGathererEndpoint: <url> | ||
| |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: <url> | ||
| |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` | ||
| |==== | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤖 [error] Vale.Terms: Use 'Operators?' instead of 'operator'.