Objective

Create comprehensive AGENTS.md file for the cluster-monitoring-operator repository following the pattern from openshift/api.

Scope

The cluster-monitoring-operator is the main operator that manages and updates the Prometheus-based monitoring stack on OpenShift, including:

• Prometheus Operator
• Prometheus (platform and user-workload)
• Alertmanager (platform and user-workload)
• kube-state-metrics
• node-exporter
• metrics-server
• openshift-state-metrics
• Thanos Querier and Ruler
• Telemeter Client
• Monitoring Plugin

Content Requirements

The AGENTS.md file should document:

1. Repository Overview

• Purpose: Main operator managing the monitoring stack
• Key responsibilities: component lifecycle, configuration management, reconciliation
• Relationship to prometheus-operator and other components

2. Architecture Components

• Main packages and their purposes (pkg/manifests, pkg/tasks, pkg/operator)
• Jsonnet-based manifest generation system
• Component reconciliation patterns
• Configuration validation (pkg/configvalidate)

3. Development Workflow

# Building
make build
make operator

# Jsonnet manifest generation
make generate
make check-assets

# Testing
make test
make test-e2e

# Local development
hack/local-cmo.sh

4. Key Patterns

• Task-based reconciliation architecture
• Jsonnet manifest generation and templating
• Multi-component orchestration
• FeatureGate integration
• Configuration inheritance (platform vs user-workload)

5. Common Tasks

• Adding new monitoring components
• Updating component versions
• Modifying alert rules
• Configuration API changes
• Testing strategies (unit, e2e, integration)

Acceptance Criteria

• [ ] AGENTS.md file created in repository root
• [ ] Content covers all required sections
• [ ] Follows structure from openshift/api template
• [ ] Includes accurate build/test commands
• [ ] Documents jsonnet workflow
• [ ] Reviewed by component maintainers
• [ ] PR merged to main branch

Reference

• Template: openshift/api AGENTS.md
• Repository: cluster-monitoring-operator
• Documentation: Development Guide