Skip to content

Editor integration

KPOps provides JSON schemas that enable autocompletion and validation for all YAML files that the user must work with.

Supported files

Usage

  1. Install the yaml-language-server in your editor of choice. (requires LSP support)
  2. Configure the extension with the settings below.
settings.json 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
    "yaml.schemas": {
        "https://bakdata.github.io/kpops/3.0/schema/pipeline.json": [
            "pipeline.yaml",
            "pipeline_*.yaml"
        ],
        "https://bakdata.github.io/kpops/3.0/schema/defaults.json": [
            "defaults.yaml",
            "defaults_*.yaml"
        ],
        "https://bakdata.github.io/kpops/3.0/schema/config.json": [
            "config.yaml",
            "config_*.yaml"
        ]
    }
}

Advanced usage

It is possible to generate schemas with the kpops schema command. Useful for including custom components or when using a pre-release version of KPOps.