Helm chart v0

.dockerignore

@@ -1 +1 @@
-target/
+!target/

.github/workflows/docker.yml

@@ -1,81 +1,82 @@
 name: docker
 
 on:
-    push:
-        branches:
-            - main
+  push:
+    branches:
+    - main
+    - stable
+    - unstable
+    tags:
+      - v*
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 env:
-    DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
-    DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+  DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+  DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+  DOCKER_BUILD_SUMMARY: true
+  REPO_NAME: $GITHUB_REPOSITORY
+  IMAGE_NAME: ${{ github.repository }}:${{ github.ref_name }}
 
 jobs:
-    build-docker-single-arch:
-        name: build-docker-${{ matrix.cpu_arch }}
+  extract-version:
+        uses: ./.github/workflows/extract-version.yml
+  build-docker:
+        name: build-docker
         runs-on: ubuntu-22.04
         strategy:
-            matrix:
-                cpu_arch: [aarch64, x86_64]
+          fail-fast: false
         steps:
-            - uses: actions/checkout@v4
-            - name: Update Rust
-              run: rustup update stable
-            - name: Dockerhub login
-              run: |
-                  echo "${DOCKER_PASSWORD}" | docker login --username ${DOCKER_USERNAME} --password-stdin
-            - name: Cross build binaries
-              run: |
-                  cargo install cross
-                  make build-${{ matrix.cpu_arch }}
 
-            - name: Make bin dir
-              run: mkdir ./bin
+          - uses: actions/checkout@v4
+          - name: Update Rust
+            run: rustup update stable
+          - name: Login to DockerHub
+            uses: docker/login-action@v3
+            with:
+              username: ${{ env.DOCKER_USERNAME }}
+              password: ${{ env.DOCKER_PASSWORD }}
 
-            - name: Move cross-built binary into Docker scope
-              run: mv ./target/${{ matrix.cpu_arch }}-unknown-linux-gnu/release/eleel ./bin
+          - name: Debug IMAGE_NAME
+            run: echo "IMAGE_NAME=${{ env.IMAGE_NAME }}"
+
+          - name: Cross build binaries
+            run: |
+                cargo install cross
+                make build
+            timeout-minutes: 100
 
-            - name: Map aarch64 to arm64 short arch
-              if: startsWith(matrix.cpu_arch, 'aarch64')
-              run: echo "SHORT_ARCH=arm64" >> $GITHUB_ENV
+          - name: Install QEMU
+            run: sudo apt-get update && sudo apt-get install -y qemu-user-static
 
-            - name: Map x86_64 to amd64 short arch
-              if: startsWith(matrix.cpu_arch, 'x86_64')
-              run: echo "SHORT_ARCH=amd64" >> $GITHUB_ENV
+          - name: Set up Docker Buildx
+            uses: docker/setup-buildx-action@v3
 
-            - name: Install QEMU
-              run: sudo apt-get update && sudo apt-get install -y qemu-user-static
+          - name: Build and push using Bake
+            uses: docker/bake-action@v6
+            with:
+              files: ./docker-bake.hcl
+              source: .
+              push: true
+              load: true
+              set: |
+                *.context=.
+                *.tags=${{ env.IMAGE_NAME }}
+            env:
+              GITHUB_REPO: ${{ github.repository }}
+              DOCKER_BUILD_RECORD_UPLOAD: true
 
-            - name: Set up Docker Buildx
-              uses: docker/setup-buildx-action@v3
+          - name: Login to DockerHub
+            uses: docker/login-action@v3
+            with:
+                username: ${{ env.DOCKER_USERNAME }}
+                password: ${{ env.DOCKER_PASSWORD }}
 
-            - name: Build and push
-              uses: docker/build-push-action@v5
-              with:
-                file: ./Dockerfile.cross
-                context: .
-                platforms: linux/${{ env.SHORT_ARCH }}
-                push: true
-                tags: |
-                  ${{ github.repository_owner }}/eleel:latest-${{ env.SHORT_ARCH }}
+          - name: Create and push multiarch manifest
+            run: |
+                docker buildx imagetools create -t ${{ env.IMAGE_NAME }}  --append --debug \
+                ${{ github.repository }}-arm64 \
+                ${{ github.repository }}-amd64
 
-    build-docker-multiarch:
-        name: build-docker-eleel-multiarch
-        runs-on: ubuntu-22.04
-        needs: [build-docker-single-arch]
-        steps:
-            - name: Set up Docker Buildx
-              uses: docker/setup-buildx-action@v3
-
-            - name: Dockerhub login
-              run: |
-                  echo "${DOCKER_PASSWORD}" | docker login --username ${DOCKER_USERNAME} --password-stdin
-
-            - name: Create and push multiarch manifests
-              run: |
-                  docker buildx imagetools create -t ${{ github.repository_owner}}/eleel:latest \
-                      ${{ github.repository_owner}}/eleel:latest-arm64 \
-                      ${{ github.repository_owner}}/eleel:latest-amd64;

.github/workflows/extract-version.yml

@@ -0,0 +1,49 @@
+name: Extract Version
+
+on:
+  workflow_call:
+    outputs:
+      VERSION:
+        description: "The extracted version (latest or vX.Y.Z)"
+        value: ${{ jobs.extract-version.outputs.VERSION || 'latest' }}
+      VERSION_SUFFIX:
+        description: "The version suffix (empty or -unstable)"
+        value: ${{ jobs.extract-version.outputs.VERSION_SUFFIX }}
+
+jobs:
+  extract-version:
+    runs-on: ubuntu-22.04
+    outputs:
+      VERSION: ${{ env.VERSION }}
+      VERSION_SUFFIX: ${{ env.VERSION_SUFFIX }}
+    steps:
+
+
+      - name: Extract version (if stable)
+        if: github.event.ref == 'refs/heads/stable'
+        run: |
+          echo "VERSION=latest" >> $GITHUB_ENV
+          echo "VERSION_SUFFIX=" >> $GITHUB_ENV
+
+      - name: Extract version (if unstable)
+        if: github.event.ref == 'refs/heads/unstable'
+        run: |
+          echo "VERSION=latest" >> $GITHUB_ENV
+          echo "VERSION_SUFFIX=-unstable" >> $GITHUB_ENV
+
+      - name: Extract version (if other branch)
+        if: github.event.ref != 'refs/heads/stable' && github.event.ref != 'refs/heads/unstable' && !startsWith(github.event.ref, 'refs/tags')
+        run: |
+          echo "VERSION=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
+          echo "VERSION_SUFFIX=" >> $GITHUB_ENV
+
+      - name: Extract version (if tagged release)
+        if: startsWith(github.event.ref, 'refs/tags')
+        run: |
+          echo "VERSION=$(echo ${GITHUB_REF#refs/tags/})" >> $GITHUB_ENV
+          echo "VERSION_SUFFIX=" >> $GITHUB_ENV
+
+      - name: Debug - Print environment variables
+        run: |
+          echo "[debug] VERSION=${{ env.VERSION }}"
+          echo "[debug] VERSION_SUFFIX=${{ env.VERSION_SUFFIX }}"

.github/workflows/helm-tests.yml

@@ -0,0 +1,19 @@
+name: Helm Chart Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install helm-unittest plugin
+        run: helm plugin install https://github.com/helm-unittest/helm-unittest.git
+
+      - name: Run Helm unit tests
+        run: helm unittest charts/eleel -f "charts/eleel/tests/*_test.yaml"

.gitignore

@@ -1,3 +1,4 @@
 /target
 *.swp
 *.toml
+.qodo

Dockerfile.cross

@@ -2,9 +2,10 @@
 # It assumes the eleel binary has already been
 # compiled for `$TARGETPLATFORM` and moved to `./bin`.
 FROM --platform=$TARGETPLATFORM ubuntu:24.04
+ARG TARGET_ARCH
 RUN apt-get update && apt-get install -y --no-install-recommends \
-  libssl-dev \
-  ca-certificates \
-  && apt-get clean \
-  && rm -rf /var/lib/apt/lists/*
-COPY ./bin/eleel /usr/local/bin/eleel
+    libssl-dev \
+    ca-certificates \
+ && apt-get clean \
+ && rm -rf /var/lib/apt/lists/*
+ADD ./target/$TARGET_ARCH/release/eleel /usr/local/bin/eleel

Makefile

@@ -4,4 +4,6 @@ build-x86_64:
 build-aarch64:
 	cross build --bin eleel --target aarch64-unknown-linux-gnu  --profile release --locked
 
+build: build-x86_64 build-aarch64
+
 .PHONY: build-x86_64 build-aarch64

README.md

@@ -17,6 +17,14 @@ Eleel is written in Rust and makes use of components from [Lighthouse][].
 
 A binary will be installed to `~/.cargo/bin/eleel`.
 
+### Build docker images
+
+### Using `bake`
+
+See https://docs.docker.com/build/building/multi-platform/.
+
+`docker buildx bake -f docker-bake.hcl`
+
 ## Getting started
 
 Eleel needs to connect to a _real_ execution node, e.g. Geth/Nethermind/Besu. You

charts/eleel/Chart.yaml

@@ -0,0 +1,7 @@
+apiVersion: v2
+name: eleel
+description: A Helm chart for Kubernetes to deploy Eleel Ethereum execution engine multiplexer
+type: application
+version: 0.1.0
+appVersion: "1.0.0"
+kubeVersion: ">=1.19.0-0"

charts/eleel/rendered.yaml

@@ -0,0 +1,66 @@
+---
+# Source: eleel/templates/statefulset.yaml
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: eleel-test
+  labels:
+    app.kubernetes.io/name: eleel
+    app.kubernetes.io/instance: eleel-test
+    app.kubernetes.io/managed-by: Helm
+    helm.sh/chart: eleel-0.1.0
+    app.kubernetes.io/version: "1.0.0"
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: eleel
+      app.kubernetes.io/instance: eleel-test
+  serviceName: eleel-test
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: eleel
+        app.kubernetes.io/instance: eleel-test
+    spec:
+      containers:
+        - name: eleel
+          image: "eleel:test"
+          imagePullPolicy: IfNotPresent
+          ports:
+            - name: http
+              containerPort: 8552
+              protocol: TCP
+          env:
+            - name: RUST_LOG
+              value: "eleel=debug"
+            - name: LISTEN_ADDRESS
+              value: "0.0.0.0"
+            - name: LISTEN_PORT
+              value: "8552"
+            - name: EE_URL
+              value: "http://test-engine:8551"
+            - name: NETWORK
+              value: "mainnet"
+            - name: EE_JWT_SECRET
+              value: "/test-secrets/ee.jwt"
+            - name: CONTROLLER_JWT_SECRET
+              value: "/test-secrets/controller.jwt"
+            - name: CLIENT_JWT_SECRETS
+              value: "/test-secrets/clients.toml"
+          volumeMounts:
+            - name: jwt-secrets
+              mountPath: /test-secrets
+              readOnly: true
+          livenessProbe:
+            httpGet:
+              path: /health
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /health
+              port: http
+      volumes:
+        - name: jwt-secrets
+          secret:
+            secretName: "eleel-test-jwt-secrets"