Add proposal for libocispec #32

giuseppe · 2017-08-04T15:08:29Z

Signed-off-by: Giuseppe Scrivano [email protected]

caniszczyk · 2017-08-04T15:20:17Z

before we call a formal vote on this, I would like to get comments from @philips and the @opencontainers/runtime-spec-maintainers @opencontainers/image-spec-maintainers

caniszczyk · 2017-08-04T15:20:43Z

proposals/libocispec.md

+
+Rename (transfer) https://github.com/giuseppe/libocispec would become https://github.com/opencontainers/libocispec.
+
+### Initial Maintainers


any other maintainers besides you :)?

submitted a new version with Qiang Huang [email protected] who offered to be a maintainer as well.

giuseppe · 2017-08-04T15:52:41Z

Worth saying: I've rewritten the read_file module and licensed it Apache 2.0

wking · 2017-08-04T16:23:36Z

README.md

 * [Image Format Spec](https://github.com/opencontainers/tob/tree/master/proposals/image-format)
 * [SELinux](https://github.com/opencontainers/tob/blob/master/proposals/selinux.md)
 * [Tools](https://github.com/opencontainers/tob/blob/master/proposals/tools.md)
+* [libocispec](https://github.com/opencontainers/tob/blob/master/proposals/libocispec.md)


Previous entries in this list seem to be alphabetized, although I don't know if TOB maintainers care about that.

wking · 2017-08-04T16:29:40Z

proposals/libocispec.md

+# OCI libocispec project proposal
+
+## Abstract
+Provide a C library for parsing and handle OCI runtime spec file and OCI image spec files.


“handle” → “handling”. Or maybe “representing”? Or maybe “passing”? The library seems to handle parsing from various formats into C types and manipulating those C types in memory. There's nothing about implementing the OCI spec semantics. It would be good to have a short word/phrase here to make that distinction clear, and I don't think “handling” is specific enough.

Also, the input may be in a file, or may just be in a string (e.g. oci_container_parse_data). What they have in common is that they all parse JSON. So I'd rather end with “OCI Runtime and Image specification JSON.” or some such.

wking · 2017-08-04T16:30:37Z

proposals/libocispec.md

+## Proposal
+With repositories under the http://github.com/opencontainers organization:
+
+Rename (transfer) https://github.com/giuseppe/libocispec would become https://github.com/opencontainers/libocispec.


“would become” → “to”.

wking · 2017-08-04T16:34:27Z

proposals/libocispec.md

+
+**Q: Does this change the OCI Charter or Scope Table?**
+
+A: No.  Nothing in this proposal is intended to amend the OCI Charter (https://www.opencontainers.org/about/governance) or OCI Scope Table (https://www.opencontainers.org/about/oci-scope-table).


Really? There's nothing in the scope table about this. I think we should ask for an entry covering this project. Although previous proposals that should have impacted the scope table have had their associated scope-table updates punted to post-proposal, so maybe we want to go that way again.

tianon · 2017-08-04T16:55:06Z

IMO this looks like a really cool project, but I think it's a bit premature for the OCI to officially adopt it, especially since it's not used by any of the other projects that the OCI already maintains. I'm all for the OCI linking to it and reconsidering officialization when it's slightly more mature.

giuseppe · 2017-08-04T16:58:35Z

@tianon I am not sure how more mature it can be. If the OCI runtime/image specs won't change in a way to break the generate.py script then I don't foresee any major work on it.

I know that @0x0916 and @tanyifeng are using it in their project (it is not publicly available AFAIK)

hqhq · 2017-08-07T01:25:26Z

@tianon @giuseppe Yes we're using it in our internal project in Huawei, it's still premature and not open sourced yet. I think the implementation of this library is pretty straightforward and should be stable, most of the maintenance work would be adapting the changes in specs, so there won't be significantly more mature IMO.

Regarding the usage by other OCI projects, since the major user of this library would be spec implementations, I think we'll only have one implementation for one spec in OCI according to our pre-discussions, and that implementation would most likely be a go version, so I doubt there would be any c version implementation which uses this library in OCI.

rhatdan · 2018-01-25T08:30:14Z

Any update on this? @giuseppe is using this for a cool implementation of crun (https://github.com/giuseppe/crun), basic an OCI runtime written totally in C.

caniszczyk · 2018-01-25T14:01:46Z

@rhatdan once the new @opencontainers/tob is formed at the end of this month, they can take a look at it: #33

rhatdan · 2018-01-26T08:23:47Z

@caniszczyk Thanks.

giuseppe · 2018-05-09T09:24:50Z

rebased ⬆️

wking · 2018-05-10T14:33:13Z

README.md

 * [Digest](proposals/digest.md)
 * [Distribution Spec](proposals/distribution.md)
 * [Image Format Spec](proposals/image-format)
+* [libocispec](https://github.com/opencontainers/tob/blob/master/proposals/libocispec.md)


Can you make this a relative link? See #51.

wking · 2018-05-10T14:34:25Z

proposals/libocispec.md

+Provide a C library for parsing and accessing OCI Runtime and Image specification JSON.
+
+## Proposal
+With repositories under the http://github.com/opencontainers organization:


http -> https

wking · 2018-05-10T14:35:55Z

proposals/libocispec.md

+### Initial Maintainers
+Initial maintainers of the libocispec project:
+* Giuseppe Scrivano <[email protected]> (@gscrivano)
+* Qiang Huang <[email protected]>


wking · 2018-05-10T14:37:10Z

proposals/libocispec.md

+This project would incorporate the Governance and Releases processes from the OCI project template: https://github.com/opencontainers/project-template.
+
+### Project Communications
+Both of the proposed projects would continue to use existing channels in use by the OCI developer community for communication including:


"Both of the proposed projects" -> "This project"

wking · 2018-05-10T14:38:04Z

proposals/libocispec.md

+Both of the proposed projects would continue to use existing channels in use by the OCI developer community for communication including:
+* GitHub for issues and pull requests
+* The [email protected] email list
+* The weekly OCI developer community conference call


"weekly" -> "monthly"

wking · 2018-05-10T14:40:46Z

proposals/libocispec.md

+* The #OpenContainers IRC channel
+
+### Versioning / Roadmap
+It aims to be a C library to be statically linked in the projects that need it.


What about versioning? I expect the ingtersection between sopported JSON and the exposed API will be interesting. Do you intend to buffer callers from breaking JSON schema changes? I expect not.

giuseppe · 2018-05-11T12:49:38Z

@wking thanks, I've addressed your comments and pushed a new version

vbatts · 2018-05-16T16:55:25Z

I'm not opposed to libocispec. I see value in having a C implementation of OCI features. Other's thoughts?

…

On 05/11/2018 08:49 AM, Giuseppe Scrivano wrote: @wking <https://github.com/wking> thanks, I've addressed your comments and pushed a new version — You are receiving this because you are on a team that was mentioned. Reply to this email directly, view it on GitHub <#32 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAEF6RgG915CUECbsXeoOZZ5a_RRFmYHks5txYjmgaJpZM4Ot1eA>.

crosbymichael · 2018-05-16T16:57:34Z

But is OCI the right place for more implementations? I thought we were shying away from putting more implementations into the OCI and keeping it spec focused. If we had to do it over again, runc would probably be somewhere else right?

caniszczyk · 2018-05-16T19:08:47Z

I think that's for the @opencontainers/tob to decide, you have the power to do what you want. I would put this more of a utility (ala runtime/image tools). The other issue with this project is that @giuseppe would have to relicense it under Apache v2 before it can even be considered for OCI

giuseppe · 2018-05-16T19:42:26Z

I am fine to relicense it under Apache v2 if there is agreement on adding it to OCI.

@crosbymichael, libocispec is not an implementation of the OCI specs, it is only the C parser (automatically generated from the JSON schema).

https://github.com/giuseppe/crun is the OCI implementation that uses libocispec.

crosbymichael · 2018-05-16T20:11:18Z

proposals/libocispec.md

+
+Rename (transfer) https://github.com/giuseppe/libocispec to https://github.com/opencontainers/libocispec.
+
+### Initial Maintainers


Is there a reason why you are proposing maintainers here that have not contributed code or issues directly to the project?

https://github.com/giuseppe/libocispec/graphs/contributors

at the time I proposed libocispec I asked around if someone was interested in co-maintaining it so to not have only one maintainer listed. I'll update the list if this is not the preferred way of doing it.

mikebrow · 2018-05-16T21:23:40Z

I see value for an c implementor and/or languages that would bind to such a lib, but may be overkill to make it a separate oci project. More of a subproject for the specs.

mikebrow · 2018-05-16T21:39:30Z

proposals/libocispec.md

+# OCI libocispec project proposal
+
+## Abstract
+Provide a C library for parsing and accessing OCI Runtime and Image specification JSON.


Provide code for parsing and accessing JSON versions of OCI Runtime and Image specs. The first implementation will be a C library automatically generated directly from the OCI Runtime and Image specifications.

mikebrow · 2018-05-16T21:42:39Z

proposals/libocispec.md

+## Proposal
+With repositories under the https://github.com/opencontainers organization:
+
+Rename (transfer) https://github.com/giuseppe/libocispec to https://github.com/opencontainers/libocispec.


What about moving it here:
https://github.com/opencontainers/runtime-tools maybe in contrib/libocispec/c/

What about moving it here:
https://github.com/opencontainers/runtime-tools maybe in contrib/libocispec/c/

My concern with that is that versioning the repo becomes tricky. Do you lock the Go and C APIs together under a single version? Version them separately with prefixed tags for C releases? And you'd need to check with runtime-tools maintainers to see if enough of them care about and feel comfortable enough with C to maintain this as well. I don't have a problem with this becoming an OCI Project in its own right, or remaining outside the OCI umbrella. But I think stuffing it into an existing OCI Project may be more trouble than its worth.

And however this shakes out, we probably want to link the library from here to raise awareness.

mikebrow · 2018-05-16T21:46:30Z

proposals/libocispec.md

+* The #OpenContainers IRC channel
+
+### Versioning / Roadmap
+It aims to be a C library to be statically linked in the projects that need it.


Guess that answers my versioning question :-)

I guess I have to update this part :-) now libocispec supports also to be a shared library

hqhq · 2018-05-17T03:39:42Z

proposals/libocispec.md

+### Initial Maintainers
+Initial maintainers of the libocispec project:
+* Giuseppe Scrivano <[email protected]> (@giuseppe)
+* Qiang Huang <[email protected]> (@hqhq)


Sorry I'm not available to contribute or maintain this project now, I would recommend my colleague @tanyifeng who's been contributing to and using this project, I think he would be willing and qualified to do this job : )

sure.

@tanyifeng, are you fine to be added here?

Of course, I'll be glad to be a maintainer of libocispec.

Signed-off-by: Giuseppe Scrivano <[email protected]>

giuseppe · 2018-06-29T10:12:04Z

I've updated the proposal ⬆️

giuseppe · 2018-11-28T10:02:24Z

is there still any interest in moving libocispec to opencontainers?

vbatts · 2018-11-28T14:37:59Z

i still have interest, but for now I am not sure it makes sense, given the adoption and use. Better likely to have a page for implementations by programming language.

giuseppe · 2018-12-21T21:45:24Z

given there is no interest, I am going to close this PR. Thanks to anyone who partecipated in the discussion.

caniszczyk reviewed Aug 4, 2017

View reviewed changes

giuseppe force-pushed the propose-libocispec branch from 0651851 to d8bf367 Compare August 4, 2017 15:48

giuseppe force-pushed the propose-libocispec branch from d8bf367 to 64dd665 Compare August 4, 2017 15:55

wking reviewed Aug 4, 2017

View reviewed changes

giuseppe force-pushed the propose-libocispec branch from 64dd665 to 16baa6c Compare August 4, 2017 16:43

wking mentioned this pull request Sep 20, 2017

If/When discuss this project under OCI's public thread xiekeyang/oci-discovery#26

Closed

giuseppe force-pushed the propose-libocispec branch from 16baa6c to aa73a9f Compare May 9, 2018 09:24

wking reviewed May 10, 2018

View reviewed changes

giuseppe force-pushed the propose-libocispec branch from aa73a9f to 91f00d0 Compare May 11, 2018 12:48

crosbymichael reviewed May 16, 2018

View reviewed changes

mikebrow reviewed May 16, 2018

View reviewed changes

hqhq reviewed May 17, 2018

View reviewed changes

Add proposal for libocispec

c546ea3

Signed-off-by: Giuseppe Scrivano <[email protected]>

giuseppe force-pushed the propose-libocispec branch from 91f00d0 to c546ea3 Compare May 24, 2018 13:27

giuseppe closed this Dec 21, 2018


		Rename (transfer) https://github.com/giuseppe/libocispec would become https://github.com/opencontainers/libocispec.

		### Initial Maintainers


		Q: Does this change the OCI Charter or Scope Table?

		A: No. Nothing in this proposal is intended to amend the OCI Charter (https://www.opencontainers.org/about/governance) or OCI Scope Table (https://www.opencontainers.org/about/oci-scope-table).

Add proposal for libocispec #32

Add proposal for libocispec #32

Uh oh!

Conversation

giuseppe commented Aug 4, 2017

Uh oh!

caniszczyk commented Aug 4, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

giuseppe commented Aug 4, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tianon commented Aug 4, 2017

Uh oh!

giuseppe commented Aug 4, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hqhq commented Aug 7, 2017

Uh oh!

rhatdan commented Jan 25, 2018

Uh oh!

caniszczyk commented Jan 25, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rhatdan commented Jan 26, 2018

Uh oh!

giuseppe commented May 9, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

giuseppe commented May 11, 2018

Uh oh!

vbatts commented May 16, 2018 via email

Uh oh!

crosbymichael commented May 16, 2018

Uh oh!

caniszczyk commented May 16, 2018

Uh oh!

giuseppe commented May 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikebrow commented May 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

giuseppe commented Aug 4, 2017 •

edited

Loading

caniszczyk commented Jan 25, 2018 •

edited

Loading