search

operator-framework / enhancements

Apache License 2.0
9 stars 40 forks source link

[sdk-metrics] add sdk-stamps to bundle resources #21

Closed varshaprasad96 closed 4 years ago

varshaprasad96 commented 4 years ago

Proposal to add sdk-stamps to bundle image.

Description This proposal defines the places in bundle image where SDK labels can be added. This will be helpful for OLM to identify the operators which use Operator SDK and would indirectly provide us with metrics to evaluate the reachability of SDK among RedHat community operators.

kevinrizza commented 4 years ago

High level question: since metrics only get added and exist in the OpenShift project and not in upstream kube with OLM, would this enhancement be more appropriate just for downstream forks? And therefore this enhancement in general should be added to OpenShift/enhancements as well? Or are we expecting this to land in the upstream sdk project even though it won't be used by upstream OLM?

If not, can we call that out?

estroz commented 4 years ago

@kevinrizza ~assuming what you say about OpenShift metrics is true~ do operator developers who target OpenShift use the upstream or downstream SDK? From my experience they use upstream.

Additionally although less importantly these CSV/CRD annotations could be useful for cluster admins debugging operator issues, since they point to a place to start looking for solutions (the SDK repo/docs).

Edit: while the first point I made above may be true, it is orthogonal to this potentially being an OpenShift pipeline-specific proposal. However, I still see worth in this feature being upstream for tooling, metrics, and general pipeline support.

varshaprasad96 commented 4 years ago

@kevinrizza @estroz @ecordell Shall I move this proposal to OpenShift/enhancements ?

kevinrizza commented 4 years ago

@estroz @varshaprasad96 Sorry, super slow to respond to this. I think that everything related to adding the labels is a reasonable thing to include in the upstream enhancement. I just think that the OLM integration section that refers specifically to the metrics that are defined in OpenShift should probably live there, perhaps in a followup? Or we should attempt to make that section more generic to describe how upstream could use these labels for metrics.

varshaprasad96 commented 4 years ago

@kevinrizza I just opened a follow up PR on adding of labels to OLM metrics in OpenShift/enhancements - https://github.com/openshift/enhancements/pull/349

ecordell commented 4 years ago

/lgtm