tidy up new schema annotations for charts

Author: gilesknap

.github/workflows/_helm.yml

@@ -56,7 +56,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: helm-chart-schemas
-          path: schemas/
+          path: schemas/*.schema.json
 
       - name: Push tagged helm chart to registry
         # TODO - switch to using https://github.com/helm/chart-releaser-action of maybe the docker action?

.pre-commit-config.yaml

@@ -28,10 +28,20 @@ repos:
     rev: v2.2.1
     hooks:
       - id: helm-schema
-        args: ["--values", "Charts/fastcs/values.yaml", "--no-additional-properties", "-o", "Charts/fastcs/values.schema.json"]
+        args:
+          - --values
+          - Charts/fastcs/values.yaml
+          - --no-additional-properties
+          - -o
+          - Charts/fastcs/values.schema.json
 
   - repo: https://github.com/losisin/helm-values-schema-json
     rev: v2.2.1
     hooks:
       - id: helm-schema
-        args: ["--values", "Charts/fastcs-service/values.yaml", "--bundle", "--no-additional-properties", "-o", "Charts/fastcs-service/values.schema.json"]
+        args:
+          - --values
+          - schemas/fastcs-service-values.yaml
+          - --no-additional-properties
+          - -o
+          - schemas/fastcs-service.schema.json

Charts/fastcs-service/Chart.yaml

@@ -8,41 +8,51 @@
             "additionalProperties": false
         },
         "args": {
+            "description": "command args to pass to the production container",
             "type": "array"
         },
         "autostart": {
+            "description": "editable and autostart are used for debugging and development in-cluster",
             "type": "boolean"
         },
         "baseIp": {
+            "description": "CIDR for services addresses.",
             "type": "string",
             "pattern": "^(\\d{1,3}\\.){3}\\d{1,3}\\/\\d{1,2}$"
         },
         "ca_server_port": {
+            "description": "service port for Channel Access",
             "type": "integer"
         },
         "clusterIP": {
+            "description": "Override for the cluster IP - only needed if allocateIpFromName clashes",
             "type": "null",
             "pattern": "^(\\d{1,3}\\.){3}\\d{1,3}$"
         },
         "command": {
+            "description": "command to run for the production container",
             "type": "array"
         },
         "debugCommand": {
+            "description": "command to run for the debugging (non- autostart) container",
             "type": "array",
             "items": {
                 "type": "string"
             }
         },
         "editable": {
+            "description": "editable and autostart are used for debugging and development in-cluster",
             "type": "boolean"
         },
         "extraContainers": {
             "type": "array"
         },
         "hostNetwork": {
+            "description": "enable host networking for the pod",
             "type": "boolean"
         },
         "image": {
+            "description": "container image URI",
             "type": "object",
             "properties": {
                 "pullPolicy": {
@@ -58,12 +68,14 @@
             "additionalProperties": false
         },
         "initCommand": {
+            "description": "command to run in the init container for editable mode",
             "type": "array",
             "items": {
                 "type": "string"
             }
         },
         "iocConfig": {
+            "description": "path to the location of config folder (defaults to be the same as C++ IOCs)",
             "type": "string"
         },
         "livenessProbe": {
@@ -79,10 +91,12 @@
             "additionalProperties": false
         },
         "podAnnotations": {
+            "description": "Add annotations to the pod",
             "type": "object",
             "additionalProperties": false
         },
         "podLabels": {
+            "description": "Add labels to the pod",
             "type": "object",
             "additionalProperties": false
         },
@@ -92,6 +106,7 @@
             "additionalProperties": false
         },
         "pva_server_port": {
+            "description": "service port for PV Access",
             "type": "integer"
         },
         "readinessProbe": {
@@ -110,6 +125,7 @@
             "additionalProperties": false
         },
         "service": {
+            "description": "The service will be configured for Channel Access and PVA.",
             "type": "object",
             "properties": {
                 "ca_port": {
@@ -128,7 +144,7 @@
             "$ref": "https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration",
             "type": "array"
         },
-        "volumeMount": {
+        "volumeMounts": {
             "$ref": "https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount",
             "type": "array"
         },

Charts/fastcs-service/values.schema.json

@@ -4,25 +4,25 @@
 # With annotations for building the schema using:
 #   https://github.com/losisin/helm-values-schema-json.git
 
-# container image URI
+# @schema description: container image URI
 image:
   repository: ""
   pullPolicy: IfNotPresent
   tag: ""
 
-# command to run for the production container
+# @schema description: command to run for the production container
 command: []
 
-# command args to pass to the production container
+# @schema description: command args to pass to the production container
 args: []
 
-# command to run for the debugging (non- autostart) container
+# @schema description: command to run for the debugging (non- autostart) container
 debugCommand:
   - /bin/bash
   - -c
   - "sleep infinity"
 
-# command to run in the init container for editable mode
+# @schema description: command to run in the init container for editable mode
 initCommand:
   - /bin/bash
   - -c
@@ -40,37 +40,38 @@ initCommand:
     fi
     echo "Init container completed successfully"
 
-# enable host networking for the pod
+# @schema description: enable host networking for the pod
 hostNetwork: true
 
-# editable and autostart are used for debugging and development in-cluster.
-#   editable:
-#     creates a PVC with /venv and /workspaces mounted into the container
-#     runs an init container with entrypoint initCommand above
+# @schema description: editable and autostart are used for debugging and development in-cluster
+#     editable:
+#       creates a PVC with /venv and /workspaces mounted into the container
+#       runs an init container with entrypoint initCommand above
+editable: false
+# @schema description: editable and autostart are used for debugging and development in-cluster
 #   autostart:
 #     false: entrypoint is debugCommand above
 #     true: entrypoint is command above
-editable: false
 autostart: true
 
-# path to the location of config folder (defaults to be the same as C++ IOCs)
+# @schema description: path to the location of config folder (defaults to be the same as C++ IOCs)
 iocConfig: /epics/ioc/config
 
-# service port for Channel Access
+# @schema description: service port for Channel Access
 ca_server_port: 5064
-# service port for PV Access
+# @schema description: service port for PV Access
 pva_server_port: 5075
 
-# CIDR for services addresses.
+# @schema description: CIDR for services addresses.
 #   Used by allocateIpFromName to allocate a fixed cluster IP for the service.
 #   The default is the same for all DLS clusters.
 baseIp: 10.96.0.0/12 # @schema pattern:^(\d{1,3}\.){3}\d{1,3}\/\d{1,2}$
 
-# Override for the cluster IP - only needed if allocateIpFromName clashes
+# @schema description: Override for the cluster IP - only needed if allocateIpFromName clashes
 clusterIP: # @schema pattern:^(\d{1,3}\.){3}\d{1,3}$
 
-# The service will be configured for Channel Access and PVA. Here you can override
-# the ports and also make this a LoadBalancer service if required.
+# @schema description: The service will be configured for Channel Access and PVA.
+#   Here you can override the ports or make this a LoadBalancer service if required.
 service:
   type: ClusterIP
   ca_port: 5064
@@ -99,28 +100,40 @@ service:
 # @schema
 extraContainers: []
 
+# @schema description: Add annotations to the pod
 podAnnotations: {}
 
+# @schema description: Add labels to the pod
 podLabels: {}
 
-podSecurityContext: {} # @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext
+# @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext
+podSecurityContext: {}
 
-securityContext: {} # @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext
+# @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext
+securityContext: {}
 
-resources: {} # @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements
+# @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements
+resources: {}
 
-livenessProbe: {} # @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Probe
+# @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Probe
+livenessProbe: {}
 
-readinessProbe: {} # @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Probe
+# @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Probe
+readinessProbe: {}
 
-volumes: [] # @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Volume
+# @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Volume
+volumes: []
 
-volumeMount: [] # @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount
+# @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount
+volumeMounts: []
 
-# TODO I cant find a way to allow null for nodeSelector but also pass
+# TODO I cant find a way to allow null for nodeSelector but also pass the ref for the object
 # $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.NodeSelector
-nodeSelector: {} # @schema type:[object, null]
+# @schema type:[object, null]
+nodeSelector: {}
 
-tolerations: [] # @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration
+# @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration
+tolerations: []
 
-affinity: {} # @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity
+# @schema $ref: https://kubernetesjsonschema.dev/v1.18.1/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity
+affinity: {}

Charts/fastcs-service/values.yaml

@@ -0,0 +1,18 @@
+# yaml-language-server: $schema=fastcs-service.schema.json
+
+# This yaml file represents the values used in services projects where
+# fastcs is a subchart.
+#
+# It is used to generate the schema for fastcs-service.schema.json
+# which is used to validate the values.yaml files in services projects.
+
+# fast cs schema appears under the subchart fastcs
+# @schema $ref: fastcs-values.schema.json
+fastcs: {}
+
+# Because fastcs and ioc-instance will share the same global values file
+# we must also allow ioc-instance to be defined here but do not use it in
+# fastcs itself.
+#
+# @schema required:false;additionalProperties:true
+ioc-instance: {}

Charts/fastcs/values.schema.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "properties": {
+        "fastcs": {
+            "$ref": "fastcs-values.schema.json",
+            "type": "object",
+            "additionalProperties": false
+        },
+        "ioc-instance": {
+            "type": "object",
+            "additionalProperties": true
+        }
+    },
+    "additionalProperties": false
+}