feat: Add values json schema

.github/workflows/_test.yml

@@ -53,6 +53,9 @@ jobs:
         with:
           python-version: ${{ inputs.python-version }}
           pip-install: ".[dev]"
+
+      - name: Install helm plugins
+        run: helm plugin install https://github.com/losisin/helm-values-schema-json.git
 
       - 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

@@ -7,6 +7,7 @@ repos:
         exclude: ^helm\/.*\/templates\/.*|catalog-info.yaml
       - id: check-merge-conflict
       - id: end-of-file-fixer
+        exclude: "helm\/blueapi\/README.md"
 
   - repo: local
     hooks:
@@ -25,9 +26,15 @@ repos:
         require_serial: true
 
   - repo: https://github.com/norwoodj/helm-docs
-    rev:  ""
+    rev: ""
     hooks:
       - id: helm-docs-built
         args:
           # Make the tool search for charts only under the `helm` directory
           - --chart-search-root=helm
+
+  - repo: https://github.com/losisin/helm-values-schema-json
+    rev: v1.7.2
+    hooks:
+      - id: helm-schema
+        args: ["--values", "helm/blueapi/values.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,22 @@
+# .schema.yaml
+
+values:
+  - values.yaml
+
+draft: 2020
+indent: 4
+output: values.schema.json
+
+bundle: true
+bundleRoot: .
+bundleWithoutID: false
+
+useHelmDocs: false
+
+noAdditionalProperties: false
+
+schemaRoot:
+  id: https://example.com/schema
+  title: Helm Values Schema
+  description: Schema for Helm values
+  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) |