k0sproject / k0sproject/k0sctl

Feature Request: JSON Schema to validate k0sctl config

Open
#860 3 comments 2 reactions 0 assignees View on GitHub
enhancement
Dominant language
Go
Stars
582
Forks
113
Avg merge
2d 13h
Merged PRs (30d)
34

Description

Hey k0sctl maintainers!

Big fan of the project, I was wondering if you'd be in having a jsonschema (https://json-schema.org/) generated and checked into the repo for the k0sctl.yaml config file.

It has integrations with a lot of tools to validate the structure of the config file and can be used by IDE's for code-completion.

There's a couple of golang libraries / build tools that could generate this for you using the go structs within the codebase: https://json-schema.org/tools?query=&sortBy=name&sortOrder=ascending&groupBy=languages&licenses=&languages=&drafts=&toolingTypes=&environments=&showObsolete=false#go

Would this be of interest to implement?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the Go structs that define the k0sctl.yaml configuration and review the repository's current build or generation entry points. Determine how a JSON Schema could be generated and checked in, then verify that it represents the configuration structure and supports validation and IDE completion.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.