From b06882331719826edc57d66b8b3091f560cbf3bd Mon Sep 17 00:00:00 2001 From: Michelle Purcell Date: Thu, 7 Nov 2024 17:57:31 +0000 Subject: [PATCH] HCCDOC-3143 Add content about the InsightsRuntimeExtractor for 4.18 HCCDOC-3143 - Added bullet point about workload runtime data collection fix Peer review fix fix fix fixes Delete :q Update modules/insights-operator-what-information-is-collected.adoc fix fix link Update modules/insights-operator-what-information-is-collected.adoc Co-authored-by: Sebastian Kopacz <112414607+skopacz1@users.noreply.github.com> fix enhance info fix conditional issue Update modules/insights-operator-what-information-is-collected.adoc Co-authored-by: Sebastian Kopacz <112414607+skopacz1@users.noreply.github.com> --- ...-operator-what-information-is-collected.adoc | 17 +++++++++++------ .../nodes-cluster-enabling-features-about.adoc | 1 + .../about-remote-health-monitoring.adoc | 6 ++++++ 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/modules/insights-operator-what-information-is-collected.adoc b/modules/insights-operator-what-information-is-collected.adoc index 68460853c8..74361faafe 100644 --- a/modules/insights-operator-what-information-is-collected.adoc +++ b/modules/insights-operator-what-information-is-collected.adoc @@ -7,12 +7,17 @@ The following information is collected by the Insights Operator: -* General information about your cluster and its components to identify issues that are specific to your {product-title} version and environment -* Configuration files, such as the image registry configuration, of your cluster to determine incorrect settings and issues that are specific to parameters you set -* Errors that occur in the cluster components -* Progress information of running updates, and the status of any component upgrades +* General information about your cluster and its components to identify issues that are specific to your {product-title} version and environment. +* Configuration files, such as the image registry configuration, of your cluster to determine incorrect settings and issues that are specific to parameters you set. +* Errors that occur in the cluster components. +* Progress information of running updates, and the status of any component upgrades. * Details of the platform that {product-title} is deployed on and the region that the cluster is located in ifndef::openshift-dedicated[] -* Cluster workload information transformed into discreet Secure Hash Algorithm (SHA) values, which allows Red Hat to assess workloads for security and version vulnerabilities without disclosing sensitive details +* Cluster workload information transformed into discreet Secure Hash Algorithm (SHA) values, which allows Red Hat to assess workloads for security and version vulnerabilities without disclosing sensitive details. +* Workload information about the operating system and runtime environment, including runtime kinds, names, and versions, which you can optionally enable through the `InsightsRuntimeExtractor` feature gate. This data gives Red Hat a better understanding of how you use {product-title} containers so that we can proactively help you make investment decisions to drive optimal utilization. ++ +:FeatureName: InsightsRuntimeExtractor +include::snippets/technology-preview.adoc[] + endif::openshift-dedicated[] -* If an Operator reports an issue, information is collected about core {product-title} pods in the `openshift-*` and `kube-*` projects. This includes state, resource, security context, volume information, and more +* If an Operator reports an issue, information is collected about core {product-title} pods in the `openshift-*` and `kube-*` projects. This includes state, resource, security context, volume information, and more. diff --git a/modules/nodes-cluster-enabling-features-about.adoc b/modules/nodes-cluster-enabling-features-about.adoc index b94ce1a846..b0718993dd 100644 --- a/modules/nodes-cluster-enabling-features-about.adoc +++ b/modules/nodes-cluster-enabling-features-about.adoc @@ -25,6 +25,7 @@ The following Technology Preview features are enabled by this feature set: ** Swap memory on nodes. Enables swap memory use for {product-title} workloads on a per-node basis. (`NodeSwap`) ** OpenStack Machine API Provider. This gate has no effect and is planned to be removed from this feature set in a future release. (`MachineAPIProviderOpenStack`) ** Insights Operator. Enables the `InsightsDataGather` CRD, which allows users to configure some Insights data gathering options. The feature set also enables the `DataGather` CRD, which allows users to run Insights data gathering on-demand. (`InsightsConfigAPI`) +** Insights Operator. Enables a new data collection feature called 'Insights Runtime Extractor' which, when enabled, allows Red{nbsp}Hat to gather more runtime workload data about your {product-title} containers. (`InsightsRuntimeExtractor`) ** Dynamic Resource Allocation API. Enables a new API for requesting and sharing resources between pods and containers. This is an internal feature that most users do not need to interact with. (`DynamicResourceAllocation`) ** Pod security admission enforcement. Enables the restricted enforcement mode for pod security admission. Instead of only logging a warning, pods are rejected if they violate pod security standards. (`OpenShiftPodSecurityAdmission`) ** StatefulSet pod availability upgrading limits. Enables users to define the maximum number of statefulset pods unavailable during updates which reduces application downtime. (`MaxUnavailableStatefulSet`) diff --git a/support/remote_health_monitoring/about-remote-health-monitoring.adoc b/support/remote_health_monitoring/about-remote-health-monitoring.adoc index 317b25855b..c464e50b9d 100644 --- a/support/remote_health_monitoring/about-remote-health-monitoring.adoc +++ b/support/remote_health_monitoring/about-remote-health-monitoring.adoc @@ -86,6 +86,12 @@ ifndef::openshift-rosa,openshift-dedicated[] * See xref:../../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the Insights Operator] for details about how to review the data that is collected by the Insights Operator. endif::openshift-rosa,openshift-dedicated[] +* link:https://access.redhat.com/solutions/7066188[What data is being collected by the Insights Operator in OpenShift?] + +ifndef::openshift-rosa,openshift-dedicated[] +* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates] +endif::openshift-rosa,openshift-dedicated[] + * The Insights Operator source code is available for review and contribution. See the link:https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md[Insights Operator upstream project] for a list of the items collected by the Insights Operator. include::modules/understanding-telemetry-and-insights-operator-data-flow.adoc[leveloffset=+1]