Kopf Versions Save

WARNING: The changes are backward-compatible (in theory). But the changes are also massive, so things can break unexpectedly (in practice). Test this upgrade carefully.

New features:

• @kopf.daemon for background resource-accompanying tasks/threads. #330 #342 #360
• @kopf.timer for regular and/or delayed activities & checks. #330 #342 #360
• kopf.PRESENT for labels/annotations filters (instead of misleading None). #327
• kopf.ABSENT for labels/annotations filters. #327
• Arbitrary callbacks for labels/annotations filters. #328
• kopf.all_(), kopf.any_(), kopf.not_(), kopf.none_() helpers for callbacks aggregation. #345
• A proper official documented way to configure operators; plus docs. #336 #337 #331
• Identities of operators, allowing multiple non-colliding operators for the same resources. #331 #344
• Configurable client-side timeouts for watch requests. #322 #336
• Configurable storages for handling state & diff-bases. #331 #346 #353

Improvements:

• Internal instant functions (lifecycles, when-filters) do not use thread pools anymore. #326
• Bodies & patches now have magical properties for metadata, spec, status, with "live view" into data. #327
• Labels and annotations are passed as additional kwargs (similar to body/spec/meta/status). #327
• All user-facing types and classes are published as framework's public interface (via top-level package). #341
• Switch KopfExample & KopfPeering from v1beta1 to v1 CRD API; keep v1beta1 nearby. #364
• Documentation is restructured for separate pages for all aspects of handling (kwargs, filters, etc). #325
• Explain the "structural schemas" of K8s 1.16+, and v1-vs-v1beta1 CRD differences. #364

Fixes:

• Threads from the sync handlers executors are not leaked (not left orphaned) at exit. #326
• Handlers' state is now persisted in annotations, not in status: for custom & built-in resources. This solves the issues with built-ins not handled properly in K8s 1.16+. #331
• Fix the on-field handler not being invoked when the diff is too generic (relative to the field). #340
• Provoke after-sleep handling cycles even on resources with no arbitrary field preservation. #343
• Fix premature finalizer removal with 2+ deletion handlers. #361
• Avoid no-effect patching and potentially delaying handling cycles. #362

Internal changes:

• Coveralls is made optional. #363
• Compatibility with Kubernetes 1.18 in CI/CD. #335
• pytest & pytest-asyncio are pinned temporarily until fixed on their side. #352

Documentation:

• Explain the "structural schemas" of K8s 1.16+, and v1-vs-v1beta1 CRD differences. #364
• Switch KopfExample & KopfPeering from v1beta1 to v1 CRD API; keep v1beta1 nearby. #364

Fixes:

• Better detection of instantly exiting daemons/timers. #360
• Fix premature finalizer removal with 2+ deletion handlers. #361
• Avoid no-effect patching and potentially delaying handling cycles. #362

Internal changes:

• Coveralls is made optional. #363

Fixes:

• Restrict annotation names to end with alphanumeric characters only. #353

Internal changes:

• pytest & pytest-asyncio are pinned temporarily until fixed on their side. #352

Fixes:

• Limit annotation names for handlers' statuses to 63 characters. #346

Improvements:

• kopf.all_(), kopf.any_(), kopf.not_(), kopf.none_() helpers for callbacks aggregation. #345

Improvements:

• Make finalizer's name configurable. #344
• Daemons-with-filters' behaviour is clarified: stop when mismatches, re-spawn when matches again. #342
• All user-facing types and classes are published as framework's public interface (via top-level package). #341

Fixes:

• Fix the on-field handler not being invoked when the diff is too generic (relative to the field). #340
• Provoke after-sleep handling cycles even on resources with no arbitrary field preservation. #343

WARNING: The changes are backward-compatible (in theory). But the changes are also massive, so things can break unexpectedly (in practice). Test this upgrade carefully.

New features:

• @kopf.daemon for background resource-accompanying tasks/threads. #330
• @kopf.timer for regular and/or delayed activities & checks. #330
• kopf.PRESENT for labels/annotations filters (instead of misleading None). #327
• kopf.ABSENT for labels/annotations filters. #327
• Arbitrary callbacks for labels/annotations filters. #328
• A proper official documented way to configure operators; plus docs. #336 #337
• Operators can be configured to use their own names for persistence, allowing multiple non-colliding operators for the same resources. #331

Improvements:

• Internals instant functions (lifecycles, when-filters) do not use thread pools anymore. #326
• Documentation is restructured for separate pages for all aspects of handling (kwargs, filters, etc). #325
• Bodies & patches now have magical properties for metadata, spec, status, with "live view" into data. #327
• Labels and annotations are passed as additional kwargs (similar to body/spec/meta/status). #327
• Configurable client-side timeouts for watch requests. #322 #336
• Configurable storages for handling state & diff-bases. #331

Fixes:

• Threads from the sync handlers executors are not leaked (not left orphaned) at exit. #326
• Handlers' state is now persisted in annotations, not in status: for custom & built-in resources. This solves the issues with built-ins not handled properly in K8s 1.16+. #331

Internal changes:

• Compatibility with Kubernetes 1.18 in CI/CD. #335

Improvements:

• Status as a sub-resource is detected and patched via separate API endpoints. #313
• Security: Stop exposing the Authorization: and other HTTP headers in logs. #306
• Documentation's little fixes. #97 #303

CI/CD automation:

• Warnings now do fail the tests (warnings must be fixed — same as regular errors). #312
• Python 3.8 in CI/CD. Python 3.7 is still tested. Python 3.9-dev for preview. #314
• LGTM checks added to CI/CD, code improved. #302

Internal changes:

• Rebalanced modules for lower complexity: classes & functions moved. #298
• Deprecate prefixes and proxying methods of registries, make registries simpler. #315

Improvements:

• Status as a sub-resource is detected and patched via separate API endpoints. #313
• Security: Stop exposing the Authorization: and other HTTP headers in logs. #306
• Documentation's little fixes. #97 #303

CI/CD automation:

• Warnings now do fail the tests (warnings must be fixed — same as regular errors). #312
• Python 3.8 in CI/CD. Python 3.7 is still tested. Python 3.9-dev for preview. #314
• LGTM checks added to CI/CD, code improved. #302

Internal changes:

• Rebalanced modules for lower complexity: classes & functions moved. #298
• Deprecate prefixes and proxying methods of registries, make registries simpler. #315

New features:

• Handler/resource filtering with arbitrary callbacks in when= option. #258 #288

Bugfixes:

• Reaction cycle stops in the middle with no messages (improper "now" comparison). #285

Internal improvements:

• aiohttp 4.x readiness (restriction to stay on 3.x). #277
• Better GitHub issue/PR templates. #278