The Must Gather Operator is a Kubernetes operator written in Go designed specifically for OpenShift OSDv4 clusters to automate the collection and upload of diagnostic must-gather information. The operator enables Cluster Execution Environment (CEE) members to gather cluster diagnostics and submit them directly to support cases without manual intervention. By creating a MustGather custom resource, cluster administrators can trigger the collection of standard must-gather data and have it automatically uploaded to a specified support case using credentials stored in a Kubernetes secret.
The operator provides flexible configuration options for diagnostic collection. The audit log collection feature is disabled by default but can be explicitly enabled by setting the audit field to true, which triggers the default audit log collection script from the must-gather repository. This design allows operators to control the scope of data collection based on their specific troubleshooting needs. The operator handles the complete lifecycle of must-gather operations, from initiation through cleanup, automatically removing MustGather instances and their associated job resources approximately six hours after completion to prevent resource accumulation.
Deployment of the Must Gather Operator is straightforward and cluster-level, allowing installation in any namespace with must-gather-operator being the recommended choice. The operator requires specific prerequisites to function, including a secret containing case management credentials that must be created by administrators before the operator can upload data to support cases. For local development, the operator supports running locally using the operator-sdk framework, with developers able to customize the operator image through environment variables in the deployment manifest.
According to GitGenius activity tracking, the repository shows relatively slow issue and pull request response latencies, with a median response time of 665.6 hours and a mean of 4152.2 hours across tracked items. The most active contributor tracked is sebrandon1 with three events, followed by b-mchugh and jbpratt with one event each. The repository has experienced lifecycle issues marked as rotten and tide merge-blocker labels, indicating some periods of reduced maintenance activity. The codebase shares contributors with several other OpenShift repositories including openshift/installer, openshift/coredns, and openshift/node-problem-detector, suggesting integration points and shared development practices across the OpenShift ecosystem.
The operator is classified across multiple domains including OpenShift, Kubernetes, Diagnostics, Troubleshooting, Data Collection, Automation, Cluster Operations, Operator Framework, Support Tools, and System Health. This broad classification reflects its role as a critical support infrastructure component that bridges cluster diagnostics with case management systems, automating what would otherwise be manual troubleshooting workflows for OpenShift administrators and support teams.
