Merge pull request #2306 from vprashar2929/ci-prof-bm

ci: run profiling workflow on self-hosted runner

Author: Sunil Thaha

.github/workflows/k8s-bm.yaml

@@ -1,6 +1,6 @@
 name: Build and Deploy K8s on Self Hosted BM
 
-on: #yamllint disable-line rule:truthy
+on: # yamllint disable-line rule:truthy
   pull_request:
 
 permissions:
@@ -30,12 +30,12 @@ jobs:
               - '.github/workflows/k8s-bm.yaml'
 
   build-and-deploy:
-    # NOTE: In case of self-hosted runners, tools like docker, make, kubectl etc. are installed at the time of setting up the runner.
-    # Hence, we don't need to install them as part of the job.
     needs: [check-changes]
     if: needs.check-changes.outputs.changes == 'true'
     runs-on: self-hosted
     steps:
+      # NOTE: In case of self-hosted runners, tools like docker, make, kubectl etc. are installed at the time of setting up the runner.
+      # Hence, we don't need to install them as part of the job.
       - name: Checkout source
         uses: actions/checkout@v5
         with:

.github/workflows/profiling.yaml

@@ -1,5 +1,5 @@
 name: Profiling Report
-on:
+on: # yamllint disable-line rule:truthy
   pull_request:
 
 jobs:
@@ -26,25 +26,10 @@ jobs:
   profiling:
     needs: check-changes
     if: needs.check-changes.outputs.changes == 'true'
-    runs-on: ubuntu-latest
+    runs-on: self-hosted
     steps:
-      - name: Install Docker
-        shell: bash
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common
-          curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
-          echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list
-          sudo apt-get update
-          sudo apt-get install -y docker-ce docker-ce-cli containerd.io
-          sudo usermod -aG docker $USER
-
-      - name: Verify Docker installation
-        shell: bash
-        run: |
-          docker ps
-          docker --version
-
+      # NOTE: In case of self-hosted runners, tools like docker, make, kubectl etc. are installed at the time of setting up the runner.
+      # Hence, we don't need to install them as part of the job.
       - name: Checkout source
         uses: actions/checkout@v5
         with:
@@ -59,13 +44,6 @@ jobs:
       - name: Install pprof
         run: go install github.com/google/pprof@latest
 
-      - name: Enable fake cpu meter
-        shell: bash
-        run: |
-          sed -i '/fake-cpu-meter:/{n;s/enabled: false/enabled: true/}' \
-            compose/dev/kepler-dev/etc/kepler/config.yaml \
-            compose/dev/kepler-latest/etc/kepler/config.yaml
-
       - name: Run Docker Compose services
         shell: bash
         working-directory: compose/dev
@@ -122,6 +100,22 @@ jobs:
           path: ./tmp/*
           retention-days: 5 # Keep artifact for 5 days
 
+      # NOTE: Ensure that all deployments, built images and cluster are properly cleaned up
+      # to prevent residual resources
+      - name: Shutdown Docker Compose services
+        if: always()
+        shell: bash
+        working-directory: compose/dev
+        run: |
+          # Stop kepler-dev and kepler-latest services
+          docker compose down kepler-dev kepler-latest --volumes
+
+      - name: Cleanup Docker images
+        if: always()
+        shell: bash
+        run: |
+          docker image prune -af
+
   generate-comment-message:
     needs: profiling
     if: needs.profiling.result == 'success'

docs/developer/assets/profiling.png

@@ -25,13 +25,11 @@ end
 == Job: profiling ==
 note right of Runner: Needs check-changes;\nRuns if changes == 'true'
 group Environment Setup
-    Runner -> Runner: Install and Verify Docker
     Runner -> Runner: Checkout source code
     Runner -> Runner: Setup Go environment
     Runner -> Runner: Install pprof
 end
 group Profiling Execution
-    Runner -> Runner: Enable fake CPU meter in configs
     Runner -> Runner: Run Docker Compose services\n(build and start kepler-dev/latest in detach mode)
     Runner -> Runner: Run must-gather (always)\n(collect logs, metrics, etc.)
     Runner -> Runner: Sleep for 10 seconds