Support multiple ressources with different schemas in kubernetes files

[redhat-developer]

Support multiple ressources with different schemas in kubernetes files

[andxu]

#81

[JPinkney]

Can you post the YAML? That isn't actually an error per se its just saying there are multiple sub schemas inside of the Kubernetes schema it matches so therefore it doesn't know which one to verify against.

[victornoel]

@JPinkney here is one:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: app
spec:
  selector:
    matchLabels:
      app: app
  replicas: 1
  template:
    metadata:
      labels:
        app: app
    spec:
      containers:
        - name: app
          image: nginx
      volumes:
        - name: config-volume
          configMap:
            name: app-config
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: app-config
data:
  config: some config

Let's call it a feature request then: the editor should be able to apply the schema up to the next --- :)

[JPinkney]

Which version of the language server are you using (or the version of VSCode-YAML if you're using that)? If you aren't using VSCode-YAML which code editor/IDE are you using? It doesn't get that error on my side so I'm not sure if its version difference or something else.

[victornoel]

@JPinkney I am using the latest version of the vscode plugin available in the vscode extension store: 0.0.14.

I realise it isn't the latest according to github but I have no idea how to update except waiting for it to be available on the extension store.

[victornoel]

hm actually, I'm confusing the repository for the extension and the repository for the language server: the extension is the latest, but I don't know which version of the language server it is using… maybe not the latest

[JPinkney]

If you're using VSCode 0.0.14 then its using the latest available version of the yaml language server. However, for some reason I cannot reproduce so I'm going to try and see if I can reproduce on a few co-workers machines.

Which OS are you using? and which VSCode version? Maybe those will help narrow it down.

[victornoel]

It is vscode 1.25.1 on an up to date archlinux.
If I can do something don't hesitate.

[JPinkney]

Hmm, my co-worker and I are on Fedora and we do not get the error with that yaml for some reason. I'll probably need you to do a few things if you don't mind.

First, I'll need your yaml preferences from VSCode and then I'll need you to set yaml.trace.server to be verbose (Basically it just shows all the language server/client request logs). Then you should be able to see the logs in the output tab and then the YAML Support output tab inside of that. Then can you paste your log from that? I think that will help get to the bottom of it!

[victornoel]

Here are my settings (they are all defaults):

  // Configure editor settings to be overridden for [yaml] language.
  "[yaml]": {
    "editor.insertSpaces": true,
    "editor.tabSize": 2,
    "editor.quickSuggestions": {
      "other": true,
      "comments": false,
      "strings": true
    },
    "editor.autoIndent": false
  },

  // Custom tags for the parser to use
  "yaml.customTags": [],

  // Enable/disable default YAML formatter (requires restart)
  "yaml.format.enable": false,

  // Associate schemas to Yaml files in the current workspace
  "yaml.schemas": {},

  // Traces the communication between VSCode and the languageServerExample service.
  "yaml.trace.server": "off",

  // Enable/disable validation feature
  "yaml.validate": true

Here are the logs when I open the file: https://gist.github.com/victornoel/3f1ca3ef85cbd15e92f45f619dff6009

And here are the logs when I open vscode and the file (so there is a lot): https://gist.github.com/victornoel/b44b5fc74f26ab045390ddf912b24870

[JPinkney]

Ah are you by any chance using https://github.com/Azure/vscode-kubernetes-tools? (Or some other kubernetes extension that depends on this language server)

[victornoel]

@JPinkney good point, I am indeed using this extension (ms-kubernetes-tools.vscode-kubernetes-tools).

If I disable it, there are no errors, but I don't feel like validation is doing anything, for example if I use a string for the value of replicas in the example above, the editor does not complain about it.
If I do the same in a file containing only the Deployment of the example above, an error is shown to tell me I should input an integer there.

Am I correct in understanding that it is the kubernetes extension that actually takes care of validation and schema related behaviour?

[JPinkney]

if I disable it, there are no errors, but I don't feel like validation is doing anything, for example if I use a string for the value of replicas in the example above, the editor does not complain about it.

Thats because by default VSCode-YAML doesn't attach a schema to the current file you're editing so it doesn't have contextual awareness of what is going on. Rather, it just has basic validation stuff. If you want to attach a schema you can look here and the validation stuff will be there.

Am I correct in understanding that it is the kubernetes extension that actually takes care of validation and schema related behaviour?

The kubernetes extension has an end point where they can programmically set the schemas inside the yaml language server. So the yaml-language-server takes care of handling the schemas whereas the kubernetes extension takes care of adding the schemas (but anyone can also add schemas manually themselves using the yaml.schemas setting). However, I think this means the reason you're getting the error above (matching mulitple schemas) is because the piece of YAML you wrote matches two of the schemas they added and thus doesn't know which one to validate against. I don't think there is anything I can do from my side because its an issue with the schemas, the yaml language server just throws the error to let the user know.

[victornoel]

@JPinkney ok, so I will open an issue there and close this one once I'm sure there is nothing that is needed to be done here to make the whole works :)
thanks again for your patience!

[victornoel]

See vscode-kubernetes-tools/vscode-kubernetes-tools#341 :)

[andxu]

@victornoel @JPinkney The problems are caused by the differences between json and yaml document: one json file only has one document while one yaml file can have multiple documents, in this case(multiple document), the current behavior for k8s schema provider is to provide anyOf [Deployment, ConfigMap] for the specified yaml, this works well if no validation problems/errors found, but if any errors are founded, for example the second ConfigMap has some validation errors, then the yaml-languange-server will not be able to detect which schema is actually chosen since both [Deployment, ConfigMap] schema is not acceptable, and it will use the first one Deployment to report the errors. The solution to this scenario is to notice the getSchemaForResource may return an Array if multiple documents are detected rather than the tricky anyOf schema to represent multiple documents, I am preparing for the PR.

[andxu]

https://github.com/redhat-developer/yaml-language-server/pull/81/files

[victornoel]

@andxu cool, glad to see the solution was easy :)

[JPinkney]

This has been fixed by @andxu and a new version of VSCode-YAML and yaml-language-server have been released.