HDDS-13992. Support additional annotations for pods by chehsunliu · Pull Request #22 · apache/ozone-helm-charts

chehsunliu · 2025-11-23T10:36:45Z

What changes were proposed in this pull request?

Support configuring additional pod annotations via values.yaml. This allows users to customize annotations such as those used to control Istio sidecar resources:

apiVersion: apps/v1
kind: StatefulSet
spec:
  template:
    metadata:
      annotations:
        sidecar.istio.io/proxyCPU: 100m
        sidecar.istio.io/proxyCPULimit: 200m
        sidecar.istio.io/proxyMemory: 128Mi
        sidecar.istio.io/proxyMemoryLimit: 256Mi

What is the link to the Apache JIRA

https://issues.apache.org/jira/browse/HDDS-13992

How was this patch tested?

Test that the rendered templates aren't changed with default values

# Before making any code change
$ helm template charts/ozone > /tmp/ozone.v0.yaml

# After this change
$ helm template charts/ozone > /tmp/ozone.v1.yaml

$ diff -u /tmp/ozone.*.yaml
# No diff

Test that templates are correct with provided annotations

$ helm template charts/ozone \
    --set "datanode.podAnnotations.sidecar\\.istio\\.io/proxyCPU=100m" \
    --set "datanode.podAnnotations.sidecar\\.istio\\.io/proxyCPULimit=200m" \
    --set "om.podAnnotations.sidecar\\.istio\\.io/proxyCPU=110m" \
    --set "om.podAnnotations.sidecar\\.istio\\.io/proxyCPULimit=210m" \
    --set "s3g.podAnnotations.sidecar\\.istio\\.io/proxyCPU=120m" \
    --set "s3g.podAnnotations.sidecar\\.istio\\.io/proxyCPULimit=220m" \
    --set "scm.podAnnotations.sidecar\\.istio\\.io/proxyCPU=130m" \
    --set "scm.podAnnotations.sidecar\\.istio\\.io/proxyCPULimit=230m" \
    > /tmp/ozone.v1.yaml

$ diff -u /tmp/ozone.*.yaml

Output

--- /tmp/ozone.v0.yaml	2025-11-23 17:43:24
+++ /tmp/ozone.v1.yaml	2025-11-23 18:33:31
@@ -234,16 +234,18 @@
     matchLabels:
       app.kubernetes.io/name: ozone
       app.kubernetes.io/instance: release-name
       app.kubernetes.io/component: datanode
   template:
     metadata:
       annotations:
         checksum/config: 6d1d3f4f11b1bab096dd5d48cebba6471332987371961847c439d6a9cb229678
+        sidecar.istio.io/proxyCPU: 100m
+        sidecar.istio.io/proxyCPULimit: 200m
       labels:
         app.kubernetes.io/name: ozone
         app.kubernetes.io/instance: release-name
         app.kubernetes.io/component: datanode
     spec:
       containers:
         - name: datanode
           image: "apache/ozone:2.0.0"
@@ -313,16 +315,18 @@
     matchLabels:
       app.kubernetes.io/name: ozone
       app.kubernetes.io/instance: release-name
       app.kubernetes.io/component: om
   template:
     metadata:
       annotations:
         checksum/config: 6d1d3f4f11b1bab096dd5d48cebba6471332987371961847c439d6a9cb229678
+        sidecar.istio.io/proxyCPU: 110m
+        sidecar.istio.io/proxyCPULimit: 210m
       labels:
         app.kubernetes.io/name: ozone
         app.kubernetes.io/instance: release-name
         app.kubernetes.io/component: om
     spec:
       containers:
         - name: om
           image: "apache/ozone:2.0.0"
@@ -398,16 +402,18 @@
     matchLabels:
       app.kubernetes.io/name: ozone
       app.kubernetes.io/instance: release-name
       app.kubernetes.io/component: s3g
   template:
     metadata:
       annotations:
         checksum/config: 6d1d3f4f11b1bab096dd5d48cebba6471332987371961847c439d6a9cb229678
+        sidecar.istio.io/proxyCPU: 120m
+        sidecar.istio.io/proxyCPULimit: 220m
       labels:
         app.kubernetes.io/name: ozone
         app.kubernetes.io/instance: release-name
         app.kubernetes.io/component: s3g
     spec:
       containers:
         - name: s3g
           image: "apache/ozone:2.0.0"
@@ -479,16 +485,18 @@
     matchLabels:
       app.kubernetes.io/name: ozone
       app.kubernetes.io/instance: release-name
       app.kubernetes.io/component: scm
   template:
     metadata:
       annotations:
         checksum/config: 6d1d3f4f11b1bab096dd5d48cebba6471332987371961847c439d6a9cb229678
+        sidecar.istio.io/proxyCPU: 130m
+        sidecar.istio.io/proxyCPULimit: 230m
       labels:
         app.kubernetes.io/name: ozone
         app.kubernetes.io/instance: release-name
         app.kubernetes.io/component: scm
     spec:
       initContainers:
         - name: init
           image: "apache/ozone:2.0.0"

peterxcli

Thanks for this great improvement. LGTM +1

adoroszlai · 2025-11-23T11:11:37Z

@dnskr @Tejaskriya would you like to take a look?

dnskr

Looks good overall!

I've suggested a couple of minor formatting points that would help with consistency and readability. Also, based on the use case described, I would suggest adding a common podAnnotations property similar to env and envFrom.

dnskr · 2025-11-23T11:33:04Z

charts/ozone/templates/datanode/datanode-statefulset.yaml

+        {{- with .Values.datanode.podAnnotations }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}


Suggested change

{{- with .Values.datanode.podAnnotations }}

{{- toYaml . | nindent 8 }}

{{- end }}

{{- with .Values.datanode.podAnnotations }}

{{- toYaml . | nindent 8 }}

{{- end }}

nit: I suggest adding two spaces to follow the project's formatting approach.

dnskr · 2025-11-23T11:33:23Z

charts/ozone/templates/om/om-statefulset.yaml

+        {{- with .Values.om.podAnnotations }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}


Suggested change

{{- with .Values.om.podAnnotations }}

{{- toYaml . | nindent 8 }}

{{- end }}

{{- with .Values.om.podAnnotations }}

{{- toYaml . | nindent 8 }}

{{- end }}

nit: I suggest adding two spaces to follow the project's formatting approach.

dnskr · 2025-11-23T11:33:36Z

charts/ozone/templates/s3g/s3g-statefulset.yaml

+        {{- with .Values.s3g.podAnnotations }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}


Suggested change

{{- with .Values.s3g.podAnnotations }}

{{- toYaml . | nindent 8 }}

{{- end }}

{{- with .Values.s3g.podAnnotations }}

{{- toYaml . | nindent 8 }}

{{- end }}

nit: I suggest adding two spaces to follow the project's formatting approach.

dnskr · 2025-11-23T11:33:50Z

charts/ozone/templates/scm/scm-statefulset.yaml

+        {{- with .Values.scm.podAnnotations }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}


Suggested change

{{- with .Values.scm.podAnnotations }}

{{- toYaml . | nindent 8 }}

{{- end }}

{{- with .Values.scm.podAnnotations }}

{{- toYaml . | nindent 8 }}

{{- end }}

nit: I suggest adding two spaces to follow the project's formatting approach.

chehsunliu · 2025-11-23T13:39:03Z

Test the precedence with this command instead:

$ helm template charts/ozone \
    --set "podAnnotations.sidecar\\.istio\\.io/proxyCPU=100m" \
    --set "datanode.podAnnotations.sidecar\\.istio\\.io/proxyCPULimit=200m" \
    --set "om.podAnnotations.sidecar\\.istio\\.io/proxyCPULimit=210m" \
    --set "s3g.podAnnotations.sidecar\\.istio\\.io/proxyCPU=120m" \
    --set "s3g.podAnnotations.sidecar\\.istio\\.io/proxyCPULimit=220m" \
    --set "scm.podAnnotations.sidecar\\.istio\\.io/proxyCPU=130m" \
    --set "scm.podAnnotations.sidecar\\.istio\\.io/proxyCPULimit=230m" \
    > /tmp/ozone.v1.yaml

Output:

--- /tmp/ozone.v0.yaml	2025-11-23 17:43:24
+++ /tmp/ozone.v1.yaml	2025-11-23 21:31:24
@@ -234,16 +234,18 @@
     matchLabels:
       app.kubernetes.io/name: ozone
       app.kubernetes.io/instance: release-name
       app.kubernetes.io/component: datanode
   template:
     metadata:
       annotations:
         checksum/config: 6d1d3f4f11b1bab096dd5d48cebba6471332987371961847c439d6a9cb229678
+        sidecar.istio.io/proxyCPU: 100m
+        sidecar.istio.io/proxyCPULimit: 200m
       labels:
         app.kubernetes.io/name: ozone
         app.kubernetes.io/instance: release-name
         app.kubernetes.io/component: datanode
     spec:
       containers:
         - name: datanode
           image: "apache/ozone:2.0.0"
@@ -313,16 +315,18 @@
     matchLabels:
       app.kubernetes.io/name: ozone
       app.kubernetes.io/instance: release-name
       app.kubernetes.io/component: om
   template:
     metadata:
       annotations:
         checksum/config: 6d1d3f4f11b1bab096dd5d48cebba6471332987371961847c439d6a9cb229678
+        sidecar.istio.io/proxyCPU: 100m
+        sidecar.istio.io/proxyCPULimit: 210m
       labels:
         app.kubernetes.io/name: ozone
         app.kubernetes.io/instance: release-name
         app.kubernetes.io/component: om
     spec:
       containers:
         - name: om
           image: "apache/ozone:2.0.0"
@@ -398,16 +402,18 @@
     matchLabels:
       app.kubernetes.io/name: ozone
       app.kubernetes.io/instance: release-name
       app.kubernetes.io/component: s3g
   template:
     metadata:
       annotations:
         checksum/config: 6d1d3f4f11b1bab096dd5d48cebba6471332987371961847c439d6a9cb229678
+        sidecar.istio.io/proxyCPU: 120m
+        sidecar.istio.io/proxyCPULimit: 220m
       labels:
         app.kubernetes.io/name: ozone
         app.kubernetes.io/instance: release-name
         app.kubernetes.io/component: s3g
     spec:
       containers:
         - name: s3g
           image: "apache/ozone:2.0.0"
@@ -479,16 +485,18 @@
     matchLabels:
       app.kubernetes.io/name: ozone
       app.kubernetes.io/instance: release-name
       app.kubernetes.io/component: scm
   template:
     metadata:
       annotations:
         checksum/config: 6d1d3f4f11b1bab096dd5d48cebba6471332987371961847c439d6a9cb229678
+        sidecar.istio.io/proxyCPU: 130m
+        sidecar.istio.io/proxyCPULimit: 230m
       labels:
         app.kubernetes.io/name: ozone
         app.kubernetes.io/instance: release-name
         app.kubernetes.io/component: scm
     spec:
       initContainers:
         - name: init
           image: "apache/ozone:2.0.0"

dnskr

The changes look great. Thanks for the contribution and for addressing the comments!

adoroszlai · 2025-11-23T17:14:31Z

Thanks @chehsunliu for the patch, @dnskr, @peterxcli for the review.

HDDS-13992. Support additional annotations for pods

eaa4d9e

This comment was marked as abuse.

Sign in to view

adoroszlai requested a review from kerneltime November 23, 2025 10:50

peterxcli approved these changes Nov 23, 2025

View reviewed changes

dnskr suggested changes Nov 23, 2025

View reviewed changes

chehsunliu added 2 commits November 23, 2025 21:07

HDDS-13992. Fixed formatting

a89b91f

HDDS-13992. Add common pod annotations

c648ec7

dnskr approved these changes Nov 23, 2025

View reviewed changes

adoroszlai merged commit 6c1a77b into apache:main Nov 23, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HDDS-13992. Support additional annotations for pods#22

HDDS-13992. Support additional annotations for pods#22
adoroszlai merged 3 commits intoapache:mainfrom
chehsunliu:main

chehsunliu commented Nov 23, 2025

Uh oh!

This comment was marked as abuse.

Uh oh!

peterxcli left a comment

Uh oh!

adoroszlai commented Nov 23, 2025

Uh oh!

dnskr left a comment

Uh oh!

dnskr Nov 23, 2025

Uh oh!

dnskr Nov 23, 2025

Uh oh!

dnskr Nov 23, 2025

Uh oh!

dnskr Nov 23, 2025

Uh oh!

chehsunliu commented Nov 23, 2025

Uh oh!

dnskr left a comment

Uh oh!

Uh oh!

adoroszlai commented Nov 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

chehsunliu commented Nov 23, 2025

What changes were proposed in this pull request?

What is the link to the Apache JIRA

How was this patch tested?

Uh oh!

This comment was marked as abuse.

Uh oh!

peterxcli left a comment

Choose a reason for hiding this comment

Uh oh!

adoroszlai commented Nov 23, 2025

Uh oh!

dnskr left a comment

Choose a reason for hiding this comment

Uh oh!

dnskr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

dnskr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

dnskr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

dnskr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

chehsunliu commented Nov 23, 2025

Uh oh!

dnskr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adoroszlai commented Nov 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants