Add additional port support to nitro pods (#15)

* Add additional port support * Update README and values.schema.json for modified charts * Empty commit --------- Co-authored-by: a-thomas-22 <[email protected]>
OffchainLabs · Jan 30, 2024 · f27ed74 · f27ed74
1 parent 66a1685
commit f27ed74
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 4 deletions.
diff --git a/charts/nitro/Chart.yaml b/charts/nitro/Chart.yaml
@@ -7,6 +7,6 @@ maintainers:
 
 type: application
 
-version: 0.1.16
+version: 0.1.17
 
 appVersion: "v2.2.2-8f33fea"
diff --git a/charts/nitro/README.md b/charts/nitro/README.md
@@ -114,6 +114,7 @@ helm install xai offchainlabs/nitro -f values.yaml
 | `tolerations`                                | Tolerations for the pod                                      | `[]`                                                        |
 | `affinity`                                   | Affinity for the pod                                         | `{}`                                                        |
 | `additionalVolumeClaims`                     | Additional volume claims for the pod                         | `[]`                                                        |
+| `extraPorts`                                 | Additional ports for the pod                                 | `[]`                                                        |
 | `configmap.enabled`                          | Enable a configmap for the nitro container                   | `true`                                                      |
 | `configmap.data`                             | See Configuration Options for the full list of options       |                                                             |
 | `configmap.data.http.addr`                   | Address to bind http service to                              | `0.0.0.0`                                                   |
@@ -162,6 +163,7 @@ helm install xai offchainlabs/nitro -f values.yaml
 | `validator.statefulset.startupProbe.enabled`               | Enable the startup probe for the validator statefulset   | `false`              |
 | `validator.statefulset.resources`                          | Resources for the validator container                    | `{}`                 |
 | `validator.statefulset.extraEnv`                           | Extra environment variables for the validator container  | `{}`                 |
+| `validator.statefulset.extraPorts`                         | Additional ports for the stateless validator pod         | `[]`                 |
 | `validator.statefulset.metrics.enabled`                    | Enable metrics for the validator statefulset             | `false`              |
 | `validator.statefulset.podAnnotations`                     | Annotations for the stateless validator pod              | `{}`                 |
 

diff --git a/charts/nitro/templates/service.yaml b/charts/nitro/templates/service.yaml
@@ -38,5 +38,13 @@ spec:
       protocol: TCP
       name: metrics
     {{- end }}
+    {{- range .Values.extraPorts }}
+    {{- if .serviceEnabled | default true }}
+    - name: {{ .name }}
+      port: {{ .servicePort | default .port }}
+      targetPort: {{ .port }}
+      protocol: {{ .protocol | default "TCP" }}
+    {{- end }}
+    {{- end }}
   selector:
     {{- include "nitro.selectorLabels" . | nindent 4 }}
diff --git a/charts/nitro/templates/statefulset.yaml b/charts/nitro/templates/statefulset.yaml
@@ -97,6 +97,11 @@ spec:
               containerPort: {{ .Values.configmap.data.node.feed.output.port }}
               protocol: TCP
             {{- end }}
+            {{- range .Values.extraPorts }}
+            - name: {{ .name }}
+              containerPort: {{ .port }}
+              protocol: {{ .protocol | default "TCP" }}
+            {{- end }}
           {{- if .Values.livenessProbe.enabled }}
           livenessProbe:
             {{- if and .Values.livenessProbe.exec (kindIs "string" .Values.livenessProbe.exec.command) }}

diff --git a/charts/nitro/templates/validator/service.yaml b/charts/nitro/templates/validator/service.yaml
@@ -24,10 +24,15 @@ spec:
       protocol: TCP
       name: metrics
   {{- end }}
-  {{- with $.Values.validator.statefulset.extraServicePorts }}
-    {{- toYaml . | nindent 4 }}
+  {{- range .Values.validator.statefulset.extraPorts }}
+  {{- if .serviceEnabled | default true }}
+  - name: {{ .name }}
+    port: {{ .port }}
+    targetPort: {{ .port }}
+    protocol: {{ .protocol | default "TCP" }}
+  {{- end }}
   {{- end }}
   selector:
     {{- $selectorLabels | nindent 4 }}
     function: arb-validator
-{{- end }}
+{{- end }}
diff --git a/charts/nitro/templates/validator/statefulset.yaml b/charts/nitro/templates/validator/statefulset.yaml
@@ -85,6 +85,11 @@ spec:
         - name: auth
           containerPort: {{ .Values.validator.statefulset.auth.port }}
         {{- end }}
+        {{- range .Values.validator.statefulset.extraPorts }}
+        - name: {{ .name }}
+          containerPort: {{ .port }}
+          protocol: {{ .protocol | default "TCP" }}
+        {{- end }}
         volumeMounts:
           {{- if .Values.jwtSecret.enabled }}
           - name: jwt-secret

diff --git a/charts/nitro/values.yaml b/charts/nitro/values.yaml
@@ -121,6 +121,9 @@ affinity: {}
 ## @param additionalVolumeClaims Additional volume claims for the pod
 additionalVolumeClaims: []
 
+## @param extraPorts Additional ports for the pod
+extraPorts: []
+
 configmap:
   ## @param configmap.enabled Enable a configmap for the nitro container
   enabled: true
@@ -246,6 +249,9 @@ validator:
     ## @param validator.statefulset.extraEnv Extra environment variables for the validator container
     extraEnv: {}
 
+    ## @param validator.statefulset.extraPorts Additional ports for the stateless validator pod
+    extraPorts: []
+
     ## @param validator.statefulset.metrics.enabled Enable metrics for the validator statefulset
     metrics:
       enabled: false