Add helm chart including debug features

first pass at helm chart for fastcs instances

fix service name

better port exposure for service.yaml

add helm chart publishing

remove service account creation from helm

switch to using Charts folder with subfolders for charts

add schema for fastcs-instance chart values.yaml

publish chart values schemas

publish chart values schemas

add schema generation to pre-commit

fixing the fastcs-instance chart schema

add debug features to helm chart

repair incorrect helm chart

debug now working

fix non-debug mode

fix incorrect terminationGracePeriodSeconds

add debug entrypoint

move initCommand into values

rename charts to remove "instance"

Author: gilesknap

.github/workflows/_helm.yml

@@ -0,0 +1,71 @@
+name: Package helm charts
+
+on:
+  workflow_call:
+
+env:
+  HELM_VERSION_TO_INSTALL: 3.14.3
+
+jobs:
+  package-helm-charts:
+    name: Package and Push Helm Chart
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install helm
+        uses: Azure/setup-helm@v3
+        with:
+          version: ${{ env.HELM_VERSION_TO_INSTALL }}
+
+      # Check that alpha/beta versions have the form X.Y.Z-alpha.A requried by Helm.
+      # An early check saves waiting for the entire build before finding a problem.
+      - name: Check helm version tag
+        if: ${{ github.ref_type == 'tag' }}
+        env:
+          VERSION: "${{ github.ref_name }}"
+        run: |
+          if [[ "${VERSION}" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-alpha|-beta|-rc).*?$ ]]; then
+              echo "Valid version format: ${VERSION}"
+          else
+              echo "Invalid version: ${VERSION}. Expected: X.Y.Z or X.Y.Z-beta.1 or X.Y.Z-alpha.1"
+              exit 1
+          fi
+
+      - name: Package helm charts
+        env:
+          VERSION: "${{ github.ref_type == 'tag' && github.ref_name || '0.0.0' }}"
+        run: |
+          set -xe
+
+          mkdir -p charts
+          for i in Charts/*; do
+            if [[ ${i} =~ ^.*-ioc$ ]]; then
+              echo "Skipping IOC schema chart: ${i}"
+              continue
+            fi
+            echo "Packaging chart: ${i}"
+            helm package -u --app-version ${VERSION} --version ${VERSION} ${i}
+            mv $(basename ${i})-*.tgz charts/
+          done
+
+      - name: Upload helm chart values schemas
+        uses: actions/upload-artifact@v4
+        with:
+          name: helm-chart-schemas
+          path: schemas/
+
+      - name: Push tagged helm chart to registry
+        if: ${{ github.ref_type == 'tag' }}
+        run: |
+          set -x
+
+          echo "${{ secrets.GITHUB_TOKEN }}" | helm registry login ghcr.io/${{ github.repository_owner }} --username ${{ github.repository_owner }} --password-stdin
+          REGISTRY=oci://ghcr.io/diamondlightsource/charts
+          for i in charts/*.tgz; do
+            helm push "${i}" ${REGISTRY}
+          done

.github/workflows/ci.yml

@@ -44,6 +44,12 @@ jobs:
     if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_dist.yml
 
+  helm:
+    uses: ./.github/workflows/_helm.yml
+    permissions:
+      contents: read
+      packages: write
+
   pypi:
     if: github.ref_type == 'tag'
     needs: dist
@@ -53,7 +59,7 @@ jobs:
 
   release:
     if: github.ref_type == 'tag'
-    needs: [dist, docs]
+    needs: [dist, docs, helm]
     uses: ./.github/workflows/_release.yml
     permissions:
       contents: write

.pre-commit-config.yaml

@@ -1,9 +1,10 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: check-yaml
+        exclude: ^Charts/
       - id: check-merge-conflict
       - id: end-of-file-fixer
 
@@ -22,3 +23,10 @@ repos:
         entry: ruff format --force-exclude
         types: [python]
         require_serial: true
+
+      - id: helm-schema
+        name: Generate Helm schema
+        entry: ./generate-schemas.sh
+        language: system
+        types: [yaml]
+        require_serial: true

Charts/fastcs-ioc/Chart.yaml

@@ -0,0 +1,8 @@
+apiVersion: v2
+name: fastcs-ioc
+version: 0.1.0
+# This chart allows generating a schema for the fastcs-ioc values file.
+# fastcs-ioc schema is used by IOC instances which have fastcs
+# as a dependency.
+#
+# This chart is never used except by helm-schema.