kopf

Bugfixes:

• Assume a singular name is a lowercased kind for builtins (API returns empty names). #629
• Give the simulated script-module a name — to make it visible for other libraries (e.g. Pydantic). #634
• Exclude kind: Event from EVERYTHING to avoid "resource explosion". #636

Documentation:

• Document optional RBAC permissions needed for runtime cluster observation. #630
• Switch documentation, examples, and peering from kopf.zalando.org/v1 to kopf.dev/v1 (but not annotations and finalizers). #643 #644

Other internal changes:

• Use Python's defaults instead of our own simulated dicts. #637
• Validate the resource scope against requested namespace. #638
• Make the tests shorter and cleaner. #639
• Re-adjust tests to a newer pytest-mock with asynctest. #645

BREAKING CHANGES! The major version increase (0.x → 1.x) means that there are changes in the public interface with no backwards compatibility. Pay attention when upgrading — most of them have quick replacements.

Most of these legacies are extremely old and it is highly unlikely that they were used in any existing operators. The DeprecationWarnings were issued for all these features (except namespaces). See #511.

Removed feature	Replacement feature
cooldown= option of decorators	backoff= option
event kwarg in @kopf.on.event	reason kwarg
cause kwarg in handlers	use all kwargs directly
kopf.login() sync function	@kopf.on.login handlers and async activities
kopf.config module	settings kwarg of @kopf.on.startup() handlers
kopf.config.get_pykube_cfg() for patching	@kopf.on.login() handlers
kopf.HandlerFatalError	kopf.PermanentError
kopf.HandlerRetryError	kopf.TemporaryError
kopf.create_tasks() (sync)	kopf.spawn_tasks() (async)
kopf.events.event/info/warn/exception()	the same directly in the kopf module
None for labels=/annotations= filters	kopf.PRESENT (None now raises exceptions)
Positional field in @on.field('group', 'v1', 'plural', 'field')	kwarg field='field' instead
Unversioned keys in storages	generate v1/v2 keys explicitly
Storages with unprefixed annotations	prefix is now mandatory; defaults to kopf.zalando.org/…
@kopf.on.this(…) for sub-handlers	@kopf.subhandler(…) (for readability)

Dropped without replacements:

• Public fields & methods of OperatorRegistry — use it only as an object for the registry= kwarg. #625 #611
• All internal sub-registries: Resource[Watching|Spawning|Changing]Registry, ActivityRegistry. #625 #611
• All legacy registries: SimpleRegistry, GlobalRegistry, etc. #625

Deprecated:

• operator(namespace='…') → operator(namespaces=['…']). #600
• operator(namespace=None) → operator(clusterwide=True). #600

New features:

• Namespace serving:
  • Multiple namespaces: e.g. -n default -n myapp. #500
  • Namespace globs: e.g. --namespace myapp-*,!*-pr-*. #500
  • Namespace precompiled regexps (only in embedded mode). #500
• Resource serving:
  • Resources specified partially with/without versions: @kopf.on.event('kopf.dev', 'kex'). #500
  • Resources specified by secondary names (short, singular, kind): @kopf.on.event(kind='Pod'). #500
  • Resources specified by minimally sufficient auto-guess names: @kopf.on.event('pods'). #500
  • Handling of whole categories of resources: @kopf.on.event(category='all'). #500
  • Handling of all resources (do not try on real clusters): @kopf.on.event(kopf.EVERYTHING). #500
• Field filters:
  • Fields' presence/absence filters: e.g. @kopf.on.event(…, field='spec.field', value=kopf.PRESENT). #573
  • Fields' value filters: e.g. @kopf.on.event(…, field='spec.field', value='value'); callbacks are supported. #573
  • Fields' diff filters (only for update): @kopf.on.update(…, field='spec.field', old=1, new=2); callbacks are supported. #573
  • Fields' filters are now applicable to all handlers: creation/update/deletion/resuming, daemons, timers, events. #573
• Peering behaviour is now configurable via settings. #572

Improvements:

• The operator's core ("reactor") is full reworked for dynamic detection of resources and namespaces. #600
• Better identifiers of peers in IPv6 networks: for easier identification. #569
• Better log messages in change-detecting processing: #605
• Faster (near-instant) unfreezing when peers are gone/expire. #581
• More notes on x-kubernetes-preserve-unknown-fields in the docs. #612

Bugfixes:

• Resources with no uids are now supported too. #596
• CLI for freezing/resuming was failing due to missing authentication. #568
• Ignore irrelevant handlers in superseding causes (e.g. deletion-during-creation). #606
• Fixed configuration of the official Kubernetes library, if used for auth piggybacking. #567
• Guaranteed finalisation of watchers & workers. #628

Contributor experience:

• Switched to GitHub Actions for CI. #582 #586
• API errors are wrapped into our own classes, to prevent abstraction leakage of an HTTP client. #575
• Async timeouts used in the tests, some asyncio tests are time-limited. #608
• Stricter typing on resources & namespaces. #623 #624
• Squashed per-resource registries into combined ones. #622
• Some other refactorings for code clarity: #577 #576 #578 #597 #598 #609 #610 #626 #627

Enhancements:

• Renamed @kopf.on.this to @kopf.subhandler for readability. #618

Bugfixes:

• Fixed the resource discovery in case of parallel requests (improper locks & checks). #615

Internals:

• Fixed the usage example of kopf.execute() to be asynchronous. #618
• CI functional tests fixed for ResourceWarnings due to pykube-ng's session left-overs. #619 #608

Bugfixes:

• Fixed superseding of one cause by another (deletion-during-creation/-update/-resume, update-during-resume, etc). #607 #606

Bugfixes:

• Fixed superseding of one cause by another (deletion-during-creation/-update/-resume, update-during-resume, etc). #607 #606

Bugfixes:

• No more false "patching failed with inconsistencies" warning for CRDs with status as a subresource. #588

Internal:

• Back-ported GitHub Actions for CI tests. #592, originally #582

General topic: stability, resilience, recoverability, better logging and error handling.

New features:

• JSON logging with --log-format=json. #544
• Plain-text logging --log-format=plain. #544

Bugfixes:

• On-field handlers were triggered for non-existent fields with None→None change. #523
• Sub-handlers' state was not purged, preventing their execution in the future. #517
• Timers were ticking forever after the resource was deleted (if there were no finalizers). #548
• Persisted states of executed and then filtered-out handlers were not purged. #557

Resilience improvements:

• Annotations from other Kopf-based operators are fully ignored to avoid ping-pong effects. #539 #538
• The operator will force-stop itself by SIGKILL after 10 minutes of attempts to stop gracefully. #543
• Crash the whole operator on unrecoverable errors in watchers/workers. #509
• Throttle individual resource processing on unexpected errors. #510
• Extra exceptions are intercepted and ignored for k8s-event posting. #507
• Treat client timeouts during watches similar to other API errors. #506
• Handle all connection errors from the initial streaming request. #512

Experience improvements:

• Annotations restrictions on key length are reworked to allow longer names (v2/v1 keys). #529
• Annotations values are now compacted (no spaces) for the better visual outlook. #516
• Log/warn when the resulting patched object does not match the intended patch. #527
• Log when the patched object unexpectedly disappeared (e.g. was deleted). #559
• Log K8s API error explanations from K8s API itself, not from the HTTP client library. #558
• Filtered-out resources do not create phantom logs & do not get annotated anymore. #545
• Cluster-scoped objects are logged by their name, without "None" as the namespace. #544
• Better phrasing for some log messages to avoid confusion. #540
• Documentation fixes. #530

Internal changes:

• The first release since the fork. #502 #500 #505 #546
• CI feedback is sped up from ≈40-50 mins to ≈5 mins per push. #536 #537
• K3d/K3s is used for CI functional/integration testing; Minikube is for nightly tests. #536 #547
• K8s versions are updated for CI builds. #501
• Imports are sorted with isort. #525 #531
• Added tests for operators' peering. #519
• Added tests for logging & loggers. #544
• Get rid of mocks for causes & registries, use normal classes. #521
• Time-based tests are stabilised (though not fully fixed). #534 #528 #520 #522
• Asyncio tasks are now named in Python 3.8+, which makes the debugging easier. #542
• Python 3.9 support. #561

Experience improvements:

• Log when the patched object disappears (e.g. is deleted). Omit inconsistency warnings for this. #559

Experience improvements:

• K8s API errors contain the explanations from K8s API itself, not from an HTTP client library. #558

Bugfixes:

• Persisted states of executed and then filtered-out handlers were not purged. #557

Bugfixes:

• Timers were ticking forever after the resource was deleted (if there were no finalizers). #548

General topic: stability, resilience, recoverability, better logging and error handling.

New features:

• JSON logging with --log-format=json. #544
• Plain-text logging --log-format=plain. #544

Bugfixes:

• On-field handlers were triggered for non-existent fields with None→None change. #523
• Sub-handlers' state was not purged, preventing their execution in the future. #517

Resilience improvements:

• Annotations from other Kopf-based operators are fully ignored to avoid ping-pong effects. #539 #538
• The operator will force-stop itself by SIGKILL after 10 minutes of attempts to stop gracefully. #543
• Crash the whole operator on unrecoverable errors in watchers/workers. #509
• Throttle individual resource processing on unexpected errors. #510
• Extra exceptions are intercepted and ignored for k8s-event posting. #507
• Treat client timeouts during watches similar to other API errors. #506
• Handle all connection errors from the initial streaming request. #512

Experience improvements:

• Annotations restrictions on key length are reworked to allow longer names (v2/v1 keys). #529
• Annotations values are now compacted (no spaces) for the better visual outlook. #516
• Log/warn when the resulting patched object does not match the intended patch. #527
• Filtered-out resources do not create phantom logs & do not get annotated anymore. #545
• Cluster-scoped objects are logged by their name, without "None" as the namespace. #544
• Better phrasing for some log messages to avoid confusion. #540
• Documentation fixes. #530

Internal changes:

• The first release since the fork. #502 #500 #505 #546
• CI feedback is sped up from ≈40-50 mins to ≈5 mins per push. #536 #537
• K3d/K3s is used for CI functional/integration testing; Minikube is for nightly tests. #536 #547
• K8s versions are updated for CI builds. #501
• Imports are sorted with isort. #525 #531
• Added tests for operators' peering. #519
• Added tests for logging & loggers. #544
• Get rid of mocks for causes & registries, use normal classes. #521
• Time-based tests are stabilised (though not fully fixed). #534 #528 #520 #522
• Asyncio tasks are now named in Python 3.8+, which makes the debugging easier. #542

Bugfixes:

• Support Python 3.9 with Kopf's 0.27 codebase and features. #562

Originally released on 2020-05-11 16:37:41+00:00 (link).

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

Originally released on 2020-05-11 16:37:41+00:00 (link).

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

Originally released on 2020-04-28 12:29:32+00:00 (link).

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

Originally released on 2020-04-16 17:02:14+00:00 (link).

Fixes:

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

Originally released on 2020-04-08 14:52:29+00:00 (link).

Improvements:

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

Originally released on 2020-04-07 12:07:16+00:00 (link).

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

Originally released on 2020-04-01 10:17:05+00:00 (link).

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

Originally released on 2020-02-20 16:05:16+00:00 (link).

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

Originally released on 2020-02-20 16:05:16+00:00 (link).

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

Originally released on 2020-01-29 14:04:33+00:00 (link).

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

Originally released on 2020-01-17 16:32:12+00:00 (link).

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

Originally released on 2019-12-19 13:44:56+00:00 (link).

Improvements:

• Process the changes happened during the freeze mode once unfrozen. #256 #257
• CRD's status field references fixed to match the examples. #262
• cooldown is renamed to backoff to match the usual terminology. #266

Bugfixes:

• "Line is too long" for objects longer than 128 KB in JSON (e.g. encrypted secrets). #276

Internal changes:

• CI/CD dependencies pinned to fight the unexpected changes. #265 #274
• Minikube's RBAC-only mode is relaxed to "Node,RBAC". #270

Originally released on 2019-12-19 13:44:56+00:00 (link).

Improvements:

• Process the changes happened during the freeze mode once unfrozen. #256 #257
• CRD's status field references fixed to match the examples. #262
• cooldown is renamed to backoff to match the usual terminology. #266

Bugfixes:

• "Line is too long" for objects longer than 128 KB in JSON (e.g. encrypted secrets). #276

Internal changes:

• CI/CD dependencies pinned to fight the unexpected changes. #265 #274
• Minikube's RBAC-only mode is relaxed to "Node,RBAC". #270

Originally released on 2019-11-21 12:53:24+00:00 (link).

Bugfixes:

• Fix an issue with crashing on startup due to 404 on peerings in the default auto-detection mode. #252

Originally released on 2019-11-20 18:06:35+00:00 (link).

Bugfixes:

• Hot-fix the cluster-scoped resource discovery in the namespaced operators. #250

Originally released on 2019-11-20 10:15:07+00:00 (link).

TL;DR: Massive refactoring, renames, code moves. Generally, should be backward-compatible.

RISKY CHANGES (can be BREAKING, should be not):

• Authentication and API talking are fully reworked: pykube-ng and kubernetes clients are now piggybacked by default to extract the endpoints and credentials, but are not used for the API communication. This can break API connectivity in some cases. #226 #227
• In-memory structures were introduced to carry the technical information/objects/flags for individual resources. This can lead to increased memory usage in huge clusters with thousands of monitored resources. #230
• @kopf.on.resume() handlers were fixed, and now execute when previously they were not executed by mistake, but this could be taken as an expected behaviour. This can lead to massive patches of all resumable objects on every operator startup (if there are 2+ handlers), which can be a problem in huge clusters. #230 #236
• Massive internal renames and code moves; not exposed publicly, unless hacks or monkey-patching were used. #209 #210 #211

New features:

• @kopf.on.startup() handlers for operator initialisation. #225
• @kopf.on.cleanup() handlers for operator shutdown. #225
• @kopf.on.login() custom authentication handlers. #226
• @kopf.on.probe() handlers for liveness metrics. #226
• Liveness probes with kopf run --liveness. #228
• memo kwargs to keep runtime-only operator-lifetime-limited arbitrary values. #234
• retries= limiter for handlers in addition to timeout=. #222
• errors=TEMPORARY, errors=PERMANENT, errors=IGNORED modes for handlers. #222
• Explicit owner is not needed in kopf.adopt() and hierarchy methods, current object is used by default. #203

Bugfixes:

• @kopf.on.resume() handlers fixed:
  • There can be more than one resuming handler. #230
  • Are executed if they go after the on-create/on-update handlers. #230
  • Are not repeated every few minutes for no reason, guaranteed to be called once. #229 #230
  • Can be retried in case of temporary or arbitrary errors. #230
  • Can have sub-handlers. #230
  • Are not invoked if the object is being deleted. #233
  • Can be explicitly marked as deletion-safe, and hence be invoked on resuming during deletion. #233
• spec, status, metadata fields are not added to the body when originally absent. #198
• OS signal handlers are ignored on Windows (not supported by asyncio). #220

Internal changes:

• Fully type-annotated in the code (not in the tests). #195 #196 #197 #200 #201
• Fully asynchronous internally (asyncio/aiohttp); synchronous pykube-ng client is removed. #217 #227
• Handler outcomes and persistent state management separated from each other. #221
• E2E tests are now isolated from each other, preventing false-positives. #205
• The latest k8s & minikube versions are used in e2e tests. #193
• No logging of empty meaningless diffs in on-resume and other handlers. #236
• No patching of the objects if there is no need to patch (and no logging). #236
• No purging of the handler progress if there is only one handler (and no logging). #236
• cause.event is renamed to cause.reason to avoid terminology conflicts. #201
• kex is added as an alias for KopfExample CRD for demos/docs. #235

Originally released on 2019-11-20 01:11:43+00:00 (link).

Bugfixes:

• Raw data for CA, client certificates and private keys are accepted. #244
• Authorization: Bearer is not injected by default, breaking username+password auth. #243

Originally released on 2019-11-15 11:42:02+00:00 (link).

Internal changes:

• Avoid logging of empty meaningless diffs in on-resume handlers. #236
• Avoid patching the objects if there is no need to patch (and skip logging). #236
• Avoid purging the handler progress if there is only one handler (and skip logging). #236
• Add kex as an alias for KopfExample CRD for demos/docs. #235

Originally released on 2019-11-14 13:47:58+00:00 (link).

New features:

• memo kwargs to keep the runtime-only operator-lifetime-limited arbitrary values. #234

Originally released on 2019-11-14 11:10:09+00:00 (link).

Improvements:

• @kopf.on.resume() handlers are not invoked if the object is being deleted. #233
• @kopf.on.resume() can be explicitly marked as a deletion-safe handler. #233

Originally released on 2019-11-13 14:07:04+00:00 (link).

TL;DR: Massive refactoring, renames, code moves. Generally, should be backward-compatible.

RISKY CHANGES (can be BREAKING, should be not):

• Authentication and API talking are fully reworked: pykube-ng and kubernetes clients are now piggybacked by default to extract the endpoints and credentials, but are not used for the API communication. This can break API connectivity in some cases. #226 #227
• In-memory containers introduced to carry the technical information/objects/flags for individual resources. This can lead to increased memory usage in huge clusters with thousands of monitored resources. #230
• @kopf.on.resume() handlers were fixed, and can now execute when previously they were not executed by mistake, but this could be taken as an expected behaviour. This can lead to massive patches of all objects on every operator startup. #230
• Massive internal renames and code moves; not exposed publicly, unless hacks or monkey-patching were used. #209 #210 #211
• cause.event is renamed to cause.reason to avoid terminology conflicts. #201

New features:

• @kopf.on.startup() handlers for operator initialisation. #225
• @kopf.on.cleanup() handlers for operator shutdown. #225
• @kopf.on.login() custom authentication handlers. #226
• @kopf.on.probe() handlers for liveness metrics. #226
• Pod's liveness probes with kopf run --liveness. #228
• Explicit owner is not needed in kopf.adopt() and hierarchy methods, current object is used by default. #203
• retries= limiter for handlers in addition to timeout=. #222
• errors=TEMPORARY, errors=PERMANENT, errors=IGNORED modes for handlers. #222

Bugfixes:

• @kopf.on.resume() handlers are not repeated every few minutes for no reason. #229 #230
• @kopf.on.resume() are executed if they go after the on-create/on-update handlers. #230
• @kopf.on.resume() can be retried in case of temporary or arbitrary errors. #230
• @kopf.on.resume() can have sub-handlers. #230
• There can be 2+ of the@kopf.on.resume() handlers. #230
• spec, status, metadata fields are not added to the body when absent. #198
• Ignore asyncio signal handlers on Windows. #220

Internal changes:

• Fully type-annotated in the code (not in the tests). #195 #196 #197 #200 #201
• Fully asynchronous internally (asyncio/aiohttp); synchronous pykube-ng client is removed. #217 #227
• Handler outcomes and persistent state management separated from each other. #221
• E2E tests are now isolated from each other, preventing false-positives. #205
• The latest k8s & minikube versions are used in e2e tests. #193

Originally released on 2019-10-23 17:19:02+00:00 (link).

Bugfixes:

• Implicit logging events obey the configured level. #192 #188
• Field-changes detect the sub-fields of change's dict-containers. #191 #190

Internal changes:

• Diffs are turned from tuples to classes, diff ops — from strings to enums. #191

Originally released on 2019-09-26 10:56:43+00:00 (link).

Bugfixes:

• Implicit logging events obey the configured level. #192 #188
• Field-change detects sub-fields of change dict-containers. #191 #190

Internal changes:

• Diffs are turned from tuples to classes, diff ops — from strings to enums. #191

Originally released on 2019-09-13 11:01:50+00:00 (link).

New features:

• Expose the functions to make Kopf embeddable into other apps. #156 #185
  • Docs: https://kopf.readthedocs.io/en/latest/embedding/
  • Example: https://github.com/nolar/kopf/tree/master/examples/12-embedded

Improvements:

• kopf --version added. #175
• More logs on reasons of exiting/termination. #179
• Wake up immediately on new changes of the object if currently sleeping for delayed handlers. #162
• Speed up the deletion (finalizer removal) of the objects with failed creation/update handlers. #162
• Terminate the operator better, with graceful period for clean shutdown. #156
• K8s-events for cluster-scoped objects are posted to the current namespace, not "default". #165
• Kopf's handler errors renamed to kopf.PermanentError/kopf.TemporaryError. #159
• Kopf's permanent/temporary errors (and these only) will not dump strack-traces anymore. #159

Bugfixes:

• Do not add a finalizer to objects excluded by labels/annotations filters. #173
• Fixed failing with 404 if object was removed too fast or within the handler. #160
• Fixed implicitly forced peering mode for embeddable operator. #174

Internal changes:

• CodeCov PR comments disabled (to prevent spamming). #170
• Some modules were moved around and split. #155

Originally released on 2019-08-14 17:35:01+00:00 (link).

Reverted:

• Removed "Ensure eventual consistency for all handlers" feature of 0.21rc3. #182 ~#163~

Originally released on 2019-08-12 07:38:22+00:00 (link).

Improvements:

• More logs on reasons of exiting/termination. #179

Originally released on 2019-08-08 14:54:13+00:00 (link).

Improvements:

• kopf --version added. #175

Bugfixes:

• Do not add a finalizer to objects excluded by labels/annotations filters. #173
• Ensure eventual consistency for all handlers even with intermediate object changes. #163

Originally released on 2019-08-08 13:23:01+00:00 (link).

Improvements:

• Wake up immediately on new changes of the object if currently sleeping for delayed handlers. #162
• Speed up the deletion (finalizer removal) of the objects with failed creation/update handlers. #162

Bugfixes:

• Fixed failing with 404 if object was removed too fast or within the handler. #160
• Fixed implicitly forced peering mode for embeddable operator. #174

Originally released on 2019-08-07 17:45:34+00:00 (link).

New features:

• Expose the functions to make Kopf embeddable into other apps. #156
  • Docs: https://kopf.readthedocs.io/en/latest/embedding/

Improvements:

• Terminate the operator better, with graceful period for clean shutdown. #156
• K8s-events for cluster-scoped objects are posted to the current namespace, not "default". #165
• Kopf's handler errors renamed to kopf.PermanentError/kopf.TemporaryError. #159
• Kopf's permanent/temporary errors do not dump strack-traces anymore. #159

Internal changes:

• CodeCov PR comments disabled (to prevent spamming). #170
• Some modules were moved around and split. #155

Originally released on 2019-07-24 09:25:51+00:00 (link).

New feature:

• Decorator-level filtering of the objects by labels/annotations existence or values. #123

Originally released on 2019-07-16 10:09:39+00:00 (link).

New features:

• Built-in resources (pods, services, namespaces) are now supported. #110
• Per-object messages logged via logger kwarg (INFO+ level) are sent as Kubernetes events implicitly. #128 #148

Improvements:

• Almost proper operator termination on SIGINT/SIGTERM. #147 #151
  • Note: blocking socket reads are not yet fixed and can freeze on exit.

Internal changes:

• Internal K8s API client is switched from the official kubernetes-python top pykube-ng. #110
• Code coverage is measured. #72 #146
• E2E tests are stabilized. #149

Originally released on 2019-07-12 11:30:47+00:00 (link).

Bugfixes:

• Operators die with socket timeout in 10s after starting. #144

Originally released on 2019-07-09 13:11:00+00:00 (link).

Improvements:

• Built-in resources (pods, namespaces) are now also supported. #110
• Handlers' INFO+ log messages are sent as Kubernetes events implicitly. #128

Internal changes:

• Switched the internal client from the official kubernetes-python top pykube-ng. #110
• Code coverage is measured. #72

Originally released on 2019-07-08 12:42:48+00:00 (link).

Improvements:

• Finalizer is not added if there are no deletion handlers. #118
• Deletion handlers can be optional to prevent adding finalizer. #118
• Script's dir is added to import paths to mimic Python's behaviour. #93 #133
• .status is ignored in the last-handled state checks (except for fields used in field-handlers). #131
• .metadata is ignored in the last-handled state checks (except for labels & annotations). #131
• Operator freezes if the same-priority operator appears (previously, only warned). #114

Bugfixes:

• The peering self-record was not properly removed on exit. #114
• Restrict to kubernetes<10.0.0 to keep Kopf runnable at all. #134

Internal changes:

• Examples can now have their own dedicated tests. #126

Originally released on 2019-07-04 12:45:51+00:00 (link).

Hotfix:

• Restrict to kubernetes<10.0.0 to keep Kopf runnable at all.

See: #134 and kubernetes-client/python#866

Originally released on 2019-07-03 08:23:43+00:00 (link).

Improvements:

• Performance improvements when handling hundreds of resources. #109

Internal changes:

• Internal (non-public) packages restructured — to deal with the growing complexity. #124
  • kopf.engines extracted from kopf.reactor (peering & posting & logging).
  • kopf.utilities extracted from kopf.reactor (reacting to k8s changes).
  • kopf.clients is the new kopf.k8s (renamed).
  • kopf.clients.auth extracted from kopf.config (only auth-related routines).
  • kopf.config got the configuration constants from all over the code.
• New configuration added:
  • Configurable timeouts and thread pool sizes.
  • Configurable level of k8s-events posted; others are skipped.
• Everything has been made asynchronous:
  • All internal K8s API wrappers/adapters are made async.
  • All blocking operations (incl. API requests) moved to thread pools.
  • All k8s-event posting is done via a queue with a background posting task. #125

Originally released on 2019-06-14 09:18:57+00:00 (link).

New features:

• Resource "resuming" handlers @kopf.on.resume for threads/tasks. #105

Internal changes:

• Tests and docs for RBAC status codes for peering. #95
• Handlers are de-duplicated if registered twice and both do match the event/cause. #105
• The initial listing of objects is done separately from watching the objects, and is fed into the reactor differently (not event['type']=="ADDED", but event['type']==None). The watching continues from the resource-version of the list, as it must be by design. #105

Originally released on 2019-06-13 16:14:01+00:00 (link).

New features:

• Silent spy-handlers @kopf.on.event (currently only for custom resources). #86
• Labels can now be added recursively (e.g. to pod templates within jobs/deployments). #108

Improvements:

• Diffs are logged on update events. #104
• Handling is skipped if there are no handlers for the event/cause (and produces no fake logs/statuses). #103

Internal changes:

• Maintenance docs, RBAC fixes in the docs, typos fixed. #83 #89 #102
• Few more tests. #90 #91

The release is done as a rollback point from 0.16 if the resume-handlers introduce breaking changes (they shouldn't).

Originally released on 2019-05-31 14:44:45+00:00 (link).

Bugfixes:

• K8s events are now optional, if posting fails, the operator continues. #88
• K8s events' messages are now cut to 1024 chars to prevent failures. #88

Other changes:

• Internal refactoring of the @kopf.on.field() handler. #69
• Internal refactoring of the cause detection & event handling. #82

Originally released on 2019-05-28 14:42:06+00:00 (link).

Bugs fixed:

• Events are posted using v1 instead of v1beta1 API, making it compatible with Google Kubernetes Engine >=1.12. #81

Other changes:

• Internal refactoring on the module imports & Kubernetes client calls. #78 #71

Originally released on 2019-05-28 09:06:00+00:00 (link).

New features:

• Basic tools for testing of the Kopf-based operators (background operator runner).
• namespace, name, uid kwargs for the handlers (were mentioned in the docs, absent in the code).

Other changes:

• Tests, tests, tests for the existing codebase (asyncio queueing).
• End-to-end tests with Minikube with real Kubernetes versions.
• Some little fixes detected during test writing.
• Contribution docs.

Originally released on 2019-05-17 12:06:39+00:00 (link).

Breaking change:

• Legacy KopfPeering (cluster-scoped) is now ClusterKopfPeering.
• Current KopfPeering is made namespaced.
• Code is updated to support the previous cluster config smoothly (until 1.0).
• CRD re-creation is recommended (see docs for peering).

Other changes:

• Tests, tests, tests for the existing codebase.
• RBAC docs fixed for the real demo examples.
• Watching-streaming logic refactored for testability, but keeps the functionality.
• metadata.generation does not trigger the update handlers in Minikube anymore.

Originally released on 2019-04-26 15:15:00+00:00 (link).

• Follow the Kubernetes "eventual consistency" principle and react only to the latest events, ignore the past replayed events #43 #42
• Tests for the diff calculations #40 #48