You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,7 @@
2
2
3
3
The [Open Container Initiative](http://www.opencontainers.org/) develops specifications for standards on Operating System process and application containers.
In the specifications in the above table of contents, the keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
26
27
27
28
An implementation is not compliant for a given CPU architecture if it fails to satisfy one or more of the MUST, REQUIRED, or SHALL requirements for the protocols it implements.
@@ -31,42 +32,42 @@ Protocols defined by this specification are:
31
32
* Linux containers: [runtime.md](runtime.md), [config.md](config.md), [config-linux.md](config-linux.md), and [runtime-linux.md](runtime-linux.md).
32
33
* Solaris containers: [runtime.md](runtime.md), [config.md](config.md), and [config-solaris.md](config-solaris.md).
33
34
34
-
# Use Cases
35
+
##Use Cases
35
36
36
37
To provide context for users the following section gives example use cases for each part of the spec.
37
38
38
-
####Application Bundle Builders
39
+
### Application Bundle Builders
39
40
40
41
Application bundle builders can create a [bundle](bundle.md) directory that includes all of the files required for launching an application as a container.
41
42
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-configuration) 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).
42
43
Because the configuration includes host-specific settings, application bundle directories copied between two hosts may require configuration adjustments.
43
44
44
-
####Hook Developers
45
+
### Hook Developers
45
46
46
47
[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.
47
48
Example use cases include sophisticated network configuration, volume garbage collection, etc.
48
49
49
-
####Runtime Developers
50
+
### Runtime Developers
50
51
51
52
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.
52
53
53
-
# Releases
54
+
##Releases
54
55
55
56
There is a loose [Road Map](./ROADMAP.md).
56
57
During the `0.x` series of OCI releases we make no backwards compatibility guarantees and intend to break the schema during this series.
57
58
58
-
# Contributing
59
+
##Contributing
59
60
60
61
Development happens on GitHub for the spec.
61
62
Issues are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list).
62
63
63
64
The specification and code is licensed under the Apache 2.0 license found in the [LICENSE](./LICENSE) file.
64
65
65
-
## Code of Conduct
66
+
###Code of Conduct
66
67
67
68
Participation in the OpenContainers community is governed by [OpenContainer's Code of Conduct](https://github.com/opencontainers/tob/blob/d2f9d68c1332870e40693fe077d311e0742bc73d/code-of-conduct.md).
68
69
69
-
## Discuss your design
70
+
###Discuss your design
70
71
71
72
The project welcomes submissions, but please let everyone know what you are working on.
72
73
@@ -77,24 +78,24 @@ It also guarantees that the design is sound before code is written; a GitHub pul
77
78
Typos and grammatical errors can go straight to a pull-request.
78
79
When in doubt, start on the [mailing-list](#mailing-list).
79
80
80
-
## Weekly Call
81
+
###Weekly Call
81
82
82
83
The contributors and maintainers of all OCI projects have a weekly meeting Wednesdays at 2:00 PM (USA Pacific).
83
84
Everyone is welcome to participate via [UberConference web][UberConference] or audio-only: 415-968-0849 (no PIN needed.)
84
85
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.
85
86
Minutes are posted to the [mailing list](#mailing-list) and minutes from past calls are archived to the [wiki](https://github.com/opencontainers/runtime-spec/wiki) for those who are unable to join the call.
86
87
87
-
## Mailing List
88
+
###Mailing List
88
89
89
90
You can subscribe and join the mailing list on [Google Groups](https://groups.google.com/a/opencontainers.org/forum/#!forum/dev).
90
91
91
-
## IRC
92
+
###IRC
92
93
93
94
OCI discussion happens on #opencontainers on Freenode ([logs][irc-logs]).
94
95
95
-
## Git commit
96
+
###Git commit
96
97
97
-
### Sign your work
98
+
####Sign your work
98
99
99
100
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.
100
101
The rules are pretty simple: if you can certify the below (from [developercertificate.org](http://developercertificate.org/)):
@@ -146,7 +147,7 @@ using your real name (sorry, no pseudonyms or anonymous contributions.)
146
147
147
148
You can add the sign off when creating the git commit via `git commit -s`.
148
149
149
-
### Commit Style
150
+
####Commit Style
150
151
151
152
Simple house-keeping for clean git history.
152
153
Read more on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) or the Discussion section of [`git-commit(1)`](http://git-scm.com/docs/git-commit).
0 commit comments