Add recommended Kubernetes labels

[lindhe]

This change implements the recommended Kubernetes labels where applicable, according to Helm's recommendations.

Resolves #216

Status

Label	Status	Value
app.kubernetes.io/name	Done	{{ template "splunk-otel-collector.name" . }}
helm.sh/chart	Done	{{ .Chart.Name }}
app.kubernetes.io/managed-by	Done	{{ .Release.Service }}
app.kubernetes.io/instance	Done	{{ .Release.Name }}
app.kubernetes.io/version	Done	{{ .Chart.AppVersion | quote }}
app.kubernetes.io/component	Done	otel-k8s-cluster-receiver or otel-collector
app.kubernetes.io/part-of	Omitted	n/a
app.kubernetes.io/created-by	Omitted	n/a

TODO

• Design decision on anything that's not "Done" or "Omitted"
• Move common labels to _helpers.tpl
• Sort the labels. Alphabetically or in the same order as in the Helm documentation?
• CHANGELOG
• make render
• Final review from maintainers

[dmitryax]

@lindhe please run make render and add a line to CHANGELOG

[lindhe]

Again, note that this PR only applies the labels where I think it matches the existing labels. Do we want to look in more details for places where we want to introduce the remaining labels as well, or do we take that as a separate PR?

[dmitryax]

@lindhe it would be better if we can add other labels all at once in this PR. I think we should also add helm.sh/chart, right?

And I would move them all to a template helper in another PR. Not asking you to do that, just making a note for myself.

[dmitryax]

And sorry, I pushed something else, and it needs another make render now :)

[lindhe]

it would be better if we can add other labels all at once in this PR. I think we should also add helm.sh/chart, right?

I agree! It will be somewhat tedious to go through all components and think about which new labels make sense, but I think it will be worth it. Great that you remembered helm.sh/chart! I forgot that one, since it's in Helm's list of common labels but not Kubernetes'. I'll add it to PR and issue description.

And I would move them all to a template helper in another PR. Not asking you to do that, just making a note for myself.

Moving them to a template helper sounds like a good idea. There's two reasons I didn't do that already:

1. The component label existed in some objects but not all. If that distinction is important, then it's hard to keep it centrally in _helpers.tpl.
2. I'm not sure that all recommended Kubernetes labels makes sense on every object. Like for example, does a configMap object have a version?

And sorry, I pushed something else, and it needs another make render now :)

No worries! It's great that the new releases come so frequently, just keep that going and we'll fix conflicts here later! :) But I'm probably going to wait with another make render until we're happy with the state of this PR (i.e. all new labels are added), so we don't have to do it over and over.

Another question: Do we want app.kubernetes.io/created-by at all? I think it's hard to define...

[lindhe]

I removed the CHANGELOG commit and make render commit to avoid having to resolve merge conflicts all the time when working.

TODO: Add those back in later.

[dmitryax]

1. The component label existed in some objects but not all. If that distinction is important, then it's hard to keep it centrally in _helpers.tpl.

I would move only common labels to the template helper, while keeping the component labels on their places.

2. I'm not sure that all recommended Kubernetes labels makes sense on every object. Like for example, does a configMap object have a version?

I think we should add all the recommended labels uniformly across all k8s objects. I don't see any issue with configMap having app version label

Another question: Do we want app.kubernetes.io/created-by at all? I think it's hard to define...

I agree, let's omit it.

[lindhe]

I had missed that helm.sh/chart should be the chart name and version, so I'm fixing that! At first, I had only set it to .Chart.Name.

[lindhe]

There. Consolidating them into a shared definition in _helpers.tpl massively improved the readability of this PR.

Please review the new definitions and decide if it looks good.

Is the label sorted in a good order? I kept it the same as in https://helm.sh/docs/chart_best_practices/labels/#standard-labels

[dmitryax]

Is the label sorted in a good order? I kept it the same as in https://helm.sh/docs/chart_best_practices/labels/#standard-labels

Yes, I think this order is good.

[dmitryax]

Look good to me. Thanks the contribution!