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

[Tracker] Support standard validation and defaulting #219

Closed
vishh opened this issue Oct 7, 2015 · 13 comments
Closed

[Tracker] Support standard validation and defaulting #219

vishh opened this issue Oct 7, 2015 · 13 comments
Milestone

Comments

@vishh
Copy link
Contributor

vishh commented Oct 7, 2015

As of now, the Spec does not explicitly state the fields that are required. This can lead to various implementations of the Spec defaulting and validating the Spec in its own manner.
Annotating each field in the Spec with a required or optional tag along with the default value will help with readability. But it does not ensure conformance.
To provide a seamless experience with OCI bundles across various implementations of the Spec, we should provide standard validation and defaulting tools. These tools might have to be platform or OS specific.

Largely happening in https://github.com/opencontainers/ocitools

Goals:
[ ] configuration validation
[ ] environment testing

@vishh
Copy link
Contributor Author

vishh commented Oct 7, 2015

@mrunalp: Are you working on this already?

@mrunalp
Copy link
Contributor

mrunalp commented Oct 7, 2015

@vishh I have a spec generation tool at https://github.com/mrunalp/ocitools
Some validation work is also in progress there.

@liangchenye
Copy link
Member

@mrunalp , what is the plan of the OCI tools?

  1. repo
    Create an official spec repo or merge from an outside one?
    You, Kunal and we (OCT folks) are working on the similar thing now.
  2. scope
    generator, bundleValidator, runtimeValidator.
    And more tools like 'convert'?
    (https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/OHlbEfHUaiA)

@zenlint
Copy link
Contributor

zenlint commented Oct 9, 2015

@mrunalp @vishh,
I and my team were working hard at the runtimeValidator(https://github.com/huawei-openlab/oct/blob/master/tools/runtimeValidator/README.md) and bundleValidator(https://github.com/huawei-openlab/oct/blob/master/tools/bundleValidator/README.md), and they are working well now.
Maybe the idea is not highly consistent with your's, but I think it is not necessary to develop a Validator from the very begining. We could disscuss them together, and economize the existing project.

Thanks, expect to your Directive opinion.

@liangchenye
I suggest to have a repo like 'https://github.com/opencontainers/oct' or 'https://github.com/opencontainers/ocitool'.

@mrunalp
Copy link
Contributor

mrunalp commented Oct 9, 2015

@liangchenye @zenlinTechnofreak Could you guys give a demo and walk through of what
you have implemented? I went through the documents but it did not seem to work for me. (It must be something I am doing wrong).

@liangchenye
Copy link
Member

Hi @mrunalp,
Seems our document is still not clear enough :(
Now we have 4 tools in 3 independent directories.

Thank you for your time.
David Liang

@vbatts
Copy link
Member

vbatts commented Oct 16, 2015

conversion tools, while needed will be external tooling. They will be many and potentially needing independent ownership. Besides format conversion, I'm imagining oci2nspawn or oci2lxc for execution of opencontainer bundles. Let's just have a wiki page for these kinds of external tools.

@wking
Copy link
Contributor

wking commented Oct 16, 2015

On Fri, Oct 16, 2015 at 12:01:22PM -0700, Vincent Batts wrote:

Let's just have a wiki page for these kinds of external tools.

Couldn't we list them in a section of our implementation listing 1?
At this early stage, it seems like the more visible mass there is
around OCI, the better (and to me 1 seems more visible than the
wiki).

@vbatts
Copy link
Member

vbatts commented Mar 9, 2016

Some amount of validation will be provided through #313 as well

@vbatts vbatts changed the title Support standard validation and defaulting [Tracker] Support standard validation and defaulting Mar 16, 2016
@vbatts vbatts added this to the by-1.0.0 milestone Mar 16, 2016
@crosbymichael crosbymichael modified the milestones: by-1.0.0, 1.0.0 May 25, 2016
@philips
Copy link
Contributor

philips commented Jun 3, 2016

What are the tactical things that need to be done here now. @vbatts says some stuff is now covered but what is left for someone to do?

@wking
Copy link
Contributor

wking commented Jun 3, 2016

On Thu, Jun 02, 2016 at 09:36:15PM -0700, Brandon Philips wrote:

What are the tactical things that need to be done here now.

I'm not clear on the summary's “defaulting”, but I think that between
this repo's existing JSON Schema and ocitools (see
opencontainers/runtime-tools#66) we can close this issue.

@mrunalp
Copy link
Contributor

mrunalp commented Jun 3, 2016

@philips We can close this one given what we have in ocitools and the schema as @wking pointed out.

@crosbymichael
Copy link
Member

Yep, this can be closed because of ocitools and the schema work that has been done

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

8 participants