Merge pull request #4 from RS-PYTHON/feat/doc-helm

Feat/doc helm

.github/workflows/doc-helm.yaml

@@ -0,0 +1,36 @@
+name: Generate Helm documentation
+on:
+  - pull_request
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        ref: ${{ github.event.pull_request.head.ref }}
+
+    - name: Get the rs-server version tag
+      id: get_version
+      shell: bash
+      run: |
+        # Enable pipefail so git command failures do not result in null versions downstream
+        set -x
+
+        echo "RSSERVER_VERSION=$(\
+            git ls-remote --tags --refs --sort="v:refname" \
+            https://github.com/RS-PYTHON/rs-server.git 'v*.*' | tail -n1 | sed 's/.*\///' | sed 's/^v//' | cut -d '.' -f 1 \
+        )" >> $GITHUB_OUTPUT
+        echo "SHA_SHORT=$(git rev-parse --short "$GITHUB_SHA")" >> $GITHUB_OUTPUT
+
+    - name: Update version number in chart.yaml
+      shell: bash
+      run: |
+        for chart in $(find charts -name Chart.yaml); do
+        sed -i "s,{{CHART_VERSION}},${{ steps.get_version.outputs.RSSERVER_VERSION }}.0.0-${{ steps.get_version.outputs.SHA_SHORT }}," $chart
+        done
+
+    - name: Run helm-docs
+      uses: losisin/helm-docs-github-action@v1
+      with:
+        git-push: true

charts/mockup-station-adgs/values.yaml

@@ -1,42 +1,77 @@
+# -- Namespace for the deployment
 namespace: processing
 
+# -- Number of replicas for the deployment
 replicaCount: 1
 
+# -- Configuration for the service
 service:
+  # -- Port for the service
   port: 8080
 
+# -- Configuration for the application
 app:
+  # -- Port for the application
   port: 5000
+  # -- Working directory for the application
   workDir: /app
+  # -- Config directory for the application
   confDir: /opt/adgs/config
+  # -- Auth file configuration for the application
   authConfigFile: auth.json
 
+# -- Kubernetes probes configuration
 probe:
+  # -- Liveness probe configuration
   liveness:
+    # -- Path for the liveness probe
     path: /health
+    # -- Port for the liveness probe
     port: 5000
+    # -- InitialDelaySeconds for the liveness probe
     initialDelaySeconds: 30
+    # -- periodSeconds for the liveness probe
     periodSeconds: 30
+    # -- timeoutSeconds for the liveness probe
     timeoutSeconds: 5
+  # -- Readiness probe configuration
   readiness:
+    # -- Path for the readiness probe
     path: /health
+    # -- Port for the readiness probe
     port: 5000
+    # -- InitialDelaySeconds for the readiness probe
     initialDelaySeconds: 30
+    # -- periodSeconds for the readiness probe
     periodSeconds: 30
+    # -- timeoutSeconds for the readiness probe
     timeoutSeconds: 5
 
+# -- Image details
 image:
+  # -- Image registry
   registry: ghcr.io
+  # -- Image repository
   repository: rs-python
+  # -- Image name
   name: rs-testmeans_adgs-station-mock
+  # -- Image tag version
   tag: latest
+  # -- Image pull policy
   PullPolicy: Always
   #imagePullSecrets: regcred
 
+# -- Pod resources details
 resources:
-  request: 
+  # -- Pod request resources details
+  request:
+    # -- Pod memory request
     ram: "256Mi"
+    # -- Pod CPU request
     cpu: "100m"
+  # -- Pod limit resources details
   limit:
+    # -- Pod memory limit
     ram: "1000Mi"
+    # -- Pod CPU limit
     cpu: "500m"