Skip to content

Latest commit

 

History

History
2099 lines (1381 loc) · 55.5 KB

gathered-data.md

File metadata and controls

2099 lines (1381 loc) · 55.5 KB

Insights Operator Gathered Data

This document is auto-generated by make docs, and details what data Insights Operator (IO) gathers from a cluster, the location where it is stored in the IO archive, and the applicable version(s) of OpenShift. Data stored in the conditional/ directory is only gathered when certain conditions are met.

The IO pod operates in the openshift-insights namespace and the archives are packaged as .tar.gz files in /var/lib/insights-operator.

APIRequestCounts

Collects API requests counts for the resources mentioned in the alert provided as a string parameter.

API Reference

None

Sample data

Location in archive

  • conditional/alerts/{alert_name}/api_request_counts.json

Config ID

conditional/api_request_counts_of_resource_from_alert

Released version

  • 4.10.0

Backported versions

  • 4.9.6+

Changes

None

ActiveAlerts

Collects active alerts from the Alertmanager API V2 in the JSON format. Alert data is also still included in the GatherMostRecentMetrics gatherer.

This adds new gatherer for gathering firing/active Prometheus alerts in JSON format as well. The original recent metrics gatherer still continues to gather the alerts (not in JSON) as well, but this can be removed in the future, and we will keep the data only in JSON.

API Reference

None

Sample data

Location in archive

  • config/alerts.json

Config ID

clusterconfig/active_alerts

Released version

  • 4.12.0

Backported versions

None

Changes

None

AggregatedMonitoringCRNames

Collects instances outside of the openshift-monitoring of the following custom resources:

  • Kind: Prometheus Group: monitoring.coreos.com
  • Kind: AlertManager Group: monitoring.coreos.com

API Reference

Sample data

Location in archive

  • aggregated/custom_prometheuses_alertmanagers.json

Config ID

clusterconfig/aggregated_monitoring_cr_names

Released version

  • 4.16

Backported versions

  • 4.15.20+
  • 4.14.32+

Changes

None

CRD

Collects the specified Custom Resource Definitions.

The following CRDs are gathered:

  • volumesnapshots.snapshot.storage.k8s.io (10745 bytes)
  • volumesnapshotcontents.snapshot.storage.k8s.io (13149 bytes)

API Reference

None

Sample data

Location in archive

  • config/crd/{name}.json

Config ID

clusterconfig/crds

Released version

  • 4.6.0

Backported versions

None

Changes

None

CephCluster

Collects statuses of thecephclusters.ceph.rook.io resources from Openshift Data Foundation Stack.

API Reference

Sample data

Location in archive

Version Path
< 4.13.0 config/storage/{namespace}/{name}.json
>= 4.13.0 config/storage/{namespace}/cephclusters/{name}.json

Config ID

clusterconfig/ceph_cluster

Released version

  • 4.12.0

Backported versions

  • 4.8.49+
  • 4.9.48+
  • 4.10.31+
  • 4.11.2+

Changes

In OCP 4.11 and OCP 4.12, the location of gathered data collides with data gathered by the StorageCluster gatherer. It is practically impossible to tell the two resources apart. Use with caution.

CertificateSigningRequests

Collects anonymized CertificateSigningRequests which weren't Verified, or when Now < ValidBefore or Now > ValidAfter

API Reference

Sample data

Location in archive

  • config/certificatesigningrequests

Config ID

clusterconfig/certificate_signing_requests

Released version

  • 4.5.0

Backported versions

  • 4.3.25+
  • 4.4.12+

Changes

None

ClusterAPIServer

Collects APIServer.config.openshift.io resource

API Reference

https://github.com/openshift/api/blob/master/config/v1/types_apiserver.go

Sample data

Location in archive

  • config/apiserver.json

Config ID

cluster_apiserver

Released version

  • 4.15.0

Backported versions

  • 4.14.0+
  • 4.13.19+
  • 4.12.42+
  • 4.11.54+

Changes

None

ClusterAuthentication

Collects the cluster Authentication with cluster name.

API Reference

Sample data

Location in archive

  • config/authentication.json

Config ID

clusterconfig/authentication

Released version

  • 4.2.0

Backported versions

None

Changes

None

ClusterFeatureGates

Collects the cluster FeatureGate with cluster name.

API Reference

Sample data

Location in archive

  • config/featuregate.json

Config ID

clusterconfig/feature_gates

Released version

  • 4.2.0

Backported versions

None

Changes

None

ClusterImage

Collects cluster images.config.openshift.io resource definition.

API Reference

Sample data

Location in archive

  • config/image.json

Config ID

clusterconfig/image

Released version

  • 4.11.0

Backported versions

  • 4.10.8+

Changes

None

ClusterImagePruner

Collects the image pruner configuration.

API Reference

None

Sample data

Location in archive

Version Path
< 4.6.0 config/imagepruner.json
>= 4.6.0 config/clusteroperator/{group}/{kind}/{name}.json

Config ID

clusterconfig/image_pruners

Released version

  • 4.5.0

Backported versions

None

Changes

None

ClusterImageRegistry

Collects the cluster Image Registry configuration

API Reference

None

Sample data

Location in archive

Version Path
< 4.7.0 config/imageregistry.json
>= 4.7.0 config/clusteroperator/imageregistry.operator.openshift.io/config/cluster.json
>= 4.6.20 config/persistentvolumes/{name}.json

Config ID

clusterconfig/image_registries

Released version

  • 4.5.0

Backported versions

  • 4.3.40+
  • 4.4.12+

Changes

  • PersistentVolumes were introduced in version 4.7.0 and backported to 4.6.20+.
  • If the Image Registry configuration uses any PersistentVolumeClaim for the storage, the corresponding PersistentVolume definition is gathered.

ClusterInfrastructure

Collects the cluster Infrastructure with cluster name.

API Reference

Sample data

Location in archive

  • config/infrastructure.json

Config ID

clusterconfig/infrastructures

Released version

  • 4.2.0

Backported versions

None

Changes

None

ClusterIngress

Collects the cluster Ingress with cluster name.

API Reference

Sample data

Location in archive

  • config/ingress.json

Config ID

clusterconfig/ingress

Released version

  • 4.2.0

Backported versions

None

Changes

None

ClusterIngressCertificates

Collects the certificate's NotBefore and NotAfter dates from the cluster's ingress controller certificates. It also collects the name and namespace of any Ingress Controllers using the certificates.

API Reference

Sample data

Location in archive

  • aggregated/ingress_controllers_certs.json

Config ID

clusterconfig/ingress_certificates

Released version

  • 4.17

Backported versions

TBD

Changes

None

ClusterNetwork

Collects the cluster Network with cluster name.

API Reference

Sample data

Location in archive

  • config/network.json

Config ID

clusterconfig/networks

Released version

  • 4.2.0

Backported versions

None

Changes

None

ClusterOAuth

Collects the cluster OAuth with cluster name.

API Reference

Sample data

Location in archive

  • config/oauth.json

Config ID

clusterconfig/oauths

Released version

  • 4.2.0

Backported versions

None

Changes

None

ClusterOperatorPodsAndEvents

Collects information about pods and events from namespaces of degraded cluster operators. The collected information includes:

  • Definitions for non-running (terminated, pending) Pods
  • Previous (if container was terminated) and current logs of all related pod containers
  • Namespace events

API Reference

None

Sample data

Location in archive

  • config/pod/{namespace}/{pod}.json
  • events/{namespace}.json
  • config/pod/{namespace}/logs/{pod}/{container}_{current|previous}.log

Config ID

clusterconfig/operators_pods_and_events

Released version

  • 4.8.2

Backported versions

  • 4.6.35+
  • 4.7.11+

Changes

  • The data gathered by ClusterOperatorPodsAndEvents were originally gathered by ClusterOperators. The ClusterOperators gather was split at 4.8.2 and the change was backported to 4.7.11 and 4.6.35.
  • The collected data was previously included as specifications for ClusterOperators, and it was initially introduced in version 4.3.0 and later backported to version 4.2.10+.

ClusterOperators

Collects all the ClusterOperators definitions and their related resources from the operator.openshift.io group. Only metadata (group, version, kind) and spec attributes from the operator.openshift.io group are gathered.

API Reference

Sample data

Location in archive

Version Path
< 4.6.16 config/clusteroperator/{kind}-{name}.json
>= 4.6.16 config/clusteroperator/{group}/{kind}/{name}.json
< 4.8.2 config/pod/{namespace}/{pod}.json
< 4.8.2 events/{namespace}.json

Config ID

clusterconfig/operators

Released version

  • 4.2.0

Backported versions

None

Changes

  • config/pod/{namespace}/{pod}.json and events/ were moved to ClusterOperatorPodsAndEvents since 4.8.2, both were introduced at 4.3.0 as part of this gatherer and backported to 4.2.10+.
  • gather status of the insightsoperator.operator.openshift.io resource from 4.16.0+

ClusterProxy

Collects the cluster Proxy with cluster name.

API Reference

Sample data

Location in archive

  • config/proxy.json

Config ID

clusterconfig/proxies

Released version

  • 4.3.0

Backported versions

None

Changes

None

ClusterRoles

Collects definition of the "admin" and "edit" cluster roles.

API Reference

Sample data

Location in archive

  • cluster-scoped-resources/rbac.authorization.k8s.io/clusterroles/

Config ID

clusterconfig/clusterroles

Released version

  • 4.18.0

Backported versions

Changes

None

ClusterVersion

Collects the ClusterVersion (including the cluster ID) with the name 'version' and its resources.

API Reference

Sample data

Location in archive

Version Path
>= 4.2.0 config/version.json
>= 4.2.0 config/id
>= 4.8.2 config/pod/openshift-cluster-version/version.json
>= 4.8.2 events/openshift-cluster-version.json

Config ID

clusterconfig/version

Released version

  • 4.2.0

Backported versions

None

Changes

None

ConfigMaps

Collects all ConfigMaps from the openshift-config namespace and specific ConfigMaps from other namespaces (see Changes for details).

API Reference

Sample data

Location in archive

Version Path
< 4.7.0 config/configmaps/{configmap}
>= 4.7.0 config/configmaps/{namespace}/{name}/{configmap}

Config ID

clusterconfig/config_maps

Released version

  • 4.5.0

Backported versions

  • 4.3.25+
  • 4.4.6+

Changes

  • cluster-monitoring-config config map from openshift-monitoring namespace since versions 4.6.22+ and 4.7.0+
  • install-config key from the cluster-config-v1 config map in the kube-system namespace since versions 4.9.0+; originally stored as config/configmaps/kube-system/cluster-config-v1.json, changed to config/configmaps/kube-system/cluster-config-v1/install-config since 4.13.0+
  • gateway-mode-config config map from openshift-network-operator namespace since 4.14.0+
  • insights-config config map from openshift-insights namespace since 4.15.0+

Anonymization

If the content of a ConfigMap contains a parseable PEM structure (like a certificate), it removes the inside of PEM blocks. For ConfigMap of type BinaryData, it is encoded as standard base64. In the archive under configmaps, we store the name of the namespace, the name of the ConfigMap, and then each key.

For example: config/configmaps/NAMESPACENAME/CONFIGMAPNAME/CONFIGMAPKEY1

ContainerImages

Collects essential information about running containers. Specifically, the age of pods, the set of running images and the container names are collected.

API Reference

None

Sample data

Location in archive

  • config/running_containers.json

Config ID

clusterconfig/container_images

Released version

  • 4.7.0

Backported versions

  • 4.5.33+
  • 4.6.1+

Changes

None

ContainerRuntimeConfig

Collects ContainerRuntimeConfig information.

API Reference

Sample data

Location in archive

  • config/containerruntimeconfigs/{name}.json

Config ID

clusterconfig/container_runtime_configs

Released version

  • 4.7.0

Backported versions

  • 4.6.18+

Changes

None

ContainersLogs

is used for more dynamic log gathering based on the Rapid Recommendations.

The remote configuration data is fetched from the Conditional Gathering service (the endpoint is defined here). If the remote endpoint is not available or the data cannot be parsed or validated (using JSON schema defined here), the default built-in configuration (see here) is used. In case of any issues, user should check the respective clusteroperator conditions (see more information here) of the Insights Operator.

The configuration used for the data gathering is always stored in the Insights archive in the insights-operator/remote-configuration.json file.

The gatherer finds the Pods (and containers) that match the requested data and filters all the container logs to match the specific messages up to a maximum of 6 hours old.

CostManagementMetricsConfigs

Collects CostManagementMetricsConfigs definitions.

API Reference

None

Sample data

Location in archive

  • config/cost_management_metrics_configs/{name}.json

Config ID

clusterconfig/cost_management_metrics_configs

Released version

  • 4.10.0

Backported versions

  • 4.8.27+
  • 4.9.13+

Changes

None

DVOMetrics

Collects metrics from the Deployment Validation Operator's metrics service. The metrics are fetched via the /metrics endpoint and filtered to only include those with a deployment_validation_operator_ prefix. If the DVO service is deployed in a namespace other than `openshift-deployment-validation-operator', then the names of the workloads (e.g., namespace, deployment) are collected. Otherwise, only the UIDs of those resources are collected.

If no service with label selector name=deployment-validation-operator is found, then there is no dvo_metrics file in the archive (and the warning is present in the archive metadata). If a service with the selector name=deployment-validation-operator is found, but no active DVO checks are available, then the dvo_metrics file in the archive is almost empty (only the URL of the service is there).

API Reference

None

Sample data

Location in archive

  • config/dvo_metrics

Config ID

clusterconfig/dvo_metrics

Released version

  • 4.10.0

Backported versions

None

Changes

None

HelmInfo

Collects statistics about resources deployed via HelmChart, counting only the resources with app.kubernetes.io/managed-by=Helm and helm.sh/chart labels. The data is then summarized and grouped by hashed namespace.

Resource types included:

  • ReplicaSets
  • DaemonSets
  • StatefulSets
  • Services
  • Deployments

API Reference

None

Sample data

Location in archive

  • config/helmchart_info.json

Config ID

workloads/helmchart_info

Released version

  • 4.15.0

Backported versions

None

ImageStreamsOfNamespace

Closure which collects image streams from the provided namespace

API Reference

Sample data

Location in archive

Version Path
>= 4.9.0 conditional/namespaces/{namespace}/imagestreams/{name}.json

Config ID

conditional/image_streams_of_namespace

Released version

  • 4.9.0

Backported versions

None

Changes

None

InstallPlans

Collects top 100 InstallPlans from openshift-* namespaces. Because InstallPlans have unique generated names, it groups them by namespace and the "template" for name generation from field generateName. It also collects total number of all InstallPlans and all non-unique InstallPlans.

API Reference

Sample data

Location in archive

  • config/instalplans.json

Config ID

clusterconfig/install_plans

Released version

  • 4.7.0

Backported versions

  • 4.5.33+
  • 4.6.16+

Changes

None

JaegerCR

Collects maximum of 5 jaegers.jaegertracing.io custom resources installed in the cluster.

API Reference

None

Sample data

Location in archive

  • config/jaegers.jaegertracing.io/{name}.json

Config ID

clusterconfig/jaegers

Released version

  • 4.10.0

Backported versions

None

Changes

None

LogsOfNamespace

Collects logs from pods in the provided namespace.

API Reference

Sample data

Location in archive

  • conditional/namespaces/{namespace}/pods/{pod_name}/containers/{container_name}/logs/last-{n}-lines.log

Config ID

conditional/logs_of_namespace

Released version

  • 4.9.0

Backported versions

None

Changes

None

LokiStack

Collects lokistacks.loki.grafana.com resources.

The gatherer will collect up to 20 resources from openshift-* namespaces and it will report errors if it finds a LokiStack resource in a different namespace or if there are more than 20 LokiStacks in the openshift-* namespaces.

API Reference

None

Sample data

Location in archive

  • namespace/{namespace}/loki.grafana.com/lokistacks/{name}.json

Config ID

`clusterconfig/lokistacks

Released version

  • 4.19.0

Backported versions

None

Changes

None

Machine

Collects Machine information.

API Reference

Sample data

Location in archive

  • config/machines/

Config ID

clusterconfig/machines

Released version

  • 4.13.0

Backported versions

  • 4.11.29+
  • 4.12.5+

Changes

None

MachineAutoscalers

Collects MachineAutoscalers definition.

API Reference

Sample data

Location in archive

  • config/machineautoscalers/{namespace}/{name}.json

Config ID

clusterconfig/machine_autoscalers

Released version

  • 4.8.2

Backported versions

None

Changes

None

MachineConfigPool

Collects MachineConfigPool information.

API Reference

Sample data

Location in archive

  • config/machineconfigpools

Config ID

clusterconfig/machine_config_pools

Released version

  • 4.7.0

Backported versions

  • 4.5.33+
  • 4.6.16+

Changes

None

MachineConfigs

Collects definitions of in-use 'MachineConfigs' and aggregated number of non-used 'MachineConfigs'. MachineConfig is used when it's referenced in a MachineConfigPool or in Node machineconfiguration.openshift.io/desiredConfig and machineconfiguration.openshift.io/currentConfig annotations

Following data is intentionally removed from the definitions:

  • spec.config.storage.files
  • spec.config.passwd.users

API Reference

Sample data

Location in archive

  • aggregated/unused_machine_configs_count.json
  • config/machineconfigs/{resource}.json

Config ID

clusterconfig/machine_configs

Released version

  • 4.9.0

Backported versions

  • 4.8.5

Changes

  • gathers only in-use MachineConfigs and aggregated number of non-used MachineConfigs since 4.18+

MachineHealthCheck

Collects MachineHealthCheck information.

API Reference

Sample data

Location in archive

  • config/machinehealthchecks/{namespace}/{resource}.json

Config ID

clusterconfig/machine_healthchecks

Released version

  • 4.8.0

Backported versions

None

Changes

None

MachineSet

Collects MachineSet information.

API Reference

Sample data

Location in archive

  • config//machinesets/{resource}

Config ID

clusterconfig/machine_sets

Released version

  • 4.6.0

Backported versions

  • 4.4.29+
  • 4.5.15+

Changes

None

MonitoringPVs

Collects Persistent Volumes from openshift-monitoring namespace which matches with ConfigMap configuration yaml

API Reference

Sample data

Location in archive

  • config/persistentvolumes/{persistent_volume_name}.json

Config ID

clusterconfig/monitoring_persistent_volumes

Released version

  • 4.14

Backported versions

  • 4.13.0
  • 4.12.17
  • 4.11.41

Changes

None

MostRecentMetrics

Collects cluster Federated Monitoring metrics.

The GET REST query to URL /federate Gathered metrics:

  • virt_platform
  • cluster_installer
  • vsphere_node_hw_version_total
  • namespace CPU and memory usage
  • console_helm_installs_total
  • console_helm_upgrades_total
  • console_helm_uninstalls_total
  • etcd_server_slow_apply_total
  • etcd_server_slow_read_indexes_total

API Reference

None

Sample data

Location in archive

  • config/metrics

Config ID

clusterconfig/metrics

Released version

  • 4.3.0

Backported versions

None

Changes

  • etcd_object_counts introduced in version 4.3+ and removed in 4.12.0
  • cluster_installer introduced in version 4.3+
  • ALERTS introduced in version 4.3+
  • namespace:container_cpu_usage_seconds_total:sum_rate introduced in version 4.5+ and changed to namespace:container_cpu_usage:sum in 4.16.0+
  • namespace:container_memory_usage_bytes:sum introduced in version 4.5+
  • virt_platform metric introduced in version 4.8+ and backported to 4.6.34+, 4.7.16+ versions
  • vsphere_node_hw_version_total introduced in version 4.8+ and backported to 4.7.11+ version
  • console_helm_installs_total introduced in version 4.11+
  • console_helm_upgrades_total introduced in version 4.12+
  • console_helm_uninstalls_total introduced in version 4.12+
  • openshift_apps_deploymentconfigs_strategy_total introduced in version 4.13+ and backported to 4.12.5+ version
  • etcd_server_slow_apply_total introduced in version 4.16+
  • etcd_server_slow_read_indexes_total introduced in version 4.16+
  • haproxy_exporter_server_threshold introduced in version 4.17+
  • ALERTS removed in version 4.17+

MutatingWebhookConfigurations

Collects MutatingWebhookConfiguration resources.

API Reference

Sample data

Location in archive

  • config/mutatingwebhookconfigurations/{resource}.json

Config ID

clusterconfig/mutating_webhook_configurations

Released version

  • 4.10.3

Backported versions

  • 4.7.40+
  • 4.8.24+
  • 4.9.11+

Changes

None

NamespacesWithOverlappingUIDs

Collects namespaces with overlapping UID ranges.

API Reference

Sample data

Location in archive

  • config/namespaces_with_overlapping_uids.json

Config ID

clusterconfig/overlapping_namespace_uids

Released version

  • 4.11.0

Backported versions

  • 4.8.41+
  • 4.9.31+
  • 4.10.12+

Changes

None

NodeLogs

Collects control plane node logs from journal unit with following substrings:

  • E\d{4} [0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}
  • connect: connection refused
  • failed (failure): command timed out
  • Failed to make webhook authenticator request: Post
  • raise JSONDecodeError("Expecting value", s, err.value) from None
  • ContainerStateWaiting{Reason:ContainerCreating
  • ContainersNotReady Message:containers with unready status
  • MountVolume.MountDevice failed for volume
  • kubernetes.io/csi: attacher.MountDevice failed to create newCsiDriverClient
  • Unable to attach or mount volumes: unmounted volumes
  • timed out waiting for the condition
  • CreateContainerError: context deadline exceeded
  • rpc error: code = ResourceExhausted desc = grpc: received message larger than max

API Reference

Sample data

Location in archive

  • config/nodes/logs/{hostname}.log

Config ID

clusterconfig/node_logs

Released version

  • 4.10.0

Backported versions

None

Changes

None

NodeNetworkConfigurationPolicy

Collects cluster scope "nodenetworkconfigurationpolicy.nmstate.io/v1" resources

API Reference

Sample data

Location in archive

  • cluster-scoped-resources/nmstate.io/nodenetworkconfigurationpolicies/{name}.json

Config ID

clusterconfig/nodenetworkconfigurationpolicies

Released version

  • 4.18.0

Backported versions

Changes

NodeNetworkState

Collects cluster scope "nodenetworkstate.nmstate.io/v1beta1" resources

API Reference

Sample data

Location in archive

  • cluster-scoped-resources/nmstate.io/nodenetworkstates/{name}.json

Config ID

clusterconfig/nodenetworkstates

Released version

  • 4.18.0

Backported versions

Changes

Nodes

Collects all node resources.

API Reference

Sample data

Location in archive

  • config/node/{node}.json

Config ID

clusterconfig/nodes

Released version

  • 4.2.0

Backported versions

None

Changes

None

Anonymization

  • Removes any annotation that does not match specific namespaces (openshift.io/, k8s.io/, kubernetes.io/).
  • Replaces the values of any label that matches the previously listed namespaces and not a region label (failure-domain.beta.kubernetes.io/region, topology.kubernetes.io/region) with 'x' strings while preserving its length.
  • Replaces the values of the node's status object fields such as BootID, SystemUUID, and MachineID with 'x' strings preserving the same length.
  • Clears the Images field of the node's status object, removing any information about the container images running on the node.

NumberOfPodsAndNetnamespacesWithSDNAnnotations

Collects number of Pods with the annotation: pod.network.openshift.io/assign-macvlan and also collects number of Netnamespaces with the annotation: netnamespace.network.openshift.io/multicast-enabled: "true"

Sample data

Location in archive

  • aggregated/pods_and_netnamespaces_with_sdn_annotations.json

Config ID

clusterconfig/pods_and_netnamespaces_with_sdn_annotations

Released version

  • 4.17.0

Backported versions

Changes

None

OLMOperators

Collects the list of installed OLM operators. Each OLM operator (in the list) contains following data:

  • OLM operator name
  • OLM operator version
  • related ClusterServiceVersion conditions

API Reference

None

Sample data

Location in archive

  • config/olm_operators

Config ID

clusterconfig/olm_operators

Released version

  • 4.7.0

Backported versions

  • 4.6.26+

Changes

None

OpenshiftLogging

Collects clusterlogging.logging.openshift.io resources.

API Reference

Sample data

Location in archive

  • config/logging/{namespace}/{name}.json

Config ID

clusterconfig/openshift_logging

Released version

  • 4.9.0

Backported versions

None

Changes

None

OpenshiftMachineAPIEvents

Collects warning ("abnormal") events from openshift-machine-api namespace

API Reference

None

Sample data

Location in archive

  • events/openshift-machine-api.json

Config ID

clusterconfig/openshift_machine_api_events

Released version

  • 4.12.0

Backported versions

None

Changes

None

OpenstackControlplanes

Collects openstackcontrolplanes.core.openstack.org resources from all namespaces

API Reference

None

Sample data

Location in archive

  • namespaces/{namespace}/core.openstack.org/openstackcontrolplanes/{name}.json

Config ID

clusterconfig/openstack_controlplanes

Released version

  • 4.17

Changes

None

OpenstackDataplaneDeployments

Collects openstackdataplanedeployments.dataplane.openstack.org resources from all namespaces

API Reference

None

Sample data

Location in archive

  • namespaces/{namespace}/dataplane.openstack.org/openstackdataplanedeployments/{name}.json

Config ID

clusterconfig/openstack_dataplanedeployments

Released version

  • 4.17

Changes

None

OpenstackDataplaneNodeSets

GatherOpenstackDataplaneNodesets Collects openstackdataplanenodesets.dataplane.openstack.org resources from all namespaces

API Reference

None

Sample data

Location in archive

  • namespaces/{namespace}/dataplane.openstack.org/openstackdataplanes/{name}.json

Config ID

clusterconfig/openstack_dataplanenodesets

Released version

  • 4.17

Changes

None

OpenstackVersions

Collects openstackversion.core.openstack.org resources from all namespaces

API Reference

None

Sample data

Location in archive

  • namespaces/{namespace}/core.openstack.org/openstackversion/{name}.json

Config ID

clusterconfig/openstack_version

Released version

  • 4.17

Changes

None

PodDefinition

Collects pod definition from pods that are firing one of the configured alerts.

API Reference

None

Sample data

Location in archive

  • conditional/namespaces/{namespace}/pods/{name}/{name}.json

Config ID

conditional/pod_definition

Released version

  • 4.11.0

Backported versions

None

Changes

None

PodDisruptionBudgets

Collects the cluster's PodDisruptionBudgets.

API Reference

Sample data

Location in archive

  • config/pdbs/{namespace}/{name}.json

Config ID

clusterconfig/pdbs

Released version

  • 4.6.0

Backported versions

  • 4.4.30+
  • 4.5.15+

Changes

  • The gatherer was changed to gather pdbs only from namespaces with "openshift" prefix and the limit of gathered records to 100 since 4.14.

PodNetworkConnectivityChecks

Collects a summary of failed PodNetworkConnectivityChecks from last 24 hours.

Time of the most recently failed check with each reason and message is recorded.

API Reference

Sample data

Location in archive

  • config/podnetworkconnectivitychecks.json

Config ID

clusterconfig/pod_network_connectivity_checks

Released version

  • 4.8.2

Backported versions

None

Changes

None

PrometheusTSDBStatus

Collects Prometheus TSDB status.

API Reference

None

Sample data

Location in archive

  • config/tsdb.json

Config ID

clusterconfig/tsdb_status

Released version

  • 4.10.0

Backported versions

None

Changes

None

SAPConfig

Collects selected security context constraints and cluster role bindings from clusters running a SAP payload.

API Reference

Sample data

Location in archive

  • config/clusterrolebinding/{name}.json
  • config/securitycontentconstraint/{name}.json

Config ID

clusterconfig/sap_config

Released version

  • 4.7.0

Backported versions

  • 4.6.20+

Changes

None

SAPDatahubs

Collects datahubs.installers.datahub.sap.com resources from SAP/SDI clusters.

API Reference

None

Sample data

Location in archive

  • customresources/installers.datahub.sap.com/datahubs/{namespace}/{name}.json

Config ID

clusterconfig/sap_datahubs

Released version

  • 4.8.2

Backported versions

  • 4.7.5+
  • 4.6.26+

Changes

None

SAPPods

Collects information about pods running in SAP/SDI namespaces.

  • Only pods with a failing status are collected.
  • Failed pods belonging to a job that has later succeeded are ignored.

Note This data is collected only if the installers.datahub.sap.com resource is found in the cluster.

API Reference

Sample data

Location in archive

  • config/pod/{namespace}/{name}.json

Config ID

clusterconfig/sap_pods

Released version

  • 4.8.2

Backported versions

  • 4.7.5+
  • 4.6.25+

Changes

None

Schedulers

Collects information about schedulers

API Reference

Sample data

Location in archive

  • config/schedulers/cluster.json

Config ID

clusterconfig/schedulers

Released version

  • 4.10.0

Backported versions

None

Changes

None

ServiceAccounts

Collects ServiceAccount stats from kubernetes default and openshift-* namespaces.

API Reference

Sample data

Location in archive

  • config/serviceaccounts.json

Config ID

clusterconfig/service_accounts

Released version

  • 4.7.0

Backported versions

  • 4.5.34+
  • 4.6.20+

Changes

None

SilencedAlerts

Collects the alerts that have been silenced.

API Reference

None

Sample data

Location in archive

  • config/silenced_alerts.json

Config ID

config/silenced_alerts

Released version

  • 4.10.0

Backported versions

None

Changes

None

StorageClasses

Collects the cluster StorageClass available in cluster.

API Reference

Sample data

Location in archive

  • config/storage/storageclasses/{name}.json

Config ID

clusterconfig/storage_classes

Released version

  • 4.15

Backported versions

None

Changes

None

StorageCluster

Collects storageclusters.ocs.openshift.io resources

API Reference

Sample data

Version Path
< 4.12.0 config/storage/{namespace}/{name}.json
>= 4.12.0 config/storage/{namespace}/storageclusters/{name}.json

Config ID

clusterconfig/storage_cluster

Released version

  • 4.11.0

Backported versions

None

Changes

  • Renamed from OpenshiftStorage to StorageCluster in version 4.12.0+
  • Config ID changed from clusterconfig/openshift_storage to clusterconfig/storage_cluster in version 4.12.0+
  • In OCP 4.11 and OCP 4.12, the location of gathered data collides with data gathered by the CephCluster](#CephCluster) gatherer. It is practically impossible to tell the two resources apart. Use with caution.

SupportSecret

Collects anonymized support secret if there is any

API Reference

None

Sample data

Location in archive

  • config/secrets/openshift-config/support/data.json

Config ID

clusterconfig/support_secret

Released version

  • 4.11.0

Backported versions

None

Changes

None

ValidatingWebhookConfigurations

Collects ValidatingWebhookConfiguration resources

API Reference

Sample data

Location in archive

  • config/validatingwebhookconfigurations/{name}.json

Config ID

clusterconfig/validating_webhook_configurations

Released version

  • 4.10.3

Backported versions

  • 4.7.40+
  • 4.8.24+
  • 4.9.11+

Changes

None

WorkloadInfo

Collects summarized info about the workloads on a cluster in a generic fashion

API Reference

None

Sample data

Location in archive

  • config/workload_info.json

Config ID

workloads/workload_info

Released version

  • 4.8.0

Backported versions

None

Changes

  • Image repository is now collected if it comes from outside the Red Hat domain
  • [Tech Preview] runtime info for workloads are collected (since 4.18.0)