clusterctl config schema

Print the JSON Schema of a configuration kind

Synopsis

Print the JSON Schema an editor needs to check and complete a configuration file. Point the YAML language server at it with a comment at the top of the file:

yaml-language-server: $schema=./site.schema.json

Without an argument every kind is printed as one object keyed by kind.

clusterctl config schema [KIND] [flags]

Options

  -h, --help   help for schema

Options inherited from parent commands

      --config strings      configuration file or directory to read, repeatable (default: CLUSTERCTL_CONFIG or the search path)
      --context string      context to act on (default: the current one)
      --dry-run             report what would be done and change nothing
      --fanout int          how many hosts to work on at once, at least 1 (default: from the configuration)
      --force               allow protected hosts, and nodes the inventory does not know, to be touched
  -n, --nodes stringArray   node set to act on, for example 'exe[1-10],@rack:R02' (default: CLUSTERCTL_NODES)
  -o, --output string       output format: table, wide, json, yaml, nodeset, name, jsonpath=, jq= (default "table")
      --set stringArray     override one configuration value as PATH=VALUE, repeatable
  -y, --yes                 answer the confirmation prompts with yes

clusterctl config schema

clusterctl config schema

Synopsis

yaml-language-server: $schema=./site.schema.json

Options

Options inherited from parent commands

SEE ALSO