Generate JSON schemas for the configuration objects by kke · Pull Request #267 · k0sproject/rig

kke · 2025-05-23T08:21:14Z

This is a requirement for k0sproject/k0sctl#860

a1994sc · 2026-03-30T22:58:26Z

Hey @kke, is there any chance of getting this into the v0 branch?

kke · 2026-05-04T08:15:50Z

Hey @kke, is there any chance of getting this into the v0 branch?

I haven't tried to use it at all so I have no clue if it works or if it's useful.

a1994sc · 2026-05-04T10:55:36Z

Hey @kke, is there any chance of getting this into the v0 branch?

I haven't tried to use it at all so I have no clue if it works or if it's useful.

Well I created #327 to help get it merged in, mostly that PR addresses the linting issues... I did lean on //nolint for a few things as I didn't want to change too much of the code base.

Signed-off-by: Kimmo Lehto <klehto@mirantis.com>

- Add sentinel errors and wrap external errors (err113, wrapcheck) - Handle unchecked error returns in examples (errcheck) - Fix import ordering in resolver.go (gci) - Define osWindows constant to replace repeated literals (goconst) - Remove duplicate package doc in os/linux/ubuntu.go (godoclint) - Add nolint comments for intentional gosec patterns (G702, G115) - Apply modernize suggestions: maps.Copy, slices.Contains, WaitGroup.Go, string concatenation over fmt.Sprintf, slice preallocation, build tags - Add nolint for noctx on long-running SSH processes - Add missing doc comments for exported symbols (revive) - Add package comments to example programs (revive) - Migrate examples/password from deprecated terminal to golang.org/x/term - Remove unnecessary type conversion in examples/password (unconvert) - Rename short variable names in examples (varnamelen) Signed-off-by: Kimmo Lehto <klehto@mirantis.com>

Signed-off-by: Kimmo Lehto <klehto@mirantis.com>

…bility

Copilot

Pull request overview

Adds a JSON Schema generation workflow for rig connection configuration structs (SSH/OpenSSH/WinRM/Localhost), enabling downstream projects (e.g., k0sctl) to validate and offer editor support for configs.

Changes:

Annotates connection config structs with json/jsonschema metadata and introduces a schema generator tool.
Adds generated JSON/YAML schema artifacts under schemas/ and enforces consistency in CI.
Includes a set of small refactors/cleanups (string building, error wrapping, command construction, comments).

Reviewed changes

Copilot reviewed 35 out of 37 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
winrm.go	Adds JSON + jsonschema tags and field docs for WinRM config.
ssh.go	Adds JSON + jsonschema tags for SSH config; minor refactors.
openssh.go	Adds JSON + jsonschema tags for OpenSSH config; minor refactors and lints.
localhost.go	Adds JSON + jsonschema tags for Localhost config; adds nolint notes.
connection.go	Adds JSON tags to embedded connection configs; small comment/lint updates.
resolver.go	Minor doc/format tweaks; uses constant for Windows ID.
resolver_test.go	Minor formatting changes.
signals.go	Removes legacy build tag; adds guards around terminal size values.
errors.go	Re-documents exported sentinel errors without inline trailing comments.
pkg/rigfs/withname.go	Improves const docs for operation names.
pkg/rigfs/winfsys.go	Replaces `fmt.Sprintf` with concatenation for command strings.
pkg/rigfs/posixfsys.go	Fixes option slice construction; replaces `fmt.Sprintf` with concatenation for commands.
os/windows/windows2019.go	Uses a constant for Windows OS ID in matcher.
os/windows.go	Replaces `fmt.Sprintf` with concatenation for command strings.
os/linux.go	Replaces some `fmt.Sprintf` usages with concatenation.
os/linux/ubuntu.go	Removes redundant package comment (still present elsewhere in package).
os/registry/registry.go	Exports OS module builder function type; doc tweaks.
connection_test.go	Formatting-only adjustments for mock client methods.
internal/jsonschema/gen_schema.go	Adds schema generation CLI (JSON/YAML output).
internal/jsonschema/go.mod	Introduces a separate module for schema generation tool.
internal/jsonschema/go.sum	Adds dependency lockfile for schema generation tool.
internal/jsonschema/Makefile	Adds targets to generate schema files into `/schemas`.
schemas/ssh.json	Generated JSON schema for SSH config.
schemas/ssh.yaml	Generated YAML schema for SSH config.
schemas/openssh.json	Generated JSON schema for OpenSSH config.
schemas/openssh.yaml	Generated YAML schema for OpenSSH config.
schemas/winrm.json	Generated JSON schema for WinRM config.
schemas/winrm.yaml	Generated YAML schema for WinRM config.
schemas/localhost.json	Generated JSON schema for Localhost config.
schemas/localhost.yaml	Generated YAML schema for Localhost config.
Makefile	Adds `make schemas` wrapper target.
.github/workflows/golangci-lint.yaml	Adds CI step to verify generated schemas are up-to-date.
examples/upload/upload.go	Improves variable names and error wrapping.
examples/password/password.go	Updates password prompt to use `golang.org/x/term`.
examples/os/stock/stock.go	Improves error wrapping and variable names.
examples/logging/logging.go	Avoids ignoring returned errors silently by assigning to `_`.
examples/confirmation/confirmation.go	Improves variable naming and avoids ignoring returned errors silently.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Add anyOf hostname/ipv4/ipv6 constraint for address fields in SSH and WinRM schemas - Skip address format constraint for OpenSSH (accepts ssh_config aliases) - Add const:true constraint for Localhost.enabled field - Make SSH User and Port optional in schema (both have runtime defaults) - Add omitempty to optional WinRM boolean/int fields so they are not required - Update CI workflow to trigger on schema and jsonschema generator changes - Fix empty const block in resolver_test.go - Fix trailing quote in connection.go comment

Validates required fields, format constraints (hostname/ipv4/ipv6), port ranges, const values, and additionalProperties rejection for SSH, OpenSSH, WinRM, and Localhost schemas. Uses santhosh-tekuri/jsonschema/v6 with format assertions enabled so address format rules are enforced in tests.

Copilot

Pull request overview

Copilot reviewed 37 out of 40 changed files in this pull request and generated 2 comments.

- Mark santhosh-tekuri/jsonschema/v6 as direct dependency in go.mod - Remove trailing whitespace from golangci-lint workflow

…-module Keeps santhosh-tekuri/jsonschema/v6 out of rig's main go.mod — the library is a test-only concern and belongs in the isolated sub-module alongside the schema generator.

Copilot

Pull request overview

Copilot reviewed 36 out of 39 changed files in this pull request and generated 3 comments.

…s.ToArgs() call - closeControl: remove redundant c.userhost() append — c.args() already includes the destination; passing it twice broke ssh -O exit - startControl: store opts.ToArgs() in a local variable to avoid calling it twice (extra work + non-deterministic map iteration) - ci: add step to run schema validation tests in internal/jsonschema, which go test ./... from the root module skips

Copilot

Pull request overview

Copilot reviewed 36 out of 39 changed files in this pull request and generated no new comments.

a1994sc · 2026-05-13T12:19:13Z

I have tested locally and this seems to work just fine. Thank you @kke

# Conflicts: # os/windows.go # pkg/rigfs/posixfsys.go

Resolve conflicts from lint fixes in release-0.x (c19e696): - Accept CommandContext(context.Background()) replacements for all exec.Command calls in localhost.go and openssh.go - Accept extracted setExtraOSReleaseField helper in resolver.go - Accept minor comment/wording improvements across files - Keep HEAD's IsWindows() in openssh.go (release-0.x has invalid Go syntax) - Keep HEAD's closeControl() args in openssh.go (release-0.x re-introduced the duplicate userhost bug fixed in da237d4) - Fix release-0.x typo in upload.go example (*usr → *user) - Fix duplicate osWindows const introduced by merge in connection.go

kke added the enhancement New feature or request label May 23, 2025

kke mentioned this pull request May 23, 2025

Feature Request: JSON Schema to validate k0sctl config k0sproject/k0sctl#860

Open

kke added 2 commits May 12, 2026 21:19

Create JSON schemas

af88ef5

Signed-off-by: Kimmo Lehto <klehto@mirantis.com>

kke force-pushed the jsonschema branch from 0e04de5 to d2f215e Compare May 12, 2026 18:19

Update schemas

8f60de6

Signed-off-by: Kimmo Lehto <klehto@mirantis.com>

kke requested a review from Copilot May 12, 2026 18:22

Copilot started reviewing on behalf of kke May 12, 2026 18:23 View session

fix(examples/password): cast syscall.Stdin to int for Windows compati…

eb2cc8b

…bility

Copilot AI reviewed May 12, 2026

View reviewed changes

kke added 2 commits May 12, 2026 21:49

kke requested a review from Copilot May 12, 2026 18:55

Copilot started reviewing on behalf of kke May 12, 2026 18:56 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

Comment thread go.mod

Comment thread .github/workflows/golangci-lint.yaml Outdated

kke added 2 commits May 12, 2026 22:14

chore: fix Copilot review comments

b107b22

- Mark santhosh-tekuri/jsonschema/v6 as direct dependency in go.mod - Remove trailing whitespace from golangci-lint workflow

refactor(schemas): move validation tests into internal/jsonschema sub…

fbc1359

…-module Keeps santhosh-tekuri/jsonschema/v6 out of rig's main go.mod — the library is a test-only concern and belongs in the isolated sub-module alongside the schema generator.

kke requested a review from Copilot May 12, 2026 19:20

Copilot started reviewing on behalf of kke May 12, 2026 19:21 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

Comment thread openssh.go Outdated

Comment thread openssh.go Outdated

Comment thread .github/workflows/golangci-lint.yaml

kke requested a review from Copilot May 12, 2026 19:34

Copilot started reviewing on behalf of kke May 12, 2026 19:34 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

a1994sc approved these changes May 28, 2026

View reviewed changes

Merge branch 'release-0.x' into jsonschema

0bd8089

# Conflicts: # os/windows.go # pkg/rigfs/posixfsys.go

kke merged commit dcdbe7f into release-0.x Jun 4, 2026
7 checks passed

kke deleted the jsonschema branch June 4, 2026 13:38

kke mentioned this pull request Jun 8, 2026

feat(config): add config struct json schemas #381

Merged

Conversation

kke commented May 23, 2025

Uh oh!

a1994sc commented Mar 30, 2026

Uh oh!

kke commented May 4, 2026

Uh oh!

a1994sc commented May 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

a1994sc commented May 13, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants