oz icon indicating copy to clipboard operation
oz copied to clipboard

Document full Oz profile JSON syntax

Open tildelowengrimm opened this issue 7 years ago • 2 comments

I can't find any comprehensive documentation for the syntax used for the JSON files in /var/lib/oz/cells.d/. This would be really useful for writing my own Oz configs.

tildelowengrimm avatar Aug 16 '17 02:08 tildelowengrimm

The Oz profile is documented here:

https://github.com/subgraph/sgos_handbook

The SGOS handbook should be considered authoritative documentation.

It's mostly complete, I think, at least so far as the major/more mature parameters go. I'll need to re-examine that to make sure it is the case, so I'll leave the issue open.

dma avatar Aug 16 '17 13:08 dma

I agree that it'd be great if the specs for Oz profiles were in the handbook. But the documentation there is not quite comprehensive. I've seen plenty of options in the default profiles which aren't documented there, and when trying to write my own it's been trial and error trying to work out what the options are and what they do.

It might also be useful to have a demo config which shows all possible options.

tildelowengrimm avatar Aug 29 '17 02:08 tildelowengrimm