Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document full Oz profile JSON syntax #114

Open
tildelowengrimm opened this issue Aug 16, 2017 · 2 comments
Open

Document full Oz profile JSON syntax #114

tildelowengrimm opened this issue Aug 16, 2017 · 2 comments

Comments

@tildelowengrimm
Copy link

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.

@dma
Copy link
Contributor

dma commented Aug 16, 2017

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.

@tildelowengrimm
Copy link
Author

tildelowengrimm commented Aug 29, 2017

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants