feat: Add values json schema (#1110)

Auto-generate json schema for values.yaml

Fixed #1095

---------

Co-authored-by: Joseph Ware <[email protected]>

Author: dan-fernandes

.github/workflows/_test.yml

@@ -53,7 +53,6 @@ jobs:
         with:
           python-version: ${{ inputs.python-version }}
           pip-install: ".[dev]"
-
       - name: Run tests
         run: tox -e tests
 

.github/workflows/_tox.yml

@@ -17,6 +17,9 @@ jobs:
 
       - name: Install python packages
         uses: ./.github/actions/install_requirements
-
+      
+      - name: Install helm plugins
+        run: helm plugin install https://github.com/losisin/helm-values-schema-json.git
+        
       - name: Run tox
         run: tox -e ${{ inputs.tox }}

.pre-commit-config.yaml

@@ -26,7 +26,7 @@ repos:
         require_serial: true
 
   - repo: https://github.com/norwoodj/helm-docs
-    rev:  ""
+    rev: ""
     hooks:
       - id: helm-docs-built
         args:
@@ -37,3 +37,11 @@ repos:
     rev: v8.28.0
     hooks:
       - id: gitleaks
+
+  - repo: https://github.com/losisin/helm-values-schema-json
+    rev: v2.2.1
+    hooks:
+      - id: helm-schema
+        args:
+        - "--config"
+        - "helm/blueapi/.schema.yaml"

Dockerfile

@@ -15,6 +15,7 @@ RUN curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/s
     chmod 700 get_helm.sh; \
     ./get_helm.sh; \
     rm get_helm.sh
+RUN helm plugin install https://github.com/losisin/helm-values-schema-json.git
 
 # Set up a virtual environment and put it in PATH
 RUN python -m venv /venv

helm/blueapi/.schema.yaml

@@ -0,0 +1,24 @@
+# .schema.yaml
+
+# Define input, output and source for $refs relative to repository root for pre-commit
+values:
+  - helm/blueapi/values.yaml
+
+output: helm/blueapi/values.schema.json
+
+bundleRoot: helm/blueapi/
+
+# Include $refs
+bundle: true
+
+# Include comments for the helm-docs plugin into the schema, to allow e.g. documentation in VSCode
+useHelmDocs: true
+
+# Allow additional properties for eg. initResources, different types of volumes/volumeMounts
+noAdditionalProperties: false
+
+schemaRoot:
+  title: Blueapi Helm chart scheam
+  description: Schema to allow validation of values passed to Blueapi Helm chart
+  # No additional properties in schema root for tighter protection:
+  additionalProperties: false

helm/blueapi/README.md

@@ -22,6 +22,7 @@ A Helm chart deploying a worker pod that runs Bluesky plans
 | initContainer | object | `{"enabled":false,"persistentVolume":{"enabled":false,"existingClaimName":""}}` | Configure the initContainer that checks out the scratch configuration repositories |
 | initContainer.persistentVolume.enabled | bool | `false` | Whether to use a persistent volume in the cluster or check out onto the mounted host filesystem If persistentVolume.enabled: False, mounts scratch.root as scratch.root in the container |
 | initContainer.persistentVolume.existingClaimName | string | `""` | May be set to an existing persistent volume claim to re-use the volume, else a new one is created for each blueapi release |
+| initResources | object | `{}` | Override resources for init container. By default copies resources of main container. |
 | livenessProbe | object | `{"failureThreshold":3,"httpGet":{"path":"/healthz","port":"http"},"periodSeconds":10}` | Liveness probe, if configured kubernetes will kill the pod and start a new one if failed consecutively. This is automatically disabled when in debug mode. |
 | nameOverride | string | `""` |  |
 | nodeSelector | object | `{}` | May be required to run on specific nodes (e.g. the control machine) |