feat: Add support for arm64 architecture (#11)

* feat: Add support for arm64 architecture

This commit introduces support for the arm64 architecture by:

1.  **Updating the Dockerfile:**
    *   The `exporter/Dockerfile` now uses the `TARGETARCH` build argument to dynamically determine the correct path for `libiperf.so.0`. This allows the same Dockerfile to be used for building both `amd64` and `arm64` images.

2.  **Modifying GitHub Workflows:**
    *   The CI workflow (`.github/workflows/ci.yaml`) and the Release workflow (`.github/workflows/release.yml`) have been updated to build and push multi-architecture Docker images (`linux/amd64` and `linux/arm64`).
    *   This involves adding the `docker/setup-qemu-action` for cross-compilation and specifying the target platforms in the `docker/build-push-action`.

3.  **Helm Chart:**
    *   No changes were required for the Helm chart as the image tag will now point to a multi-arch manifest, and the default iperf3 server image (`networkstatic/iperf3:latest`) is assumed to be multi-arch. Node selectors in the chart are not architecture-specific.

These changes enable the deployment of the iperf3-monitor on Kubernetes clusters with arm64 nodes.

* fix: Ensure multi-platform builds with Docker Buildx

This commit updates the GitHub Actions workflows to correctly set up
Docker Buildx for multi-platform (amd64, arm64) image builds.

Previously, the workflows were missing the `docker/setup-buildx-action`
step, which led to errors when attempting multi-platform builds as the
default Docker driver does not support this.

The following changes were made:
1.  **Added `docker/setup-buildx-action@v3`:**
    - This step is now included in both the CI (`.github/workflows/ci.yaml`) and Release (`.github/workflows/release.yml`) workflows before the QEMU setup and build/push actions.

2.  **Dockerfile (`exporter/Dockerfile`):**
    - Remains as per the previous commit, using `TARGETARCH` to correctly copy architecture-specific libraries. This part was already correct for multi-arch builds.

3.  **Helm Chart:**
    - No changes were required for the Helm chart.

This ensures that the CI/CD pipeline can successfully build and push
Docker images for both `linux/amd64` and `linux/arm64` architectures.

* fix: Correct Dockerfile lib path and add Helm dependency toggle

This commit includes two main changes:

1.  **Fix Dockerfile library path for amd64:**
    - I updated the `exporter/Dockerfile` to correctly determine the source path for `libiperf.so.0` when building for different architectures.
    - Specifically, for `TARGETARCH=amd64`, the path `/usr/lib/x86_64-linux-gnu/libiperf.so.0` is now used.
    - For `TARGETARCH=arm64`, the path `/usr/lib/aarch64-linux-gnu/libiperf.so.0` is used.
    - I achieved this by copying the library to a canonical temporary location in the builder stage based on `TARGETARCH`, and then copying it from this location into the final image. This resolves an issue where builds for `amd64` would fail to find the library.

2.  **Add Helm chart option to disable dependencies:**
    - I added a new option `dependencies.install` (default: `true`) to `charts/iperf3-monitor/values.yaml`.
    - This allows you to disable the installation of managed dependencies (i.e., Prometheus Operator via `kube-prometheus-stack` or `prometheus-operator` from TrueCharts) even if `serviceMonitor.enabled` is true.
    - I updated the `condition` for these dependencies in `charts/iperf3-monitor/Chart.yaml` to `dependencies.install, serviceMonitor.enabled, ...`.
    - This is useful for you if you manage your Prometheus Operator installation separately.

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

.github/workflows/ci.yaml

@@ -0,0 +1,64 @@
+name: CI
+
+on:
+  pull_request:
+    branches: ["main"] # Or your main development branch
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  validate-chart:
+    name: Validate Helm Chart
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v3
+        with:
+          version: v3.10.0
+
+      - name: Helm Lint
+        run: helm lint ./charts/iperf3-monitor
+
+  build:
+    name: Build Docker Image
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: ./exporter
+          push: false # Do not push on PRs
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
+
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      # Replace this step with your actual test command(s)
+      - name: Placeholder Test Step
+        run: echo "No tests configured yet. Add your test commands here."

.github/workflows/release.yml

@@ -36,6 +36,12 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v3
 
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
       - name: Log in to GitHub Container Registry
         uses: docker/login-action@v2
         with:
@@ -56,6 +62,7 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
 
   package-and-publish-chart:
     name: Package and Publish Helm Chart
@@ -82,8 +89,8 @@ jobs:
       - name: Set Chart Version from Tag
         run: |
           VERSION=$(echo "${{ github.ref_name }}" | sed 's/^v//')
-          yq e -i '.version = strenv(VERSION)' ./charts/iperf3-monitor/Chart.yaml
-          yq e -i '.appVersion = strenv(VERSION)' ./charts/iperf3-monitor/Chart.yaml
+          VERSION=$VERSION yq e -i '.version = strenv(VERSION)' ./charts/iperf3-monitor/Chart.yaml
+          VERSION=$VERSION yq e -i '.appVersion = strenv(VERSION)' ./charts/iperf3-monitor/Chart.yaml
           cat ./charts/iperf3-monitor/Chart.yaml # Optional: print updated Chart.yaml
 
       - name: Publish Helm chart

.gitignore

@@ -36,4 +36,4 @@ Thumbs.db
 
 # Helm
 !charts/iperf3-monitor/.helmignore
-charts/*.tgz # Ignore packaged chart files
+charts/iperf3-monitor/charts/

README.md

@@ -37,7 +37,7 @@ This separation of concerns ensures scalability, resilience, and aligns with Kub
 1.  Add the Helm chart repository (replace with your actual repo URL once published):
 
     ```/dev/null/helm-install.sh#L1-1
-    helm repo add iperf3-monitor https://your-github-org.github.io/iperf3-monitor/
+    helm repo add iperf3-monitor https://malarinv.github.io/iperf3-monitor/
     ```
 
 2.  Update your Helm repositories:
@@ -78,7 +78,7 @@ exporter:
   # -- Configuration for the exporter container image.
   image:
     # -- The container image repository for the exporter.
-    repository: ghcr.io/my-org/iperf3-prometheus-exporter # Replace with your repo URL
+    repository: ghcr.io/malarinv/iperf3-monitor
     # -- The container image tag for the exporter. If not set, the chart's appVersion is used.
     tag: ""
     # -- The image pull policy for the exporter container.
@@ -430,8 +430,4 @@ The project includes a GitHub Actions workflow (`.github/workflows/release.yml`)
 
 ## License
 
-This project is licensed under the terms defined in the `LICENSE` file.
-
-```iperf3-monitor/LICENSE
-This project is currently unlicensed. Please see the project's documentation or repository for licensing information when it becomes available.
-```
+This project is licensed under the GNU Affero General Public License v3. See the `LICENSE` file for details.

charts/iperf3-monitor/Chart.lock

@@ -0,0 +1,9 @@
+dependencies:
+- name: kube-prometheus-stack
+  repository: https://prometheus-community.github.io/helm-charts
+  version: 75.3.6
+- name: prometheus-operator
+  repository: oci://tccr.io/truecharts
+  version: 11.5.1
+digest: sha256:3000e63445f8ba8df601cb483f4f77d14c5c4662bff2d16ffcf5cf1f7def314b
+generated: "2025-06-20T17:25:44.538372209+05:30"

charts/iperf3-monitor/Chart.yaml

@@ -12,19 +12,23 @@ keywords:
   - kubernetes
   - prometheus
   - grafana
-home: https://github.com/malarinv/iperf3-monitor # Replace with your repo URL
+home: https://github.com/malarinv/iperf3-monitor
 sources:
-  - https://github.com/malarinv/iperf3-monitor # Replace with your repo URL
+  - https://github.com/malarinv/iperf3-monitor
 maintainers:
-  - name: Malar Invention # Replace with your name
-    email: malarkannan.invention@gmail.com # Replace with your email
+  - name: Malar Invention
+    email: malarkannan.invention@gmail.com
 icon: https://raw.githubusercontent.com/malarinv/iperf3-monitor/main/icon.png # Optional icon URL
 annotations:
   artifacthub.io/changes: |
     - Add initial Helm chart structure.
   artifacthub.io/category: networking
 dependencies:
-  - name: prometheus-community/kube-prometheus-stack # Example dependency if you package the whole stack
+  - name: kube-prometheus-stack # Example dependency if you package the whole stack
     version: ">=30.0.0" # Specify a compatible version range
     repository: https://prometheus-community.github.io/helm-charts
-    condition: serviceMonitor.enabled # Only include if ServiceMonitor is enabled (assuming Prometheus Operator)
+    condition: "dependencies.install, serviceMonitor.enabled, !dependencies.useTrueChartsPrometheusOperator"
+  - name: prometheus-operator
+    version: ">=8.11.1"
+    repository: "oci://tccr.io/truecharts"
+    condition: "dependencies.install, serviceMonitor.enabled, dependencies.useTrueChartsPrometheusOperator"

charts/iperf3-monitor/templates/_helpers.tpl

@@ -29,9 +29,9 @@ Create chart's labels
 {{- define "iperf3-monitor.labels" -}}
 helm.sh/chart: {{ include "iperf3-monitor.name" . }}-{{ .Chart.Version | replace "+" "_" }}
 {{ include "iperf3-monitor.selectorLabels" . }}
-{{- if .Chart.AppVersion -}}
+{{ if .Chart.AppVersion }}
 app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
-{{- end -}}
+{{ end }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end -}}
 
@@ -41,7 +41,7 @@ Selector labels
 {{- define "iperf3-monitor.selectorLabels" -}}
 app.kubernetes.io/name: {{ include "iperf3-monitor.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
-{{- end -}}
+{{ end }}
 
 {{/*
 Create the name of the service account to use

charts/iperf3-monitor/templates/exporter-deployment.yaml

@@ -41,7 +41,7 @@ spec:
             fieldRef:
               fieldPath: metadata.namespace
         - name: IPERF_SERVER_LABEL_SELECTOR
-          value: "app.kubernetes.io/name={{ include \"iperf3-monitor.name\" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=server"
+          value: 'app.kubernetes.io/name={{ include "iperf3-monitor.name" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=server'
         {{- with .Values.exporter.resources }}
         resources:
           {{- toYaml . | nindent 10 }}

charts/iperf3-monitor/values.yaml

@@ -12,7 +12,7 @@ exporter:
   # -- Configuration for the exporter container image.
   image:
     # -- The container image repository for the exporter.
-    repository: ghcr.io/malarinv/iperf3-prometheus-exporter # Replace with your repo URL
+    repository: ghcr.io/malarinv/iperf3-monitor
     # -- The container image tag for the exporter. If not set, the chart's appVersion is used.
     tag: ""
     # -- The image pull policy for the exporter container.
@@ -118,3 +118,19 @@ networkPolicy:
   namespaceSelector: {}
   # -- Specify pod selectors if needed.
   podSelector: {}
+
+# -----------------------------------------------------------------------------
+# Dependency Configuration
+# -----------------------------------------------------------------------------
+dependencies:
+  # -- Set to true to install Prometheus operator dependency if serviceMonitor.enabled is also true.
+  # -- Set to false to disable the installation of Prometheus operator dependency,
+  # -- regardless of serviceMonitor.enabled. This is useful if you have Prometheus
+  # -- Operator installed and managed separately in your cluster.
+  install: true
+
+  # -- Set to true to use the TrueCharts Prometheus Operator instead of kube-prometheus-stack.
+  # This chart's ServiceMonitor resources require a Prometheus Operator to be functional.
+  # If serviceMonitor.enabled is true and dependencies.install is true,
+  # one of these two dependencies will be pulled based on this flag.
+  useTrueChartsPrometheusOperator: false

devbox.json

@@ -0,0 +1,14 @@
+{
+  "$schema":  "https://raw.githubusercontent.com/jetify-com/devbox/0.13.7/.schema/devbox.schema.json",
+  "packages": [],
+  "shell": {
+    "init_hook": [
+      "echo 'Welcome to devbox!' > /dev/null"
+    ],
+    "scripts": {
+      "test": [
+        "echo \"Error: no test specified\" && exit 1"
+      ]
+    }
+  }
+}

devbox.lock

@@ -0,0 +1,4 @@
+{
+  "lockfile_version": "1",
+  "packages": {}
+}

exporter/Dockerfile

@@ -1,6 +1,8 @@
 # Stage 1: Build stage with dependencies
 FROM python:3.9-slim as builder
 
+# Declare TARGETARCH for use in this stage
+ARG TARGETARCH
 WORKDIR /app
 
 # Install iperf3 and build dependencies
@@ -8,6 +10,20 @@ RUN apt-get update && \
     apt-get install -y --no-install-recommends gcc iperf3 libiperf-dev && \
     rm -rf /var/lib/apt/lists/*
 
+# Determine the correct libiperf source directory based on TARGETARCH
+# and copy libiperf.so.0 to a canonical temporary location /tmp/lib/ within the builder stage.
+RUN echo "Builder stage TARGETARCH: ${TARGETARCH}" && \
+    LIBIPERF_SRC_DIR_SEGMENT="" && \
+    if [ "${TARGETARCH}" = "amd64" ]; then \
+        LIBIPERF_SRC_DIR_SEGMENT="x86_64-linux-gnu"; \
+    elif [ "${TARGETARCH}" = "arm64" ]; then \
+        LIBIPERF_SRC_DIR_SEGMENT="aarch64-linux-gnu"; \
+    else \
+        echo "Unsupported TARGETARCH in builder: ${TARGETARCH}" && exit 1; \
+    fi && \
+    mkdir -p /tmp/lib && \
+    cp "/usr/lib/${LIBIPERF_SRC_DIR_SEGMENT}/libiperf.so.0" /tmp/lib/libiperf.so.0
+
 # Install Python dependencies
 COPY requirements.txt .
 RUN pip install --no-cache-dir -r requirements.txt
@@ -17,9 +33,11 @@ FROM python:3.9-slim
 
 WORKDIR /app
 
-# Copy iperf3 binary and library from the builder stage
+# Copy iperf3 binary from the builder stage
 COPY --from=builder /usr/bin/iperf3 /usr/bin/iperf3
-COPY --from=builder /usr/lib/x86_64-linux-gnu/libiperf.so.0 /usr/lib/x86_64-linux-gnu/libiperf.so.0
+# Copy the prepared libiperf.so.0 from the builder's canonical temporary location
+# into a standard library path in the final image.
+COPY --from=builder /tmp/lib/libiperf.so.0 /usr/lib/libiperf.so.0
 
 # Copy installed Python packages from the builder stage
 COPY --from=builder /usr/local/lib/python3.9/site-packages /usr/local/lib/python3.9/site-packages