1

I am using kubebuilder to create a Kubernetes operator. When an object of my kind is initiated I have to parse the spec and update the objects based on a few calculations.

From what I can tell I can either update the status of the object, the metadata, or a managed field (I may be wrong?). It appears that the sigs.k8s.io/controller-runtime/pkg/client library is responsible for how to update these fields (I'm not completely sure). I am having trouble understanding the docs.

I have the following questions:

  • Are there a guide to best practices about where to store configuration on the object between status, metadata (labels or annotations), and managed fields?
  • How do I update/patch the annotations of an object similar to how I would use r.Status().Update(ctx, &thing); to update the status?
Amit Kumar Gupta
  • 17,184
  • 7
  • 46
  • 64
BBS
  • 1,351
  • 2
  • 12
  • 27

1 Answers1

3

The Kubebuilder docs are a bit raw but nonetheless are a handy guide when building CRDs and controllers with Kubebuilder. It walks you through a fairly detailed example which is great to study and refer back to, to see how to do certain things.

The answer to your question generally is, "it depends." What values are you calculating, and why? Why do you need to store them on the object? Is the lifecycle of this data coupled to the lifecycle of this object, or might this computed data need to live on and be used by other controllers even when the object is deleted? In general, is anything going to interact with those values? What is it going to do with them?

If nothing else aside from the reconciliation controller for the CRD is going to interact with the data you're putting, consider putting it within the object's Status.

Doing r.Status().Update(ctx, &thing) will avoid triggering any side-effects as it will only persist changes you've made to the object's Status subresource, rather than its spec or metadata.

A common thing to do with custom resources is to set and remove finalizers, which live in the object's metadata.

Amit Kumar Gupta
  • 17,184
  • 7
  • 46
  • 64