tt: provide jsonschemas for `tt.yaml` and `instances.yaml`
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 113
- Forks
- 18
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 23
Description
JSON Schemas allows one to define the structure of a JSON (or YAML in our case) document and statically validate its content.
Currently, there is a Tarantool JSON schema simplifying it for the user to work with Tarantool 3.x cluster configuration. E.g. it might be used within Visual Studio Code by setting up a Red-hat YAML extension.
It'd nice to have a similar schema for tt.yaml and instances.yaml for user to be able to statically validate tt specific configuration. Its configuration is less subject to change than the cluster configuration though it also means it can be simply put into the repository without the need of generating it by sources as it's done in Tarantool.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the definitions and examples for tt.yaml and instances.yaml, then compare their configuration fields with the linked Tarantool schema. Add schemas that cover both files and verify that they statically validate representative YAML configurations in a YAML editor or validator.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100