How rhobs/observability-operator works
The Observability Operator manages Kubernetes monitoring stacks and related observability capabilities through custom resources. A user creates CRDs; the manager registers controllers that reconcile desired resources, status, and cleanup. The main branches cover monitoring/alerting, Thanos query, tracing/logging installation, and console UI plugins. A separate must-gather command collects cluster diagnostics. Edges follow explicit README or excerpted wiring; unsampled controller details are represented only where the SOURCE INDEX supports their modules.
Main entry points: operator.go Controller manager · monitoring-stack/controller.go Stack reconciler · thanos-querier/controller.go Thanos reconciler · observability_controller.go Capability installer
Components 27
Operator runtime
- Operator entrypoint
cmd/operator/main.go - Controller manager
pkg/operator/operator.go - Custom resource APIs
pkg/apis
Monitoring controllers
- MonitoringStack API
pkg/apis/monitoring/v1alpha1/types.go - Stack reconciler
pkg/controllers/monitoring/monitoring-stack/controller.go - Stack components
pkg/controllers/monitoring/monitoring-stack/components.go - Alertmanager resources
pkg/controllers/monitoring/monitoring-stack/alertmanager.go - Thanos reconciler
pkg/controllers/monitoring/thanos-querier/controller.go - Thanos components
pkg/controllers/monitoring/thanos-querier/components.go
Observability capabilities
- Installer API
pkg/apis/observability/v1alpha1 - Capability installer
pkg/controllers/observability/observability_controller.go - Capability reconcilers
pkg/controllers/observability/reconcilers.go - Tempo components
pkg/controllers/observability/tempo_components.go - OpenTelemetry components
pkg/controllers/observability/otel_components.go - UIPlugin API
pkg/apis/uiplugin/v1alpha1/types.go - Plugin reconciler
pkg/controllers/uiplugin/controller.go - Plugin resources
pkg/controllers/uiplugin/components.go - Monitoring UI
pkg/controllers/uiplugin/monitoring.go - UI extensions
pkg/controllers/uiplugin/accelerators.go
Cluster diagnostics
- Must-gather command
must-gather/cmd/main.go - Gather orchestrator
must-gather/gather.go - Monitoring collector
must-gather/internal/monitoring/collector.go - Kubernetes client
must-gather/internal/client/client.go
Other components
- Cluster admin
- Kubernetes API
- Support engineer
- Collected diagnostics
Connections 34
- Cluster admin → Operator entrypoint: starts operator
README.md - Operator entrypoint → Controller manager: configures and starts
cmd/operator/main.go - Controller manager → MonitoringStack API: registers APIs
- Controller manager → Stack reconciler: registers controller
pkg/operator/operator.go - Controller manager → Thanos reconciler: registers controller
pkg/operator/operator.go - Controller manager → Capability installer: registers controller
pkg/operator/operator.go - Controller manager → Plugin reconciler: registers controller
pkg/operator/operator.go - Cluster admin → MonitoringStack API: submits desired state
README.md - MonitoringStack API → Stack reconciler: watches resources
- Stack reconciler → Stack components: builds reconcilers
pkg/controllers/monitoring/monitoring-stack/controller.go - Stack components → Alertmanager resources: creates resources
pkg/controllers/monitoring/monitoring-stack/components.go - Stack reconciler → Kubernetes API: reconciles resources
- Cluster admin → Thanos reconciler: requests query service
- Thanos reconciler → Thanos components: reconciles components
- Thanos reconciler → Kubernetes API: reads and writes
- Cluster admin → Installer API: submits capabilities
README.md - Installer API → Capability installer: triggers reconcile
pkg/controllers/observability/observability_controller.go - Capability installer → Capability reconcilers: delegates reconcile
pkg/controllers/observability/observability_controller.go - Capability reconcilers → Tempo components: reconciles tracing
- Capability reconcilers → OpenTelemetry components: reconciles telemetry
- Capability installer → Kubernetes API: reads and patches
pkg/controllers/observability/observability_controller.go - Cluster admin → UIPlugin API: configures plugins
- UIPlugin API → Plugin reconciler: triggers reconcile
- Plugin reconciler → Plugin resources: builds plugin resources
- Plugin reconciler → Kubernetes API: registers console plugin
pkg/controllers/uiplugin/controller.go - Plugin resources → Monitoring UI: adds monitoring support
- Plugin resources → UI extensions: adds UI features
- Support engineer → Must-gather command: runs collection
must-gather/cmd/main.go - Must-gather command → Gather orchestrator: creates and runs
must-gather/cmd/main.go - Gather orchestrator → Monitoring collector: runs collector
must-gather/gather.go - Gather orchestrator → Kubernetes client: creates Kubernetes client
must-gather/gather.go - Monitoring collector → Kubernetes client: queries cluster
must-gather/internal/monitoring/collector.go - Kubernetes client → Kubernetes API: lists and proxies
must-gather/internal/client/client.go - Monitoring collector → Collected diagnostics: writes diagnostics