openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

HCCDOC4014 Update obsolete API information for on-demand DataGather operations

Browse Source 
fix SME comments

fix

fix

sme fixes

sme fix

sme fix

sme fix

sme fixes

Update modules/disabling-insights-operator-gather.adoc

Co-authored-by: Alex Nik <rage.iz.me@gmail.com>

Update modules/disabling-insights-operator-gather.adoc

Co-authored-by: Alex Nik <rage.iz.me@gmail.com>

Update disabling-insights-operator-gather.adoc

Added short description markup
[role="_abstract"]

Update modules/disabling-insights-operator-gather.adoc

Co-authored-by: Darragh Fitzmaurice <57954076+dfitzmau@users.noreply.github.com>

Update modules/running-insights-operator-gather-cli.adoc

Co-authored-by: Darragh Fitzmaurice <57954076+dfitzmau@users.noreply.github.com>

Update modules/running-insights-operator-gather-web-console.adoc

Co-authored-by: Darragh Fitzmaurice <57954076+dfitzmau@users.noreply.github.com>

Update support/remote_health_monitoring/using-insights-operator.adoc
This commit is contained in:
Michelle Purcell
2025-09-17 12:14:49 +01:00
committed by openshift-cherrypick-robot
parent 6c746db19c
commit 51fc720f25
6 changed files with 261 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
support/remote_health_monitoring/using-insights-operator.adoc
View File

@@ -41,9 +41,37 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
// tech preview feature
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
[id="running-insights-operator-gather_using-insights-operator"]
== Running an Insights Operator gather operation
== Running an Insights Operator gather operation on-demand
Instead of waiting for the next periodic data gather operation, you can run a custom on-demand Insights Operator data gather operation by using the {product-title} web console or command-line interface (CLI).
A periodic data gather operation uses the `InsightsDataGather` custom resource definition (CRD) for configuration instructions, whereas an on-demand equivalent requires a `DataGather` CRD to be configured.
An on-demand `DataGather` operation is:
* Useful for one-off data collections that require different CRD configurations to the periodic data gathering (`InsightsDataGather`) specification.
* Independent from the periodic data gathering. When you create an on-demand `DataGather` CRD, the configuration is independent from the `InsightsDataGather` CRD specification of your periodic data gathering job.
**Custom specification options**
You can optionally customize the following items for the on-demand data gather operation:
* *Enable and define data obfuscation:* By defining the `DataGather` `dataPolicy` specification, you can enable additional obfuscation of the Insights archive data, for example, the IP address or workload names.
* *Enable persistant storage:* By default, the Insights Operator uses ephemeral storage, which means that a new pod will be created for each gather operation and the history of gather operations and data collected is not retained. You can switch to persistent storage to retain the data and history for up to the last 10 gather operations by defining the `DataGather` `storage` specification in the CRD.
* *Exclude specific data gather operations:* You can choose to disable specific gather operations from running by defining the `DataGather` `gatherers` specification. For example, you can choose to disable the cluster authentication operation or the workload data operation.
[IMPORTANT]
====
Excluding gather operations from the default list might reduce or limit the recommendations offered by the Insights Advisor for your cluster.
====
If you do not configure any custom specification options in the `DataGather` CRD, the default Insights Operator data collection job will run. This means that all gather operations will run, the collected data will be unobfuscated and the archive file will not be retained.
When you run a gather operation on-demand, any configuration that was previously applied to disable Insights Operator gather operations for your cluster will be overridden.
You can run Insights Operator data gather operations on demand. The following procedures describe how to run the default list of gather operations using the OpenShift web console or CLI. You can customize the on demand gather function to exclude any gather operations you choose. Disabling gather operations from the default list degrades Insights Advisor's ability to offer effective recommendations for your cluster. If you have previously disabled Insights Operator gather operations in your cluster, this procedure will override those parameters.
:FeatureName: The `DataGather` custom resource
include::snippets/technology-preview.adoc[]