Skip to content

Commit

Permalink
Merge pull request openshift#40 from crosbymichael/api-readme
Browse files Browse the repository at this point in the history
Update readme with API change explination
  • Loading branch information
vmarmol committed Jun 20, 2014
2 parents 2391c3d + 78a5a42 commit 902319a
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## libcontainer - reference implementation for containers

### Note on API changes:

Please bear with us while we work on making the libcontainer API stable and something that we can support long term. We are currently discussing the API with the community, therefore, if you currently depend on libcontainer please pin your dependency at a specific tag or commit id. Please join the discussion and help shape the API.

#### Background

libcontainer specifies configuration options for what a container is. It provides a native Go implementation
Expand All @@ -13,7 +17,7 @@ a `container.json` file is placed with the runtime configuration for how the pro
should be contained and run. Environment, networking, and different capabilities for the
process are specified in this file. The configuration is used for each process executed inside the container.

See the `sampel_configs` folder for examples of what the container configuration should look like.
See the `sample_configs` folder for examples of what the container configuration should look like.

Using this configuration and the current directory holding the rootfs for a process, one can use libcontainer to exec the container. Running the life of the namespace, a `pid` file
is written to the current directory with the pid of the namespaced process to the external world. A client can use this pid to wait, kill, or perform other operation with the container. If a user tries to run a new process inside an existing container with a live namespace, the namespace will be joined by the new process.
Expand Down

0 comments on commit 902319a

Please sign in to comment.