Merge pull request #16 from vidispine/release-1.21

- update HULL to K8S v1.21

Author: gre9ory

azure-pipelines-gated.yml

@@ -45,4 +45,4 @@ jobs:
       - version: "3.4.2"
       #- version: "3.5.0"
       #- version: "3.5.1"
-      - version: "3.5.2"
+      - version: "3.5.3"

azure-pipelines.yml

@@ -45,6 +45,7 @@ jobs:
       - version: "3.5.0"
       - version: "3.5.1"
       - version: "3.5.2"
+      - version: "3.5.3"
 
 - job: CreateRelease
   dependsOn: RunTests

hull/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 name: hull
-version: 1.20.0
-kubeVersion: ">= 1.20.0"
+version: 1.21.0
+kubeVersion: ">= 1.21.0"
 description: HULL - Helm Uniform Layer Library
 type: library
 keywords:
@@ -12,4 +12,4 @@ dependencies: []
 maintainers:
 - name: georg weber
   email: georgmartin.weber@s4m.com
-appVersion: 1.20.0
+appVersion: 1.21.0

hull/README.md

@@ -9,7 +9,7 @@
 - `_objects_base_pod.tpl`: objects that internally use a pod template 
 - `_objects_xyz.tpl`: any other more complex object with array structures that should be converted to dictionaries requires a custom template
 
-[PriorityClass](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#priorityclass-v1-scheduling-k8s-io) is a very simple structure so it can use `_objects_base_plain.tpl`
+[PriorityClass](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#priorityclass-v1-scheduling-k8s-io) is a very simple structure so it can use `_objects_base_plain.tpl`
 
 ### Add to the handled objects in `hull.yaml`
 
@@ -181,7 +181,34 @@ Create a new matching JSON schema in the `kubernetes-json-schema` folder with th
 
 ### Adapt the JSON schema
 
-Copy the `_definition.json` from the newly created schema folder to `values.schema.json` in the `hull` charts root library overwriting the existing content. Compare the `values.schema.json` content with that of the previous release version branch and adapt as need (the complicated part). Consider copying the changes related to the objects that HULL deals with and leave other API changes alone.
+Copy the `_definition.json` from the newly created schema folder to `values.schema.json` in the `hull` charts root library overwriting the existing content. Compare the `values.schema.json` content with that of the previous release version branch and adapt as needed (the complicated part). Consider copying the changes related to the objects that HULL deals with and leave other API changes alone.
+Use a side-by-side tool such as BeyondCompare to do the comparison.
+
+General hints for doing this when starting comparing top to bottom:
+- any block that ends with `.Names` and before that matches one of the Kubernetes API schema elements (typically right below such a block) you copy the block over to the new JSON schema. These blocks are used in the HULL schema to create valid union between K8S properties and HULL properties. For example this block:
+
+  ```yaml
+  "io.k8s.api.apps.v1.StatefulSetSpec.Names": {
+      "enum": [
+        "podManagementPolicy",
+        "replicas",
+        "revisionHistoryLimit",
+        "updateStrategy",
+        "serviceName",
+        "volumeClaimTemplates"
+      ]
+    },
+  ```
+
+- `selector` and `template` elements for top level K8S objects need to be removed from the schema. HULL creates these elements automatically under the hood. If `selector` and `template` are listed under `required` elements remove them from the list as well
+- remove the `"additionalProperties": false` property from the top-level object schema
+- other properties which are part of the merged HULL JSON schema object need to be removed from the Kubernetes object schema, eg. `name`, `env`, `envFrom`, `volumeMounts` and `ports` from the `Container` spec
+- keep text-only changes to descriptions in the new schema
+- keep properties that are added to objects in the new schema which are not handled explicitly by HULL
+- if properties are added to an object which is handled by HULL and has a matching `.Names` block the new property name needs to be added to the `.Names` block
+- added `staticName` properties to objects need to be copied over to the new schema
+- if a top-level object migrates to a new version, you can create an incremented HULL schema object for the new version and reference it in the schema
+
 
 ### Adapt `Chart.yaml`
 

hull/doc/development.md

@@ -6,7 +6,7 @@ The HULL HorizontalPodAutoscaler object allows to reference a chart internal wor
 
 ### The `hull.HorizontalPodAutoscaler.v1` properties
 
-Properties can be set as they are defined in the [Kubernetes API's horizontalpodautoscalerspec spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#horizontalpodautoscalerspec-v1-autoscaling). 
+Properties can be set as they are defined in the [Kubernetes API's horizontalpodautoscalerspec spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#horizontalpodautoscalerspec-v1-autoscaling). 
 
 However the properties listed below are overwritten or added by HULL:
 

hull/doc/objects_horizontalpodautoscaler.md

@@ -6,7 +6,7 @@ The HULL Ingress object offers some comfort features for specifying ingress obje
 
 ### The `hull.Ingress.v1` properties
 
-Properties can be set as they are defined in the [Kubernetes API's ingressspec spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#ingressspec-v1-networking-k8s-io). 
+Properties can be set as they are defined in the [Kubernetes API's ingressspec spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#ingressspec-v1-networking-k8s-io). 
 
 However the properties listed below are overwritten or added by HULL:
 
@@ -19,7 +19,7 @@ However the properties listed below are overwritten or added by HULL:
 
 > The key-value pairs of value type `hull.Ingress.Rule.v1` are converted to an array on rendering
 
-Properties can be set as they are defined in the [Kubernetes API's ingressrule spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#ingressrule-v1-networking-k8s-io). 
+Properties can be set as they are defined in the [Kubernetes API's ingressrule spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#ingressrule-v1-networking-k8s-io). 
 
 However the properties listed below are overwritten or added by HULL:
 
@@ -31,13 +31,13 @@ However the properties listed below are overwritten or added by HULL:
 
 > The key-value pairs of value type `hull.Ingress.Rule.v1` are converted to an array on rendering
 
-Properties can be set as they are defined in the [Kubernetes API's httpingresspath spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#httpingresspath-v1-networking-k8s-io). 
+Properties can be set as they are defined in the [Kubernetes API's httpingresspath spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#httpingresspath-v1-networking-k8s-io). 
 
 ### The `hull.Ingress.Tls.v1` properties
 
 > The key-value pairs of value type `hull.Ingress.Tls.v1` are converted to an array on rendering
 
-Properties can be set as they are defined in the [Kubernetes API's ingresstls spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#ingresstls-v1-networking-k8s-io). 
+Properties can be set as they are defined in the [Kubernetes API's ingresstls spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#ingresstls-v1-networking-k8s-io). 
 
 However the properties listed below are overwritten or added by HULL:
 

hull/doc/objects_ingress.md

@@ -18,7 +18,7 @@ So for all HULL based objects, the pod specific information is wrapped like this
 
 ### The `hull.Pod.v1` properties
 
-Properties can be set as they are defined in the [Kubernetes API's pod spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#podspec-v1-core).
+Properties can be set as they are defined in the [Kubernetes API's pod spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#podspec-v1-core).
 
 However the properties listed below are overwritten or added by HULL:
 
@@ -34,7 +34,7 @@ However the properties listed below are overwritten or added by HULL:
 
 > The `name` property of the container is derived from the key.
 
-Properties can be set as they are defined in the [Kubernetes API's container spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#container-v1-core). 
+Properties can be set as they are defined in the [Kubernetes API's container spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#container-v1-core). 
 
 However the properties listed below are overwritten or added by HULL:
 
@@ -62,7 +62,7 @@ Definition of container images is split into multiple parts to allow better supp
 
 > The `name` property of the environment variable is derived from the key.
 
-Properties can be set as they are defined in the [Kubernetes API's envvar spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#envvar-v1-core). 
+Properties can be set as they are defined in the [Kubernetes API's envvar spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#envvar-v1-core). 
 
 However the properties listed below are overwritten or added by HULL:
 
@@ -75,7 +75,7 @@ However the properties listed below are overwritten or added by HULL:
 
 > The key-value pairs of value type `hull.EnvFrom.v1` are converted to an array on rendering
 
-Properties can be set as they are defined in the [Kubernetes API's envfromsource spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#envfromsource-v1-core). 
+Properties can be set as they are defined in the [Kubernetes API's envfromsource spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#envfromsource-v1-core). 
 
 However the properties listed below are overwritten or added by HULL:
 
@@ -90,21 +90,21 @@ However the properties listed below are overwritten or added by HULL:
 
 > The `name` property of the container's port is derived from the key.
 
-Properties can be set as they are defined in the [Kubernetes API's containerport spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#containerport-v1-core). 
+Properties can be set as they are defined in the [Kubernetes API's containerport spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#containerport-v1-core). 
 
 ### The `hull.VolumeMount.v1` properties
 
 > The key-value pairs of value type `hull.VolumeMount.v1` are converted to an array on rendering 
 
-Properties can be set as they are defined in the [Kubernetes API's volumemount spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#volumemount-v1-core). 
+Properties can be set as they are defined in the [Kubernetes API's volumemount spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#volumemount-v1-core). 
 
 ### The `hull.Volume.v1` properties
 
 > The key-value pairs of value type `hull.Volume.v1` are converted to an array on rendering
 
 > The `name` property of the volume is derived from the key.
 
-Properties can be set as they are defined in the [Kubernetes API's volume spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#volume-v1-core). 
+Properties can be set as they are defined in the [Kubernetes API's volume spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#volume-v1-core). 
 
 However the properties listed below are overwritten or added by HULL:
 

hull/doc/objects_pod.md

@@ -6,7 +6,7 @@ The HULL Service object is a thin wrapper around the Kubernetes Service providin
 
 ### The `hull.Service.v1` properties
 
-Properties can be set as they are defined in the [Kubernetes API's service spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#service-v1-core). 
+Properties can be set as they are defined in the [Kubernetes API's service spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#service-v1-core). 
 
 However the properties listed below are overwritten or added by HULL:
 

hull/doc/objects_service.md

@@ -6,7 +6,7 @@ The HULL Webhook objects allows to reference a chart internal webhook by simple
 
 ### The `hull.MutatingWebhook.v1` properties
 
-Properties can be set as they are defined in the [Kubernetes API's mutatingwebhookconfiguration spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#mutatingwebhookconfiguration-v1-admissionregistration-k8s-io). 
+Properties can be set as they are defined in the [Kubernetes API's mutatingwebhookconfiguration spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#mutatingwebhookconfiguration-v1-admissionregistration-k8s-io). 
 
 However the properties listed below are overwritten or added by HULL:
 
@@ -18,12 +18,12 @@ However the properties listed below are overwritten or added by HULL:
 
 > The key-value pairs of value type `hull.MutatingWebhook.Webhook.v1` are converted to an array on rendering
 
-Properties can be set as they are defined in the [Kubernetes API's mutatingwebhook spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#mutatingwebhook-v1-admissionregistration-k8s-io). 
+Properties can be set as they are defined in the [Kubernetes API's mutatingwebhook spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#mutatingwebhook-v1-admissionregistration-k8s-io). 
 
 
 ### The `hull.ValidatingWebhook.v1` properties
 
-Properties can be set as they are defined in the [Kubernetes API's validatingwebhookconfiguration spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#validatingwebhookconfiguration-v1-admissionregistration-k8s-io). 
+Properties can be set as they are defined in the [Kubernetes API's validatingwebhookconfiguration spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#validatingwebhookconfiguration-v1-admissionregistration-k8s-io). 
 
 However the properties listed below are overwritten or added by HULL:
 
@@ -35,7 +35,7 @@ However the properties listed below are overwritten or added by HULL:
 
 > The key-value pairs of value type `hull.ValidatingWebhook.Webhook.v1` are converted to an array on rendering
 
-Properties can be set as they are defined in the [Kubernetes API's validatingwebhook spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#validatingwebhook-v1-admissionregistration-k8s-io). 
+Properties can be set as they are defined in the [Kubernetes API's validatingwebhook spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#validatingwebhook-v1-admissionregistration-k8s-io). 
 
 ---
 Back to [README.md](./../README.md)