How redhat-developer/observability-operator works
Main Components
a. Core Operator Components:
• Controller Manager (central component)
• Webhook Server (for validation/mutation)
• Custom Resource Definition (CRD) for Observability
• Reconciliation Logic Components
b. External Systems:
• Observatorium Integration
• GitHub Configuration Repository
• Authentication Systems (Red Hat SSO/Dex)
c. Managed Components:
• Prometheus Stack
• Grafana
• Promtail
• AlertManager
┌─ Observability Operator ──────────────────────┐
• ┌─ Controller Manager ─┐ ┌─ Webhook Server ─┐ │
• Reconcilers │ │ - Validation │ │
• Token Management │ │ - Mutation │ │
• ┘ └────────────────┘ │
• ┘
┌─ Prometheus ─┐ ┌─ Grafana ─┐ ┌─ Promtail ─┐
• Metrics │ │ Dashboards│ │ Logging │
• ┘ └──────────┘ └───────────┘
┌─ Observatorium ─┐ ┌─ GitHub Config ─┐ ┌─ Auth ─┐
• Central Storage │ │ Service Configs │ │ SSO │
• ┘ └────────────────┘ └────────┘
Important Details
a. Reconciliation Flows:
• How the operator watches for Observability CRs
• Configuration reading from GitHub
• Token management flow
b. Monitoring Stack:
• Metric collection paths
• Log aggregation flow
• Alert routing
c. Configuration Management:
• How external configs are pulled
• Secret management
• Resource creation flow
Implementation Details
• Controllers package structure
• Reconciler hierarchy
• Resource management patterns
• Webhook configurations
Remember to:
• Use consistent styling
• Version information
• Document all external dependencies