define JSON schemas for builds.json + meta.json about coreos-assembler HOT 7 CLOSED

@miabbott: Is this issue still valid?
https://github.com/coreos/ignition/blob/master/config/v3_0/schema/ignition.json

If yes, I would like to work on it.

from coreos-assembler.

@akoserwal Yes I think it is still a valid issue. I think this is a two-step problem to solve.

1. Create a schema definition for both builds.json and meta.json
2. Create a way to validate the generated JSON files are in compliance with the schemas definitions.

Ignition has the ignition-validate tool that can be used to validate Ignition configs; coreos-assembler would need something similar.

from coreos-assembler.

I agree we should do this. Note the schema for builds.json dramatically changed in #580. Notably, we also include a schema-version key now.

from coreos-assembler.

Ignition has the ignition-validate tool that can be used to validate Ignition configs; coreos-assembler would need something similar.

This would be a nice to have, but we could probably just use some additions to the tests which we can run against PRs etc.

from coreos-assembler.

Given that I've broken COSA builds with my refactor....I would like to do this. We hg

Here's my proposal for the schema:

• the schema will be made an explicit contract which external sources can rely on
• add tests to ensure that the schema is enforced
• changing the schema will incur some friction, but changes to the schema will become INTENTIONAL.

from coreos-assembler.

coreos/mantle#1165 is intended to do validation too; not the same as a schema, but using a statically typed programming language to parse it makes API changes very explicit.

from coreos-assembler.

This was done.

from coreos-assembler.