Kopf Documentation Reference¶
Full documentation index: https://docs.kopf.dev/en/stable/
The ODA Canvas uses kopf==1.37.2, but all patterns described here apply. Links point to the stable doc channel which reflects the current maintained release.
Handler Types¶
Topic |
URL |
When to consult |
|---|---|---|
Handlers overview |
All handler types: create, update, resume, delete, field, event, sub-handlers â start here |
|
Timers |
|
|
Daemons |
Long-running |
|
Admission control |
|
|
Arguments reference |
Complete list of handler kwargs: |
|
Filtering |
|
|
Results delivery |
How handler return values are written to |
|
Error handling |
|
|
Async/Await |
When to use |
|
Sub-handlers |
|
|
Scopes |
Namespace-scoped ( |
|
Resource specification |
Selector syntax (group/version/plural), by-category, catch-all |
Operator Configuration¶
Topic |
URL |
When to consult |
|---|---|---|
Startup |
|
|
Configuration |
All settings: |
|
Peering |
Multi-operator coordination, |
|
Health checks |
|
|
Authentication |
Custom Kubernetes client auth, |
|
Command-line options |
All |
Toolkits & Patterns¶
Topic |
URL |
When to consult |
|---|---|---|
Hierarchies |
|
|
Events |
|
|
In-memory containers |
|
|
In-memory indexing |
|
|
Patching |
Modifying the |
|
Loading and importing |
Splitting operators across multiple Python files/modules |
Deployment & Operations¶
Topic |
URL |
When to consult |
|---|---|---|
Docker image |
Dockerfile patterns, image variants ( |
|
Deployment |
RBAC setup (ServiceAccount + ClusterRole + ClusterRoleBinding), service account template |
|
Continuity |
How kopf persists state across restarts; finalizers; progress storage |
|
Idempotence |
Making handlers safe to re-run; get-or-create patterns; 409 Conflict handling |
|
Reconciliation |
Edge-based vs level-based triggering; when to use timers/daemons for reconciliation |
|
Tips & Tricks |
Excluding handlers forever ( |
|
Troubleshooting |
|
Testing¶
Topic |
URL |
When to consult |
|---|---|---|
Operator testing |
|