Fix: Ignore packaged chart files and remove markdown files (#10)

Removes the outdated markdown files and fixes the .gitignore to ignore packaged chart files in the correct directories. This prevents them from being committed to

.github/workflows/ci.yaml

@@ -0,0 +1,57 @@
+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: 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 }}
+
+  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

@@ -82,8 +82,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: "serviceMonitor.enabled, !dependencies.useTrueChartsPrometheusOperator"
+  - name: prometheus-operator
+    version: ">=8.11.1"
+    repository: "oci://tccr.io/truecharts"
+    condition: "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/templates/server-daemonset.yaml

@@ -41,4 +41,4 @@ spec:
           {{- with .Values.server.resources }}
           resources:
             {{- toYaml . | nindent 12 }}
-          {{- end }}
+          {{- end }}

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,12 @@ networkPolicy:
   namespaceSelector: {}
   # -- Specify pod selectors if needed.
   podSelector: {}
+
+# -----------------------------------------------------------------------------
+# Dependency Configuration
+# -----------------------------------------------------------------------------
+dependencies:
+  # -- 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, 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": {}
+}