feature(chart): Allow configuring labels and annotations by brookelew · Pull Request #2443 · flannel-io/flannel

brookelew · 2026-05-05T04:49:43Z

lets users configure the labels and annotations in the Helm chart

Resolves #2442

Description

Feature for the Helm chart that lets users modify the labels and annotations of deployed resources.

Todos

Tests
Documentation
Release note

Release Note

None required

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

chart/kube-flannel/templates/rbac.yaml:55

Same issue as above for the ClusterRoleBinding: labels: is always emitted, but the merged label map may be empty (defaults are {}), resulting in labels: with a null value. Make the labels: key conditional or render an explicit empty map.

  labels:
    {{- with (merge .Values.flannel.rbac.clusterRoleBinding.labels .Values.flannel.rbac.labels .Values.global.commonLabels) }}
    {{- toYaml . | nindent 4 }}
    {{- end }}

mgfritch

Thanks for the contribution!

Would you mind adding a named template (helpers file) for generating the default flannel labels?

lets users configure the labels and annotations in the Helm chart Resolves flannel-io#2442

brookelew · 2026-07-10T17:22:44Z

@mgfritch Sorry for the delay! I used some fromYamls to handle the merging in a more intuitive (to me at least) manner. Also wrote the tests.

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

+    set:
+      flannel.rbac.labels:
+        rbac-non-overridden-label: "rbac label should not be overridden"
+        rbac-overrridden-label: "rbac label should be overridden"


+        rbac-overridden-label: "rbac label has been overridden"
+      flannel.rbac.annotations:
+        rbac-non-overridden-annotation: "rbac annotation should not be overridden"
+        rbac-overrridden-annotation: "rbac annotation should be overridden"


+app: "flannel"
+tier: "node"
+app.kubernetes.io/name: {{ include "flannel.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}


mgfritch · 2026-07-15T23:54:54Z

+
+{{- define "flannel.selectorLabels" -}}
+app: "flannel"
+tier: "node"
+app.kubernetes.io/name: {{ include "flannel.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end -}}


Suggested change

{{- define "flannel.selectorLabels" -}}

app: "flannel"

tier: "node"

app.kubernetes.io/name: {{ include "flannel.name" . }}

app.kubernetes.io/instance: {{ .Release.Name }}

{{- end -}}

+{{/* Immutable selector labels */}}

{{- define "flannel.selectorLabels" -}}

app: "flannel"

{{- end -}}

sorry, this one is my fault, but adding labels here will cause the DaemonSet to fail during helm upgrade.

Can we move them into the common labels below?

mgfritch · 2026-07-15T23:57:03Z

+helm.sh/chart: {{ include "flannel.chart" . }}
+app.kubernetes.io/version: {{ .Chart.AppVersion }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{ include "flannel.selectorLabels" . }}


Suggested change

helm.sh/chart: {{ include "flannel.chart" . }}

app.kubernetes.io/version: {{ .Chart.AppVersion }}

app.kubernetes.io/managed-by: {{ .Release.Service }}

{{ include "flannel.selectorLabels" . }}

tier: "node"

helm.sh/chart: {{ include "flannel.chart" . }}

app.kubernetes.io/name: {{ include "flannel.name" . }}

app.kubernetes.io/instance: {{ .Release.Name }}

{{ include "flannel.selectorLabels" . }}

Add common labels here instead of in the (immutable) selector labels

mgfritch · 2026-07-16T02:37:55Z

+      {{- include "flannel.selectorLabels" . | nindent 6 }}
  template:
    metadata:
+      {{- with (merge .Values.flannel.podLabels (include "flannel.labels" . | fromYaml)) }}


Suggested change

{{- with (merge .Values.flannel.podLabels (include "flannel.labels" . | fromYaml)) }}

{{- with (merge (include "flannel.labels" . | fromYaml) .Values.flannel.podLabels) }}

reversing the order should ensure the the match labels cannot be overwritten by the pod labels

mgfritch · 2026-07-16T03:41:58Z

@@ -0,0 +1,95 @@
+suite: test labels annotations overrides


Thanks for adding these!

Can we also add a test to ensure the selector labels are immutable? Feel free to reuse (or modify) this if it helps: mgfritch@61396f7

mgfritch · 2026-07-16T06:41:29Z

@mgfritch Sorry for the delay! I used some fromYamls to handle the merging in a more intuitive (to me at least) manner. Also wrote the tests.

@brookelew No worries! The fromYaml approach is much cleaner and thanks for writing the tests. I know we've gone through a few rounds on this, but I really appreciate your patience.

I think this should be ready to finally merge after resolving the last few small revisions above. This PR will be a really nice addition to modernize the charts! 😀

mgfritch requested a review from Copilot May 6, 2026 15:14

Copilot started reviewing on behalf of mgfritch May 6, 2026 15:14 View session

brookelew force-pushed the allow-configuring-labels-annotations branch from 73fe8c7 to 75056b8 Compare May 14, 2026 03:01

mgfritch requested review from Copilot and removed request for Copilot May 14, 2026 22:51

Copilot started reviewing on behalf of mgfritch May 14, 2026 22:52 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

Comment thread chart/kube-flannel/templates/rbac.yaml Outdated

Comment thread chart/kube-flannel/templates/daemonset.yaml

mgfritch reviewed May 15, 2026

View reviewed changes

mgfritch reviewed May 19, 2026

View reviewed changes

Comment thread chart/kube-flannel/templates/daemonset.yaml

Comment thread chart/kube-flannel/templates/_helpers.tpl

Comment thread chart/kube-flannel/templates/daemonset.yaml Outdated

mgfritch force-pushed the allow-configuring-labels-annotations branch from 6cdccab to 922aad2 Compare May 19, 2026 23:11

brookelew added 2 commits July 10, 2026 08:13

feature(chart): allow configuring labels and annotations

6ffcdbb

lets users configure the labels and annotations in the Helm chart Resolves flannel-io#2442

Use _helpers.tpl for global labels

114926c

brookelew force-pushed the allow-configuring-labels-annotations branch from 922aad2 to 114926c Compare July 9, 2026 22:13

Update merge behaviour of labels and annotations

c84787c

Add some common labels

efa2813

brookelew requested a review from mgfritch July 11, 2026 14:30

mgfritch requested a review from Copilot July 16, 2026 00:05

Copilot started reviewing on behalf of mgfritch July 16, 2026 00:06 View session

Copilot AI reviewed Jul 16, 2026

View reviewed changes

mgfritch reviewed Jul 16, 2026

View reviewed changes

mgfritch mentioned this pull request Jul 16, 2026

Add helm chart unittest target and CI job #2495

Open

3 tasks

	{{- with (merge .Values.flannel.podLabels (include "flannel.labels" . \| fromYaml)) }}
	{{- with (merge (include "flannel.labels" . \| fromYaml) .Values.flannel.podLabels) }}

Uh oh!

Conversation

brookelew commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Todos

Release Note

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

mgfritch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brookelew commented Jul 10, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

mgfritch Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mgfritch Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mgfritch Jul 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mgfritch Jul 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mgfritch commented Jul 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

brookelew commented May 5, 2026 •

edited

Loading

mgfritch Jul 15, 2026 •

edited

Loading

mgfritch Jul 15, 2026 •

edited

Loading

mgfritch Jul 16, 2026 •

edited

Loading

mgfritch Jul 16, 2026 •

edited

Loading

mgfritch commented Jul 16, 2026 •

edited

Loading