155 lines
6.8 KiB
Markdown
155 lines
6.8 KiB
Markdown
# Open Container Initiative Runtime Specification
|
|
|
|
The [Open Container Initiative][oci] develops specifications for standards on Operating System process and application containers.
|
|
|
|
The specification can be found [here](spec.md).
|
|
|
|
## Table of Contents
|
|
|
|
Additional documentation about how this group operates:
|
|
|
|
- [Code of Conduct][code-of-conduct]
|
|
- [Style and Conventions](style.md)
|
|
- [Roadmap](ROADMAP.md)
|
|
- [Implementations](implementations.md)
|
|
- [Releases](RELEASES.md)
|
|
- [project](project.md)
|
|
- [charter][charter]
|
|
|
|
## Use Cases
|
|
|
|
To provide context for users the following section gives example use cases for each part of the spec.
|
|
|
|
### Application Bundle Builders
|
|
|
|
Application bundle builders can create a [bundle](bundle.md) directory that includes all of the files required for launching an application as a container.
|
|
The bundle contains an OCI [configuration file](config.md) where the builder can specify host-independent details such as [which executable to launch](config.md#process) and host-specific settings such as [mount](config.md#mounts) locations, [hook](config.md#hooks) paths, Linux [namespaces](config-linux.md#namespaces) and [cgroups](config-linux.md#control-groups).
|
|
Because the configuration includes host-specific settings, application bundle directories copied between two hosts may require configuration adjustments.
|
|
|
|
### Hook Developers
|
|
|
|
[Hook](config.md#hooks) 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
|
|
|
|
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.
|
|
|
|
## Releases
|
|
|
|
There is a loose [Road Map](./ROADMAP.md).
|
|
During the `0.x` series of OCI releases we make no backwards compatibility guarantees and intend to break the schema during this series.
|
|
|
|
## Contributing
|
|
|
|
Development happens on GitHub for the spec.
|
|
Issues are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list).
|
|
|
|
The specification and code is licensed under the Apache 2.0 license found in the [LICENSE](./LICENSE) file.
|
|
|
|
### Discuss your design
|
|
|
|
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 the [mailing list](#mailing-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 the [mailing-list](#mailing-list).
|
|
|
|
### Weekly Call
|
|
|
|
The contributors and maintainers of all OCI projects have a weekly meeting Wednesdays at 2:00 PM (USA Pacific).
|
|
Everyone is welcome to participate via [UberConference web][uberconference] or audio-only: 415-968-0849 (no PIN needed.)
|
|
An initial agenda will be posted to the [mailing list](#mailing-list) earlier in the week, and everyone is welcome to propose additional topics or suggest other agenda alterations there.
|
|
Minutes are posted to the [mailing list](#mailing-list) and minutes from past calls are archived to the [wiki][runtime-wiki].
|
|
|
|
### Mailing List
|
|
|
|
You can subscribe and join the mailing list on [Google Groups][dev-list].
|
|
|
|
### IRC
|
|
|
|
OCI discussion happens on #opencontainers on Freenode ([logs][irc-logs]).
|
|
|
|
### Git commit
|
|
|
|
#### Sign your work
|
|
|
|
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 (from http://developercertificate.org):
|
|
|
|
```
|
|
Developer Certificate of Origin
|
|
Version 1.1
|
|
|
|
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
|
660 York Street, Suite 102,
|
|
San Francisco, CA 94110 USA
|
|
|
|
Everyone is permitted to copy and distribute verbatim copies of this
|
|
license document, but changing it is not allowed.
|
|
|
|
|
|
Developer's Certificate of Origin 1.1
|
|
|
|
By 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 via `git commit -s`.
|
|
|
|
#### Commit Style
|
|
|
|
Simple house-keeping for clean git history.
|
|
Read more on [How to Write a Git Commit Message][how-to-git-commit] or the Discussion section of [git-commit(1)][git-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: ...")
|
|
|
|
|
|
[charter]: https://www.opencontainers.org/about/governance
|
|
[code-of-conduct]: https://github.com/opencontainers/tob/blob/master/code-of-conduct.md
|
|
[dev-list]: https://groups.google.com/a/opencontainers.org/forum/#!forum/dev
|
|
[how-to-git-commit]: http://chris.beams.io/posts/git-commit
|
|
[irc-logs]: http://ircbot.wl.linuxfoundation.org/eavesdrop/%23opencontainers/
|
|
[oci]: https://www.opencontainers.org
|
|
[runtime-wiki]: https://github.com/opencontainers/runtime-spec/wiki
|
|
[uberconference]: https://www.uberconference.com/opencontainers
|
|
|
|
[git-commit.1]: http://git-scm.com/docs/git-commit
|