Repository files navigation

TheOpen Container Initiative develops specifications for standards on Operating System process and application containers.

The specification can be foundhere.

Additional documentation about how this group operates:

• Code of Conduct
• Style and Conventions
• Implementations
• Releases
• charter

To provide context for users the following section gives example use cases for each part of the spec.

Application bundle builders can create abundle directory that includes all of the files required for launching an application as a container.The bundle contains an OCIconfiguration file where the builder can specify host-independent details such aswhich executable to launch and host-specific settings such asmount locations,hook paths, Linuxnamespaces andcgroups.Because the configuration includes host-specific settings, application bundle directories copied between two hosts may require configuration adjustments.

Hook developers can extend the functionality of an OCI-compliant runtime by hooking into a container's lifecycle with an external application.Example use cases include sophisticated network configuration, volume garbage collection, etc.

Runtime developers can build runtime implementations that run OCI-compliant bundles and container configuration, containing low-level OS and host-specific details, on a particular platform.

Development happens on GitHub for the spec.Issues are used for bugs and actionable items and longer discussions can happen on themailing list.

The specification and code is licensed under the Apache 2.0 license found in theLICENSE file.

The project welcomes submissions, but please let everyone know what you are working on.

Before undertaking a nontrivial change to this specification, send mail to themailing list to discuss what you plan to do.This gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits.It also guarantees that the design is sound before code is written; a GitHub pull-request is not the place for high-level discussions.

Typos and grammatical errors can go straight to a pull-request.When in doubt, start on themailing-list.

Please see theOCI org repository README for the most up-to-dateinformation on OCI contributor and maintainer meeting schedules. You can also find links to meeting agendas andminutes for all prior meetings.

You can subscribe and join the mailing list onGoogle Groups.

OCI discussion happens in the following chat rooms, which are all bridged together:

• #general channel onOCI Slack
• #opencontainers:matrix.org

The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch.The rules are pretty simple: if you can certify the below (fromhttps://developercertificate.org):

Developer Certificate of OriginVersion 1.1Copyright (C) 2004, 2006 The Linux Foundation and its contributors.660 York Street, Suite 102,San Francisco, CA 94110 USAEveryone is permitted to copy and distribute verbatim copies of thislicense document, but changing it is not allowed.Developer's Certificate of Origin 1.1By making a contribution to this project, I certify that:(a) The contribution was created in whole or in part by me and I    have the right to submit it under the open source license    indicated in the file; or(b) The contribution is based upon previous work that, to the best    of my knowledge, is covered under an appropriate open source    license and I have the right under that license to submit that    work with modifications, whether created in whole or in part    by me, under the same open source license (unless I am    permitted to submit under a different license), as indicated    in the file; or(c) The contribution was provided directly to me by some other    person who certified (a), (b) or (c) and I have not modified    it.(d) I understand and agree that this project and the contribution    are public and that a record of the contribution (including all    personal information I submit with it, including my sign-off) is    maintained indefinitely and may be redistributed consistent with    this project or the open source license(s) involved.

then you just add a line to every git commit message:

Signed-off-by: Joe Smith <joe@gmail.com>

using your real name (sorry, no pseudonyms or anonymous contributions.)

You can add the sign off when creating the git commit viagit commit -s.

Simple house-keeping for clean git history.Read more onHow to Write a Git Commit Message or the Discussion section ofgit-commit(1).

1. Separate the subject from body with a blank line
2. Limit the subject line to 50 characters
3. Capitalize the subject line
4. Do not end the subject line with a period
5. Use the imperative mood in the subject line
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how
   • If there was important/useful/essential conversation or information, copy or include a reference
8. When possible, one keyword to scope the change in the subject (i.e. "README: ...", "runtime: ...")