Merge pull request #2220 from sthaha/chore-helm-chart

feat: add Helm chart for Kepler deployment

Author: Sunil Thaha

.github/k8s/action.yaml

@@ -45,6 +45,11 @@ runs:
       run: |
         kubectl version --client
 
+    - name: Setup Helm
+      uses: azure/setup-helm@v4
+      with:
+        version: latest
+
     - name: Checkout source
       uses: actions/checkout@v4
       with:
@@ -56,6 +61,11 @@ runs:
         go-version-file: go.mod
         cache: false
 
+    - name: Lint Helm chart
+      shell: bash
+      run: |
+        helm lint manifests/helm/kepler
+
     - name: Build image
       shell: bash
       run: |
@@ -128,6 +138,55 @@ runs:
           fi
         done
 
+    - name: Remove existing Kepler deployment
+      shell: bash
+      run: |
+        echo "::group::Remove existing Kepler deployment before Helm test"
+        make undeploy
+        echo "::endgroup::"
+
+    - name: Test Helm deployment
+      shell: bash
+      run: |
+        echo "::group::Deploy Kepler using Helm"
+        # Update Helm chart to use the locally built image
+        sed -i 's|repository: quay.io/sustainable_computing_io/kepler|repository: localhost:5001/kepler|' manifests/helm/kepler/values.yaml
+        sed -i 's|tag: latest|tag: dev|' manifests/helm/kepler/values.yaml
+        sed -i '/fake-cpu-meter:/{n;s/enabled: false/enabled: true/}' manifests/helm/kepler/values.yaml
+
+        # Install using Helm
+        helm install kepler-helm-test manifests/helm/kepler --namespace kepler-helm --create-namespace --wait --timeout=5m
+        echo "::endgroup::"
+
+    - name: Verify Helm deployment
+      shell: bash
+      run: |
+        echo "::group::Verify Helm deployment"
+        kubectl rollout status daemonset/kepler-helm-test -n kepler-helm --timeout=5m
+        kubectl get pods -n kepler-helm
+        echo "::endgroup::"
+
+    - name: Validate Helm metrics endpoint
+      shell: bash
+      run: |
+        echo "::group::Test Helm deployment metrics"
+        kubectl port-forward service/kepler-helm-test 28283:28282 -n kepler-helm &
+        sleep 20
+
+        HTTP_STATUS=$(curl -s -o /dev/null -w "%{http_code}" http://localhost:28283/metrics)
+        [[ $HTTP_STATUS -ne 200 ]] && echo "Helm deployment HTTP status code is not 200" && exit 1
+
+        echo "Helm deployment metrics endpoint is working"
+        echo "::endgroup::"
+
+    - name: Cleanup Helm deployment
+      shell: bash
+      run: |
+        echo "::group::Cleanup Helm deployment"
+        helm uninstall kepler-helm-test -n kepler-helm
+        kubectl delete namespace kepler-helm
+        echo "::endgroup::"
+
     - name: Run must gather
       shell: bash
       run: |

.github/workflows/release.yaml

@@ -30,6 +30,11 @@ jobs:
           cache: true
           check-latest: true
 
+      - name: Setup Helm
+        uses: azure/setup-helm@v4
+        with:
+          version: latest
+
       - name: Login to Image Registry
         uses: docker/login-action@v3
         with:
@@ -53,6 +58,22 @@ jobs:
           TAG_NAME=${{ github.ref_name }}
           echo "version=$TAG_NAME" >> "$GITHUB_OUTPUT"
 
+      - name: Update Helm Chart Version
+        shell: bash
+        run: |
+          VERSION=${{ steps.version.outputs.version }}
+          # Remove 'v' prefix from version
+          CHART_VERSION=${VERSION#v}
+          # Update Chart.yaml with the release version
+          sed -i "s/^version:.*/version: $CHART_VERSION/" manifests/helm/kepler/Chart.yaml
+          sed -i "s/^appVersion:.*/appVersion: \"$VERSION\"/" manifests/helm/kepler/Chart.yaml
+
+      - name: Package Helm Chart
+        shell: bash
+        run: |
+          mkdir -p helm-releases
+          helm package manifests/helm/kepler -d helm-releases
+
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2
         with:
@@ -61,6 +82,8 @@ jobs:
           generate_release_notes: true
           draft: false
           make_latest: true
+          files: |
+            helm-releases/*.tgz
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

.pre-commit-config.yaml

@@ -28,6 +28,7 @@ repos:
     rev: v1.37.0
     hooks:
       - id: yamllint
+        exclude: ^manifests/helm/.*/templates/.*\.yaml$
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.44.0
@@ -76,3 +77,13 @@ repos:
     hooks:
       - id: shellcheck
         args: [-x]
+
+  - repo: local
+    hooks:
+      - id: helm-lint
+        name: helm-lint
+        entry: helm lint
+        language: system
+        files: ^manifests/helm/[^/]+/(Chart\.yaml|values\.yaml|templates/.*)$
+        pass_filenames: false
+        args: [manifests/helm/kepler]

README.md

@@ -110,7 +110,19 @@ docker-compose up -d
 
 ### 3️⃣ Running on Kubernetes 🐳
 
-Deploy Kepler to your Kubernetes cluster:
+Deploy Kepler to your Kubernetes cluster using Helm or Kustomize:
+
+#### Using Helm Chart (Recommended)
+
+```bash
+# Install using Helm
+helm install kepler manifests/helm/kepler/ \
+  --namespace kepler \
+  --create-namespace \
+  --set namespace.create=false
+```
+
+#### Using Kustomize
 
 ```bash
 # Set up a local development cluster with Kind
@@ -134,6 +146,10 @@ make deploy IMG_BASE=<your registry> VERSION=<your version>
 
 ## 📖 Documentation
 
+- **[Installation Guide](docs/user/installation.md)** - Detailed installation instructions for all deployment methods
+- **[Configuration Guide](docs/configuration/configuration.md)** - Configuration options and examples
+- **[Metrics Documentation](docs/metrics/metrics.md)** - Available metrics and their descriptions
+
 For more detailed documentation, please visit the [official Kepler documentation](https://sustainable-computing.io/kepler/).
 
 ## 🤝 Contributing