kubernetes/sample-controller
Sample Controller
Sample Controller is a reference implementation and developer toolkit for building custom controllers and operators to extend cluster capabilities with domain-specific resource types and reconciliation loops. It provides a foundational framework for defining, registering, and validating custom resource definitions and their instances to store domain-specific data within a cluster.
The framework observes remote API servers for resource mutations, queueing discovered instances for asynchronous processing while listening for creation, update, and deletion events to trigger reconciliation logic. It features automated code generation that produces strongly typed API clients, informers, listers, and deep-copy utilities directly from type definitions. Additionally, the project includes mechanisms for managing subresources, enforcing structural validation schemas, and maintaining thread-safe internal stores with custom indexing functions for rapid object retrieval.
Features
- Custom Resource Definitions - Defines, registers, and validates custom resource definitions and their instances to store domain-specific data in a cluster.
- Dynamic Resource Watching - Watches the API server for changes to custom resource instances to trigger asynchronous reconciliation logic.
- Kubernetes Operators - Builds custom controllers and operators to extend cluster capabilities with domain-specific resource types and reconciliation loops.
- API Client Generators - Automatically produces strongly typed API clients, informers, listers, and deep-copy utilities directly from type definitions.
- Kubernetes Resource Validation - Enforces structural schemas and data validation rules on custom resources to ensure correct data formats before acceptance.
- Custom Resource Controllers - Declares new custom resource types in a cluster so users can manage domain-specific entities using standard tooling.
- Custom Resource Status Management - Exposes dedicated status and scaling endpoints on custom resources to track operational states and adjust workloads.
- Kubernetes API Clients - Generates strongly-typed API clients, informers, and listers automatically from type definitions to interact safely with cluster resources.
- Resource Event Triggers - Listens for creation, update, and deletion events on custom resources to trigger reconciliation logic.
- Kubernetes Controllers - Provides a reference implementation and educational guide for building custom controllers that watch and reconcile domain-specific resources.
- Asynchronous Event Queueing - Decouples resource delivery from execution by queueing object keys via callback handlers and running asynchronous worker tasks.
- Instance Lifecycle Management - Handles the creation, retrieval, listing, and watching of custom resource instances through event-driven handlers.
