Improve configuration via ingress object annotations

[sujaya-sys]

Context

The operator can create checklyhq.com checks, groups and alert channels based of Kubernetes CRDs and Ingress object annotations. See Ingress for further reference.

Notes

• Map out user flows:

  • From a product POV it'll be really helpful to map out the current / expected / ideal / typical work flow here to answer questions such as: Which kind of default configurations are helpful? Would users want to provide their own defaults to enable automation? How can we enable dynamic configuration via templates for example? Do we want to optimize for a workflow with helm?

• Improvement topics that have been discussed:

  • Enable multiple paths for Ingress objects: https://checklycommunity.slack.com/archives/C07SSENKN8G/p1729526985269359
  • Read path from configuration i.e. default should be something like spec.rules.host.paths.path

[sujaya-sys]

Any thoughts / notes / feedback on this topic? Drop it in below 👇🏼

[sujaya-sys]

Concerns brought up by Alen (reference):

• Different namespaces can have the same resource names or even completely the same resources. Wit that, looking at current suggestions, you are in danger of having duplicates if part of the same group.
  My suggestion is do whatever you wish in terms of human readable format as prefix, but add suffix that is a stable hash (maybe from uid). I think from uid: f5dacbb1-42cb-4fed-994c-7b0fc5b559bc we might want to take f5dacbb1 . Depending on available length of your check name, thing about adding namespace reference, or maybe as part of group name.
  That way you will skip collisions. On that note, let's make sure there's a log or CR status that is saying there's collision, if there is one.

• Annotations are good, but also think about covering other resources like IngressRoute from Traefik, VirtualService from Istio and VirtualServer/VirtualServerRoute from Nginx (there's more).
  You might want to do it later, but Ingress resource itself is known for its limitations and many use dedicated ingress controller resources that offer additional flexibility. Maybe best to put it on the roadmap and start simple.