âŦ†ī¸v8->v9

⚠ī¸ tl;dr : breaking change, "defaultConfiguration" in region configuration is not allowed anymore and has been replaced by JSONSchemas override using the new "api.schemas" key from v9 helm chart. ⚠ī¸ Onyxia v9 allows administrators to define custom JSON schemas, allowing them to override the default schemas provided by the chart. Prior to this change, Onyxia relied on providing default values for specific keys in the region configuration : `defaultConfiguration`.

Now, chart owners can define which properties can be overriden with a JSONSchema. Here is an example of a Chart that supports JSONSchemas (taken from the default IDE catalog, seehttps://github.com/InseeFrLab/helm-charts-interactive-services/blob/3f32bcd4fc16ee194782616d0d4634197ec75acb/charts/vscode-python/values.schema.json#L603C5-L612C6) :

values.schema.json
"nodeSelector": {
      "type": "object",
      "description": "NodeSelector",
      "default": {},
      "x-onyxia": {
          "hidden": false,
          "overwriteDefaultWith": "region.nodeSelector",
          "overwriteSchemaWith": "nodeSelector.json"
      }
    }

The "overwriteDefaultWith" attribute is the old way of doing the override, instructing Onyxia to override using the "defaultConfiguration" from Region. This is not supported anymore in v9 (but can be kept for catalog compatibility with v8). "overwriteDefaultWith" has been replaced by "overwriteSchemaWith" which provides more flexibility thanks to JSONSchemas capabilities. Default schemas are bundled with Onyxia-API and will be used if there is no override. See https://github.com/InseeFrLab/onyxia-api/tree/main/onyxia-api/src/main/resources/schemas To override a schema, use the new `schemas` key from the v9 helm chart and provide the list of schemas you want to override. Read more here : https://docs.onyxia.sh/v/v9/admin-doc/catalog-of-services#x-onyxia-overwriteschemawith ⚠ī¸ Onyxia v9 will fail to start with error message "FATAL : Setting defaultConfiguration in region is no longer supported and has been replaced by JSONSchema support. See migration guide at https://docs.onyxia.sh/admin-doc/migration-guides/v8-greater-than-v9" if you don't remove the defaultConfiguration from the region configuration. ⚠ī¸

Last updated