Feat: updated helm shared workflow for kubediagram (#208)

Author: kalyani-cd

.github/workflows/helm.yml

@@ -78,6 +78,17 @@ on:
         type: number
         default: 900
         description: 'The assumed role duration in seconds, if assuming a role. Defaults to 1 hour.'
+      diagram-file-name:
+        required: false
+        type: string
+        default: diagram.png
+        description: 'Optional output diagram file name for kube-diagrams'
+      generate-diagram:
+        required: false
+        type: boolean
+        default: false
+        description: 'Set to true to generate KubeDiagram from Helm templates'
+
     secrets:
       AWS_ACCESS_KEY_ID:
         description: 'AWS Access Key ID'
@@ -157,6 +168,26 @@ jobs:
         run: |
           helm template ${{ inputs.helm-chart-directory }} -f ${{ inputs.values-file-path }}
 
+      - name: Install Graphviz & KubeDiagrams
+        if: ${{ inputs.generate-diagram == true }}
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y graphviz
+          pip install git+https://github.com/philippemerle/KubeDiagrams.git
+
+      - name: Generate Helm template and KubeDiagram
+        if: ${{ inputs.generate-diagram == true }}
+        run: |
+          helm template ${{ inputs.helm-chart-directory }} --namespace ${{ inputs.namespace }} -f ${{ inputs.values-file-path }} \
+          | kube-diagrams -o "${{ inputs.diagram-file-name }}" -
+
+      - name: Upload Diagram Artifact
+        if: ${{ inputs.generate-diagram == true }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: helm-diagram
+          path: ${{ inputs.diagram-file-name }}
+
       - name: helm install and upgrade
         if: ${{ inputs.rollback != true && inputs.uninstall != true }}
         run: |
@@ -168,11 +199,26 @@ jobs:
               --history-max ${{ inputs.history-max }} --atomic --wait --debug --timeout ${{ inputs.timeout }}
           fi
 
-      - name: Rollback Helm Release
+      - name: Helm Rollback
         if: ${{ inputs.rollback == true && inputs.uninstall != true }}
         run: |
-          export HISTORY_COUNT=$(helm history ${{ inputs.release-name }} -n ${{ inputs.namespace }} | head -2 | tail -1 | awk '{print $1}')
-          helm rollback ${{ inputs.release-name }} -n ${{ inputs.namespace }} ${{ inputs.revision }} --debug || ( echo "Valid revision values can be greater than or equal to $HISTORY_COUNT" && exit 1 )
+          echo "⏪ Attempting rollback of release: ${{ inputs.release-name }} to revision ${{ inputs.revision }}"
+
+          REVISION=${{ inputs.revision }}
+          REV_STATUS=$(helm history ${{ inputs.release-name }} -n ${{ inputs.namespace }} | awk -v rev="$REVISION" '$1 == rev {print $4}')
+
+          if [ -z "$REV_STATUS" ]; then
+          echo "❌ Revision $REVISION does not exist."
+          exit 1
+          fi
+
+          if [ "$REV_STATUS" = "failed" ] || [ "$REV_STATUS" = "pending" ]; then
+          echo "⚠️ Revision $REVISION exists but has status '$REV_STATUS'. Cannot roll back to it."
+          exit 1
+          fi
+
+          helm rollback ${{ inputs.release-name }} -n ${{ inputs.namespace }} $REVISION --debug
+
 
       - name: Uninstall Helm Release
         if: ${{ inputs.uninstall == true }}

docs/helm.md

@@ -10,6 +10,7 @@ To use the helm Workflow, add the following workflow definition to your `.github
 
 ```yaml
 name: Helm Workflow AWS
+
 on:
   workflow_dispatch:
     inputs:
@@ -18,29 +19,36 @@ on:
         type: choice
         description: Select Environment name
         options:
-          -            # This option is blank beacause we did not given name to helm deploy or you can give this name eg. deploy
-          - rollback   # GitHub manual workflow trigger with environment selection for rollback
+          -          # Leave blank to trigger deploy
+          - rollback # Select to trigger rollback
+
 jobs:
   aws:
     uses: clouddrove/github-shared-workflows/.github/workflows/helm.yml@master
     secrets:
-      BUILD_ROLE: # AWS OIDC role for aws authentication
+      BUILD_ROLE:                             # AWS OIDC role for authentication
+      AWS_ACCESS_KEY_ID:                      # AWS access key
+      AWS_SECRET_ACCESS_KEY:                  # AWS secret key
+      AWS_SESSION_TOKEN:                      # AWS session token (optional)
+      set-parameters:                         # Optional Helm overrides, e.g., --set image.tag=latest
+
     with:
-      provider: # aws 
-      aws-region: # AWS region 
-      eks-cluster-name: # EKS cluster name 
-      release-name: # Helm chart realease name
-      helm-chart-directory: # Helm chart directory from repo
-      # Set parameter is optionals below format support set parameter
-      set-parameters:
-       # --set image.tag=latest
-       # --set replicaCount=3
-       # --set service.type=LoadBalancer
-      timeout: # Timeout in seconds default values is 120s
-      values-file-path: #Values file path
-      history-max: # Revision history deafault values is 7
-      namespace: # Namespace 
-      rollback: ${{ github.event.inputs.environment }}  # Mandetory input do not change this 
+      provider: aws                           # Cloud provider: 'aws'
+      eks-cluster-name: <EKS cluster name>    # Name of the Amazon EKS cluster
+      aws-region: <AWS region>                # AWS region, e.g., 'us-east-1'
+      helm-chart-directory: <chart path>      # Directory where your Helm chart is located
+      release-name: <release name>            # Unique name for Helm release
+      timeout: <timeout in seconds>           # Max wait time for Helm operations, e.g., '600s'
+      values-file-path: <values file path>    # Path to Helm values.yaml file
+      history-max: <revision count>           # Number of revisions to retain in history
+      namespace: <namespace>                  # Kubernetes namespace to deploy into
+      dependencies: <true|false>              # Install chart dependencies (true/false)
+      uninstall: <true|false>                 # Set to true to uninstall the release
+      rollback: <true|false>                  # <true|false> Trigger rollback to previous revision (true/false)
+      revision: <revision number>             # Specific revision to roll back to
+      diagram-file-name: <output file name>   # Optional: output file name for KubeDiagram PNG
+      generate-diagram : <true|false>         # <true|false> Set to true to generate a visual KubeDiagram from Helm templates
+
 ```
 
 #### Example for Azure cloud provider