feat: extend erigon and nimbus with more customizations (#416)

Signed-off-by: Carlos Jorge <carlos@graphops.xyz>

---------

Signed-off-by: Carlos Jorge <carlos@graphops.xyz>

Author: cjorge-graphops

charts/erigon/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.10.9
+version: 0.10.10
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/erigon/README.md

@@ -2,7 +2,7 @@
 
 Deploy and scale [Erigon](https://github.com/ledgerwatch/erigon) inside Kubernetes with ease
 
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Version: 0.10.9](https://img.shields.io/badge/Version-0.10.9-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.60.10](https://img.shields.io/badge/AppVersion-v2.60.10-informational?style=flat-square)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Version: 0.10.10](https://img.shields.io/badge/Version-0.10.10-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.60.10](https://img.shields.io/badge/AppVersion-v2.60.10-informational?style=flat-square)
 
 ## Features
 
@@ -161,12 +161,15 @@ We do not recommend that you upgrade the application by overriding `image.tag`.
  | statefulNode.affinity |  | object | `{}` |
  | statefulNode.affinityPresets.antiAffinityByHostname | Configure anti-affinity rules to prevent multiple Erigon instances on the same host | bool | `true` |
  | statefulNode.extraArgs | Additional CLI arguments to pass to `erigon` | list | `[]` |
+ | statefulNode.extraContainers | Additional containers to inject to this graph node group - an array of Container objects | list | `[]` |
+ | statefulNode.extraInitContainers | Additional init containers to inject to this graph node group - an array of Container objects | list | `[]` |
  | statefulNode.extraLabels | Extra labels to attach to the Pod for matching against | object | `{}` |
  | statefulNode.jwt | JWT for clients to authenticate with the Engine API. Specify either `existingSecret` OR `fromLiteral`. | object | `{"existingSecret":{"key":null,"name":null},"fromLiteral":null}` |
  | statefulNode.jwt.existingSecret | Load the JWT from an existing Kubernetes Secret. Takes precedence over `fromLiteral` if set. | object | `{"key":null,"name":null}` |
  | statefulNode.jwt.existingSecret.key | Data key for the JWT in the Secret | string | `nil` |
  | statefulNode.jwt.existingSecret.name | Name of the Secret resource in the same namespace | string | `nil` |
  | statefulNode.jwt.fromLiteral | Use this literal value for the JWT | string | `nil` |
+ | statefulNode.livenessProbe | Sets a livenessProbe configuration for the container | object | `{}` |
  | statefulNode.nodeSelector |  | object | `{}` |
  | statefulNode.p2pNodePort.enabled | Expose P2P port via NodePort | bool | `false` |
  | statefulNode.p2pNodePort.initContainer.image.pullPolicy | Container pull policy | string | `"IfNotPresent"` |
@@ -175,18 +178,24 @@ We do not recommend that you upgrade the application by overriding `image.tag`.
  | statefulNode.p2pNodePort.port | NodePort to be used. Must be unique. | int | `31000` |
  | statefulNode.podAnnotations | Annotations for the `Pod` | object | `{}` |
  | statefulNode.podSecurityContext | Pod-wide security context | object | `{"fsGroup":101337,"runAsGroup":101337,"runAsNonRoot":true,"runAsUser":101337}` |
+ | statefulNode.readinessProbe | Sets a readinessProbe configuration for the container | object | `{}` |
  | statefulNode.resources |  | object | `{}` |
  | statefulNode.restoreSnapshot.enabled | Enable initialising Erigon state from a remote snapshot | bool | `false` |
  | statefulNode.restoreSnapshot.snapshotUrl | URL for snapshot to download and extract to restore state | string | `""` |
+ | statefulNode.rollingUpdatePartition | When using a RollingUpdate update strategy in the StatefulSet, sets a partition index to only update PODs with that index or higher | int | `0` |
  | statefulNode.service.ports.grpc-erigon | Service Port to expose Erigon GRPC interface on | int | `9090` |
  | statefulNode.service.ports.http-engineapi | Service Port to expose engineAPI interface on | int | `8551` |
  | statefulNode.service.ports.http-jsonrpc | Service Port to expose JSON-RPC interface on | int | `8545` |
  | statefulNode.service.ports.http-metrics | Service Port to expose Prometheus metrics on | int | `6060` |
  | statefulNode.service.ports.ws-rpc | Service Port to expose WS-RPC interface on | int | `8546` |
- | statefulNode.service.topologyAwareRouting.enabled |  | bool | `false` |
+ | statefulNode.service.publishNotReadyAddresses.headless | Toggle publishing not ready addresses for headless service | bool | `false` |
+ | statefulNode.service.publishNotReadyAddresses.p2p | Toggle publishing not ready addresses for p2p service | bool | `false` |
+ | statefulNode.service.topologyAwareRouting.enabled | Toggle for topology aware routing | bool | `false` |
  | statefulNode.service.type |  | string | `"ClusterIP"` |
+ | statefulNode.startupProbe | Sets a startupProbe configuration for the container | object | `{}` |
  | statefulNode.terminationGracePeriodSeconds | Amount of time to wait before force-killing the Erigon process | int | `60` |
  | statefulNode.tolerations |  | list | `[]` |
+ | statefulNode.updateStrategyType | Choice of StatefulSet updateStrategy (OnDelete|RollingUpdate) | string | `"RollingUpdate"` |
  | statefulNode.volumeClaimSpec | [PersistentVolumeClaimSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#persistentvolumeclaimspec-v1-core) for Erigon storage | object | `{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"3Ti"}},"storageClassName":null}` |
  | statefulNode.volumeClaimSpec.resources.requests.storage | The amount of disk space to provision for Erigon | string | `"3Ti"` |
  | statefulNode.volumeClaimSpec.storageClassName | The storage class to use when provisioning a persistent volume for Erigon | string | `nil` |

charts/erigon/templates/stateful-node/service.yaml

@@ -10,6 +10,7 @@ metadata:
     {{- $componentLabel | nindent 4 }}
 spec:
   clusterIP: None # Headless service
+  publishNotReadyAddresses: {{ default false $values.service.publishNotReadyAddresses.headless }}
   ports:
   {{- range $portName, $portNumber := $values.service.ports }}
     - port: {{ $portNumber }} # the port we expose on the Service, user configurable
@@ -64,6 +65,7 @@ metadata:
 spec:
   type: NodePort
   externalTrafficPolicy: Local
+  publishNotReadyAddresses: {{ default false $values.service.publishNotReadyAddresses.p2p }}
   ports:
     - name: tcp-p2p
       port: {{ include "erigon.p2pPort" $values }}

charts/erigon/templates/stateful-node/statefulset.yaml

@@ -25,6 +25,15 @@ spec:
         name: storage
       spec:
         {{- toYaml $values.volumeClaimSpec | nindent 8 }}
+  {{- if eq $values.updateStrategyType "OnDelete" }}
+  updateStrategy:
+    type: OnDelete
+  {{- else if eq $values.updateStrategyType "RollingUpdate" }}
+  updateStrategy:
+    type: RollingUpdate
+    rollingUpdate:
+      partition: {{ default 0 ($values.rollingUpdatePartition | quote | atoi) }}
+  {{- end }}
   template:
     metadata:
       {{- with $values.podAnnotations }}
@@ -162,6 +171,9 @@ spec:
             - name: env-nodeport
               mountPath: /env
       {{- end }}
+      {{- with $values.extraInitContainers }}
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
       containers:
         - name: {{ $componentName }}
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
@@ -243,16 +255,32 @@ spec:
               mountPath: /storage
             - name: tmp
               mountPath: /tmp
+          {{- if $values.readinessProbe }}
+          readinessProbe:
+            {{ toYaml $values.readinessProbe | nindent 12 }}
+          {{- else }}
           readinessProbe:
             # This currently requires GRPCContainerProbe feature gate to be enabled on the kubelet
             # https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-grpc-liveness-probe
             # https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/
             grpc:
               port: 9090 # named ports not supported yet by grpc probes
+          {{- end }}
+          {{- if $values.livenessProbe }}
+          livenessProbe:
+            {{ toYaml $values.livenessProbe | nindent 12 }}
+          {{- end }}
+          {{- if $values.startupProbe }}
+          startupProbe:
+            {{ toYaml $values.startupProbe | nindent 12 }}
+          {{- end }}
           {{- with $values.resources }}
           resources:
             {{- toYaml . | nindent 12 }}
           {{- end }}
+      {{- with $values.extraContainers }}
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
       {{- with $values.nodeSelector }}
       nodeSelector:
         {{- toYaml . | nindent 8 }}

charts/erigon/values.yaml

@@ -107,6 +107,25 @@ statefulNode:
   # -- Amount of time to wait before force-killing the Erigon process
   terminationGracePeriodSeconds: 60
 
+  # -- Choice of StatefulSet updateStrategy (OnDelete|RollingUpdate)
+  updateStrategyType: RollingUpdate
+
+  # -- When using a RollingUpdate update strategy in the StatefulSet, sets a partition index to only update PODs with that index or higher
+  rollingUpdatePartition: 0
+
+  # Probes configuration for the containers in the StatefulSet
+  # Users can directly define readiness, liveness, and startup probes below.
+  # These will be directly copied into the StatefulSet manifest.
+
+  # -- Sets a readinessProbe configuration for the container
+  readinessProbe: {}
+
+  # -- Sets a livenessProbe configuration for the container
+  livenessProbe: {}
+
+  # -- Sets a startupProbe configuration for the container
+  startupProbe: {}
+
   # -- Annotations for the `Pod`
   podAnnotations: {}
 
@@ -119,7 +138,13 @@ statefulNode:
 
   service:
     topologyAwareRouting:
+      # -- Toggle for topology aware routing
       enabled: false
+    publishNotReadyAddresses:
+      # -- Toggle publishing not ready addresses for headless service
+      headless: false
+      # -- Toggle publishing not ready addresses for p2p service
+      p2p: false
     type: ClusterIP
     ports:
       # Valid keys are names of ports that are exposed by the Pod that (see templates/stateful-node/statefulset.yaml)
@@ -172,6 +197,11 @@ statefulNode:
         # -- Container pull policy
         pullPolicy: IfNotPresent
 
+  # -- Additional init containers to inject to this graph node group - an array of Container objects
+  extraInitContainers: []
+  # -- Additional containers to inject to this graph node group - an array of Container objects
+  extraContainers: []
+
 rpcdaemon:
   # -- Enable a Deployment of rpcdaemon that can be scaled independently
   enabled: true

charts/nimbus/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.5.19
+version: 0.5.20
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/nimbus/README.md

@@ -2,7 +2,7 @@
 
 Deploy and scale [Nimbus](https://github.com/status-im/nimbus-eth2) inside Kubernetes with ease
 
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Version: 0.5.19](https://img.shields.io/badge/Version-0.5.19-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: multiarch-v24.10.0](https://img.shields.io/badge/AppVersion-multiarch--v24.10.0-informational?style=flat-square)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Version: 0.5.20](https://img.shields.io/badge/Version-0.5.20-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: multiarch-v24.10.0](https://img.shields.io/badge/AppVersion-multiarch--v24.10.0-informational?style=flat-square)
 
 ## Chart Features
 
@@ -109,6 +109,8 @@ We do not recommend that you upgrade the application by overriding `image.tag`.
  | nimbus.affinityPresets.antiAffinityByHostname | Configure anti-affinity rules to prevent multiple instances on the same host | bool | `true` |
  | nimbus.executionClientUrl | URL to the Execution Client Engine API. Will use configured JWT to authenticate. | string | `""` |
  | nimbus.extraArgs | Additional CLI arguments | list | `[]` |
+ | nimbus.extraContainers | Additional containers to inject to this graph node group - an array of Container objects | list | `[]` |
+ | nimbus.extraInitContainers | Additional init containers to inject to this graph node group - an array of Container objects | list | `[]` |
  | nimbus.extraLabels | Extra labels to attach to the Pod for matching against | object | `{}` |
  | nimbus.initChownData.enabled | Init container to set the correct permissions to access data directories | bool | `true` |
  | nimbus.initChownData.image.pullPolicy | Container pull policy | string | `"IfNotPresent"` |
@@ -119,6 +121,7 @@ We do not recommend that you upgrade the application by overriding `image.tag`.
  | nimbus.jwt.existingSecret.key | Data key for the JWT in the Secret | string | `""` |
  | nimbus.jwt.existingSecret.name | Name of the Secret resource in the same namespace | string | `""` |
  | nimbus.jwt.fromLiteral | Use this literal value for the JWT | string | `""` |
+ | nimbus.livenessProbe | Sets a livenessProbe configuration for the container | object | `{}` |
  | nimbus.nodeSelector |  | object | `{}` |
  | nimbus.p2pNodePort.enabled | Expose P2P port via NodePort | bool | `false` |
  | nimbus.p2pNodePort.initContainer.image.pullPolicy | Container pull policy | string | `"IfNotPresent"` |
@@ -127,16 +130,22 @@ We do not recommend that you upgrade the application by overriding `image.tag`.
  | nimbus.p2pNodePort.port | NodePort to be used. Must be unique. | int | `31000` |
  | nimbus.podAnnotations | Annotations for the `Pod` | object | `{}` |
  | nimbus.podSecurityContext | Pod-wide security context | object | `{"fsGroup":101337,"runAsGroup":101337,"runAsNonRoot":true,"runAsUser":101337}` |
+ | nimbus.readinessProbe | Sets a readinessProbe configuration for the container | object | `{}` |
  | nimbus.resources |  | object | `{}` |
+ | nimbus.rollingUpdatePartition | When using a RollingUpdate update strategy in the StatefulSet, sets a partition index to only update PODs with that index or higher | int | `0` |
  | nimbus.service.ports.http-metrics | Service Port to expose Prometheus metrics on | int | `8008` |
  | nimbus.service.ports.http-nimbus | Service Port to expose JSON-RPC interface on | int | `5052` |
- | nimbus.service.topologyAwareRouting.enabled |  | bool | `false` |
+ | nimbus.service.publishNotReadyAddresses.headless | Toggle publishing not ready addresses for headless service | bool | `false` |
+ | nimbus.service.publishNotReadyAddresses.p2p | Toggle publishing not ready addresses for p2p service | bool | `false` |
+ | nimbus.service.topologyAwareRouting.enabled | Toggle for topology aware routing | bool | `false` |
  | nimbus.service.type |  | string | `"ClusterIP"` |
+ | nimbus.startupProbe | Sets a startupProbe configuration for the container | object | `{}` |
  | nimbus.terminationGracePeriodSeconds | Amount of time to wait before force-killing the container | int | `60` |
  | nimbus.tolerations |  | list | `[]` |
  | nimbus.trustedNodeSync.enabled | Enable init container to do a trusted checkpoint sync from another Consensus Client (be careful) | bool | `false` |
  | nimbus.trustedNodeSync.extraArgs | Additional CLI arguments | list | `[]` |
  | nimbus.trustedNodeSync.trustedNodeUrl | URL to the Trusted Consensus Client Node URL. See https://eth-clients.github.io/checkpoint-sync-endpoints/ | string | `""` |
+ | nimbus.updateStrategyType | Choice of StatefulSet updateStrategy (OnDelete|RollingUpdate) | string | `"RollingUpdate"` |
  | nimbus.volumeClaimSpec | [PersistentVolumeClaimSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#persistentvolumeclaimspec-v1-core) for storage | object | `{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"300Gi"}},"storageClassName":null}` |
  | nimbus.volumeClaimSpec.resources.requests.storage | The amount of disk space to provision | string | `"300Gi"` |
  | nimbus.volumeClaimSpec.storageClassName | The storage class to use when provisioning a persistent volume | string | `nil` |

charts/nimbus/templates/nimbus/service.yaml

@@ -10,6 +10,7 @@ metadata:
     {{- $componentLabel | nindent 4 }}
 spec:
   clusterIP: None # Headless service
+  publishNotReadyAddresses: {{ default false $values.service.publishNotReadyAddresses.headless }}
   ports:
   {{- range $portName, $portNumber := $values.service.ports }}
     - port: {{ $portNumber }} # the port we expose on the Service, user configurable
@@ -64,6 +65,7 @@ metadata:
 spec:
   type: NodePort
   externalTrafficPolicy: Local
+  publishNotReadyAddresses: {{ default false $values.service.publishNotReadyAddresses.p2p }}
   ports:
     - name: tcp-p2p
       port: {{ include "nimbus.p2pPort" $values }}

charts/nimbus/templates/nimbus/statefulset.yaml

@@ -25,6 +25,15 @@ spec:
         name: storage
       spec:
         {{- toYaml $values.volumeClaimSpec | nindent 8 }}
+  {{- if eq $values.updateStrategyType "OnDelete" }}
+  updateStrategy:
+    type: OnDelete
+  {{- else if eq $values.updateStrategyType "RollingUpdate" }}
+  updateStrategy:
+    type: RollingUpdate
+    rollingUpdate:
+      partition: {{ default 0 ($values.rollingUpdatePartition | quote | atoi) }}
+  {{- end }}
   template:
     metadata:
       {{- with $values.podAnnotations }}
@@ -176,6 +185,9 @@ spec:
             - name: tmp
               mountPath: /tmp
       {{- end }}
+      {{- with $values.extraInitContainers }}
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
       containers:
         - name: {{ $componentName }}
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
@@ -244,15 +256,31 @@ spec:
               mountPath: /storage
             - name: tmp
               mountPath: /tmp
+          {{- if $values.readinessProbe }}
+          readinessProbe:
+            {{ toYaml $values.readinessProbe | nindent 12 }}
+          {{- else }}
           readinessProbe:
             tcpSocket:
               port: http-nimbus
             initialDelaySeconds: 10
             periodSeconds: 10
+          {{- end }}
+          {{- if $values.livenessProbe }}
+          livenessProbe:
+            {{ toYaml $values.livenessProbe | nindent 12 }}
+          {{- end }}
+          {{- if $values.startupProbe }}
+          startupProbe:
+            {{ toYaml $values.startupProbe | nindent 12 }}
+          {{- end }}
           {{- with $values.resources }}
           resources:
             {{- toYaml . | nindent 12 }}
           {{- end }}
+        {{- with $values.extraContainers }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
       {{- with $values.nodeSelector }}
       nodeSelector:
         {{- toYaml . | nindent 8 }}