[PR] Patch status as a sub-resource if defined so

[kopf-archiver]

A pull request by nolar at 2020-02-13 20:02:53+00:00
Original URL: zalando-incubator/kopf#313
Merged by nolar at 2020-02-20 11:20:53+00:00

What do these changes do?

Patch custom/built-in resources with status declared as a sub-resource via a separate URL — instead of being a field of a resource itself.

Description

Previously, Kopf always assumed that custom resources and built-in resources store status as part of the object (which was the case in early Kubernetes versions).

But this has changed since sub-resources were introduced. While it was not a big problem for custom resources, where the developers could define the sub-resources and skip "status" there, it became a problem with some built-in resources like "storage.k8s.io/volumeattachments", which have the status defined as a sub-resource and operator developers cannot control it.

As a result, when Kopf was patching the object itself with {"status": ...} payload, the status was lost, and the reaction cycle did not continue, so the handlers were skipped.

With this PR, Kopf discovers and respects the status-as-a-subresource both in custom and built-in resources, and patches them accordingly: either as a whole object with a status field (if not a sub-resource), or separately for object & status endpoints (depending on the patch's content).

The latter aspect can cause for 2 PATCH requests to be made when both the body (e.g. metadata) and the status has to be updated — when previously it was only 1 (but did not work with this kind of resources at all).

From the user perspective, a wider set of built-in resources can be handled now, and their custom resources can also have status declared as a sub-resource (if they wish so).

Issues/PRs

Issues: #308 closes #119

Type of changes

• New feature (non-breaking change which adds functionality)

Checklist

• The code addresses only the mentioned problem, and this problem only
• I think the code is well written
• Unit tests for the changes exist
• Documentation reflects the changes
• If you provide code modification, please add yourself to CONTRIBUTORS.txt