Developer Documentation

April 18, 2026 · View on GitHub

This documentation is for developers and contributors who want to understand the Kepler Operator codebase, contribute code, or maintain the project.

Looking to use Kepler Operator? See the User Guides instead.

Audience

This documentation is for:

  • Contributors adding features or fixing bugs
  • Maintainers managing releases and project infrastructure
  • Developers wanting to understand internal architecture
  • Anyone building on or extending Kepler Operator

Code Organization

🏠 kepler-operator
│
├── .github          👈  ⚙️  GitHub Actions workflows and CI/CD
│   └── workflows
│
├── api              👈  📋 Kubernetes API types
│   └── v1alpha1        CRDs (Kepler, PowerMonitor, etc)
│
├── bundle           👈  📦 Autogenerated OLM bundle
│   ├── manifests
│   ├── metadata
│   └── tests
│
├── cmd              👈  🚀 Main entrypoint
│   └── main.go         Operator manager CLI
│
├── config           👈  ⚙️  Kustomize configs (source of truth for manifests)
│   ├── certmanager     Cert-manager for webhooks
│   ├── crd             CRD definitions
│   ├── default         Main kustomization overlays
│   ├── manager         Manager deployment config
│   ├── manifests       OLM bundle kustomization
│   ├── network-policy  Network policies
│   ├── prometheus      ServiceMonitor configs
│   ├── rbac            RBAC resources
│   ├── samples      👈 Sample CRs for users
│   ├── scorecard       Operator scorecard tests
│   └── webhook         Webhook configurations
│
├── docs
│   ├── design       👈  📐 Architecture and design docs
│   ├── developer    👈  👩‍💻 Developer/contributor guides
│   ├── logo            Project logos and assets
│   └── user         👈  📖 User guides and documentation
│
├── hack             👈  🛠️  Development scripts and tools
│   ├── crds            CRD utilities
│   ├── dashboard       Grafana dashboard assets
│   ├── helm            Helm chart tooling and validation
│   ├── monitoring      Monitoring setup scripts
│   └── reports         Report generation utilities
│
├── internal         👈  🔒 Private application code
│   ├── config          Operator configuration management
│   └── controller      Reconciler implementations
│
├── manifests        👈  📦 Distribution manifests
│   └── helm            Helm chart for operator deployment
│
├── must-gather      👈  🔍 Debugging and diagnostics collection
│
├── pkg              👈  📚 Public reusable packages
│   ├── components      Component manifest builders (PowerMonitor, etc)
│   ├── reconciler      Generic reconciliation framework
│   ├── utils           Utility functions (k8s, test helpers)
│   └── version         Version information
│
└── tests            👈  🧪 Test suites
    ├── e2e             End-to-end tests
    ├── testdata        Test fixtures and data
    └── utils           Test utilities and helpers

How do I get started?

Developer Guides