Skip to content

Add proposal for libocispec #32

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.

Sign up for GitHub

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

Closed
giuseppe wants to merge 1 commit into from
Closed

Add proposal for libocispec #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ https://groups.google.com/a/opencontainers.org/forum/#!forum/tob (tob@opencontai
* [Digest](proposals/digest.md)
* [Distribution Spec](proposals/distribution.md)
* [Image Format Spec](proposals/image-format)
* [libocispec](proposals/libocispec.md)
* [SELinux](proposals/selinux.md)
* [Tools](proposals/tools.md)

Expand Down
36 changes: 36 additions & 0 deletions proposals/libocispec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# OCI libocispec project proposal

## Abstract
Provide a C library for parsing and accessing OCI Runtime and Image specification JSON.
Copy link
Member

@mikebrow mikebrow May 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


## Proposal
With repositories under the https://github.com/opencontainers organization:

Rename (transfer) https://github.com/giuseppe/libocispec to https://github.com/opencontainers/libocispec.
Copy link
Member

@mikebrow mikebrow May 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@wking wking May 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


### Initial Maintainers
Copy link
Member

@crosbymichael crosbymichael May 16, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

@giuseppe giuseppe May 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Initial maintainers of the libocispec project:
* Giuseppe Scrivano <[email protected]> (@giuseppe)
* Yifeng Tan <[email protected]> (@tanyifeng)

### Code of Conduct
This project would incorporate (by reference) the OCI Code of Conduct.

### Governance and Releases
This project would incorporate the Governance and Releases processes from the OCI project template: https://github.com/opencontainers/project-template.

### Project Communications
This project 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 monthly OCI developer community conference call
* The #OpenContainers IRC channel

### Versioning / Roadmap
It aims to be a C library that can be either used as a shared library or statically linked in the projects that need it.

## Frequenty Asked Questions (FAQ)

**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).
Copy link
Contributor

@wking wking Aug 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.