1# Open Container Initiative Runtime Specification
2
3[](https://github.com/opencontainers/runtime-spec/actions?query=workflow%3Abuild)
4
5The [Open Container Initiative][oci] develops specifications for standards on Operating System process and application containers.
6
7The specification can be found [here](spec.md).
8
9## Table of Contents
10
11Additional documentation about how this group operates:
12
13- [Code of Conduct][code-of-conduct]
14- [Style and Conventions](style.md)
15- [Implementations](implementations.md)
16- [Releases](RELEASES.md)
17- [charter][charter]
18
19## Use Cases
20
21To provide context for users the following section gives example use cases for each part of the spec.
22
23### Application Bundle Builders
24
25Application bundle builders can create a [bundle](bundle.md) directory that includes all of the files required for launching an application as a container.
26The 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#posix-platform-hooks) paths, Linux [namespaces](config-linux.md#namespaces) and [cgroups](config-linux.md#control-groups).
27Because the configuration includes host-specific settings, application bundle directories copied between two hosts may require configuration adjustments.
28
29### Hook Developers
30
31[Hook](config.md#posix-platform-hooks) developers can extend the functionality of an OCI-compliant runtime by hooking into a container's lifecycle with an external application.
32Example use cases include sophisticated network configuration, volume garbage collection, etc.
33
34### Runtime Developers
35
36Runtime 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.
37
38## Contributing
39
40Development happens on GitHub for the spec.
41Issues are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list).
42
43The specification and code is licensed under the Apache 2.0 license found in the [LICENSE](./LICENSE) file.
44
45### Discuss your design
46
47The project welcomes submissions, but please let everyone know what you are working on.
48
49Before undertaking a nontrivial change to this specification, send mail to the [mailing list](#mailing-list) to discuss what you plan to do.
50This gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits.
51It also guarantees that the design is sound before code is written; a GitHub pull-request is not the place for high-level discussions.
52
53Typos and grammatical errors can go straight to a pull-request.
54When in doubt, start on the [mailing-list](#mailing-list).
55
56### Meetings
57
58Please see the [OCI org repository README](https://github.com/opencontainers/org#meetings) for the most up-to-date
59information on OCI contributor and maintainer meeting schedules. You can also find links to meeting agendas and
60minutes for all prior meetings.
61
62### Mailing List
63
64You can subscribe and join the mailing list on [Google Groups][dev-list].
65
66### Chat
67
68OCI discussion happens in the following chat rooms, which are all bridged together:
69
70- #general channel on [OCI Slack](https://opencontainers.org/community/overview/#chat)
71- #opencontainers:matrix.org
72
73### Git commit
74
75#### Sign your work
76
77The 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.
78The rules are pretty simple: if you can certify the below (from http://developercertificate.org):
79
80```
81Developer Certificate of Origin
82Version 1.1
83
84Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
85660 York Street, Suite 102,
86San Francisco, CA 94110 USA
87
88Everyone is permitted to copy and distribute verbatim copies of this
89license document, but changing it is not allowed.
90
91
92Developer's Certificate of Origin 1.1
93
94By making a contribution to this project, I certify that:
95
96(a) The contribution was created in whole or in part by me and I
97 have the right to submit it under the open source license
98 indicated in the file; or
99
100(b) The contribution is based upon previous work that, to the best
101 of my knowledge, is covered under an appropriate open source
102 license and I have the right under that license to submit that
103 work with modifications, whether created in whole or in part
104 by me, under the same open source license (unless I am
105 permitted to submit under a different license), as indicated
106 in the file; or
107
108(c) The contribution was provided directly to me by some other
109 person who certified (a), (b) or (c) and I have not modified
110 it.
111
112(d) I understand and agree that this project and the contribution
113 are public and that a record of the contribution (including all
114 personal information I submit with it, including my sign-off) is
115 maintained indefinitely and may be redistributed consistent with
116 this project or the open source license(s) involved.
117```
118
119then you just add a line to every git commit message:
120
121 Signed-off-by: Joe Smith <joe@gmail.com>
122
123using your real name (sorry, no pseudonyms or anonymous contributions.)
124
125You can add the sign off when creating the git commit via `git commit -s`.
126
127#### Commit Style
128
129Simple house-keeping for clean git history.
130Read more on [How to Write a Git Commit Message][how-to-git-commit] or the Discussion section of [git-commit(1)][git-commit.1].
131
1321. Separate the subject from body with a blank line
1332. Limit the subject line to 50 characters
1343. Capitalize the subject line
1354. Do not end the subject line with a period
1365. Use the imperative mood in the subject line
1376. Wrap the body at 72 characters
1387. Use the body to explain what and why vs. how
139 * If there was important/useful/essential conversation or information, copy or include a reference
1408. When possible, one keyword to scope the change in the subject (i.e. "README: ...", "runtime: ...")
141
142
143[charter]: https://github.com/opencontainers/tob/blob/master/CHARTER.md
144[code-of-conduct]: https://github.com/opencontainers/org/blob/master/CODE_OF_CONDUCT.md
145[dev-list]: https://groups.google.com/a/opencontainers.org/forum/#!forum/dev
146[how-to-git-commit]: http://chris.beams.io/posts/git-commit
147[iso-week]: https://en.wikipedia.org/wiki/ISO_week_date#Calculating_the_week_number_of_a_given_date
148[minutes]: http://ircbot.wl.linuxfoundation.org/meetings/opencontainers/
149[oci]: https://www.opencontainers.org
150[rfc5545]: https://tools.ietf.org/html/rfc5545
151[runtime-wiki]: https://github.com/opencontainers/runtime-spec/wiki
152[uberconference]: https://www.uberconference.com/opencontainers
153
154[git-commit.1]: http://git-scm.com/docs/git-commit
View as plain text