Move libcontainer documenation to root of repo
This moves much of the documentation on contributing and maintainer the codebase from the libcontainer sub directory to the root of the repo. Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
This commit is contained in:
Michael Crosby
parent
8d0ae52adc
commit
f637539def
|
|
@ -0,0 +1,117 @@
|
||||||
|
## Contribution Guidelines
|
||||||
|
|
||||||
|
### Pull requests are always welcome
|
||||||
|
|
||||||
|
We are always thrilled to receive pull requests, and do our best to
|
||||||
|
process them as fast as possible. Not sure if that typo is worth a pull
|
||||||
|
request? Do it! We will appreciate it.
|
||||||
|
|
||||||
|
If your pull request is not accepted on the first try, don't be
|
||||||
|
discouraged! If there's a problem with the implementation, hopefully you
|
||||||
|
received feedback on what to improve.
|
||||||
|
|
||||||
|
We're trying very hard to keep runc lean and focused. We don't want it
|
||||||
|
to do everything for everybody. This means that we might decide against
|
||||||
|
incorporating a new feature. However, there might be a way to implement
|
||||||
|
that feature *on top of* runc.
|
||||||
|
|
||||||
|
|
||||||
|
### Conventions
|
||||||
|
|
||||||
|
Fork the repo and make changes on your fork in a feature branch:
|
||||||
|
|
||||||
|
- If it's a bugfix branch, name it XXX-something where XXX is the number of the
|
||||||
|
issue
|
||||||
|
- If it's a feature branch, create an enhancement issue to announce your
|
||||||
|
intentions, and name it XXX-something where XXX is the number of the issue.
|
||||||
|
|
||||||
|
Submit unit tests for your changes. Go has a great test framework built in; use
|
||||||
|
it! Take a look at existing tests for inspiration. Run the full test suite on
|
||||||
|
your branch before submitting a pull request.
|
||||||
|
|
||||||
|
Update the documentation when creating or modifying features. Test
|
||||||
|
your documentation changes for clarity, concision, and correctness, as
|
||||||
|
well as a clean documentation build. See ``docs/README.md`` for more
|
||||||
|
information on building the docs and how docs get released.
|
||||||
|
|
||||||
|
Write clean code. Universally formatted code promotes ease of writing, reading,
|
||||||
|
and maintenance. Always run `gofmt -s -w file.go` on each changed file before
|
||||||
|
committing your changes. Most editors have plugins that do this automatically.
|
||||||
|
|
||||||
|
Pull requests descriptions should be as clear as possible and include a
|
||||||
|
reference to all the issues that they address.
|
||||||
|
|
||||||
|
Pull requests must not contain commits from other users or branches.
|
||||||
|
|
||||||
|
Commit messages must start with a capitalized and short summary (max. 50
|
||||||
|
chars) written in the imperative, followed by an optional, more detailed
|
||||||
|
explanatory text which is separated from the summary by an empty line.
|
||||||
|
|
||||||
|
Code review comments may be added to your pull request. Discuss, then make the
|
||||||
|
suggested modifications and push additional commits to your feature branch. Be
|
||||||
|
sure to post a comment after pushing. The new commits will show up in the pull
|
||||||
|
request automatically, but the reviewers will not be notified unless you
|
||||||
|
comment.
|
||||||
|
|
||||||
|
Before the pull request is merged, make sure that you squash your commits into
|
||||||
|
logical units of work using `git rebase -i` and `git push -f`. After every
|
||||||
|
commit the test suite should be passing. Include documentation changes in the
|
||||||
|
same commit so that a revert would remove all traces of the feature or fix.
|
||||||
|
|
||||||
|
Commits that fix or close an issue should include a reference like `Closes #XXX`
|
||||||
|
or `Fixes #XXX`, which will automatically close the issue when merged.
|
||||||
|
|
||||||
|
### 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
|
||||||
|
[developercertificate.org](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`.
|
||||||
|
|
@ -4,4 +4,3 @@ Victor Marmol <vmarmol@google.com> (@vmarmol)
|
||||||
Mrunal Patel <mpatel@redhat.com> (@mrunalp)
|
Mrunal Patel <mpatel@redhat.com> (@mrunalp)
|
||||||
Alexandr Morozov <lk4d4@docker.com> (@LK4D4)
|
Alexandr Morozov <lk4d4@docker.com> (@LK4D4)
|
||||||
Daniel, Dao Quang Minh <dqminh89@gmail.com> (@dqminh)
|
Daniel, Dao Quang Minh <dqminh89@gmail.com> (@dqminh)
|
||||||
update-vendor.sh: Tianon Gravi <admwiggin@gmail.com> (@tianon)
|
|
||||||
|
|
@ -1,9 +1,7 @@
|
||||||
# The libcontainer Maintainers' Guide
|
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
Dear maintainer. Thank you for investing the time and energy to help
|
Dear maintainer. Thank you for investing the time and energy to help
|
||||||
make libcontainer as useful as possible. Maintaining a project is difficult,
|
make runc as useful as possible. Maintaining a project is difficult,
|
||||||
sometimes unrewarding work. Sure, you will get to contribute cool
|
sometimes unrewarding work. Sure, you will get to contribute cool
|
||||||
features to the project. But most of your time will be spent reviewing,
|
features to the project. But most of your time will be spent reviewing,
|
||||||
cleaning up, documenting, answering questions, justifying design
|
cleaning up, documenting, answering questions, justifying design
|
||||||
|
|
@ -34,9 +32,9 @@ It is every maintainer's responsibility to:
|
||||||
|
|
||||||
## How are decisions made?
|
## How are decisions made?
|
||||||
|
|
||||||
Short answer: with pull requests to the libcontainer repository.
|
Short answer: with pull requests to the runc repository.
|
||||||
|
|
||||||
libcontainer is an open-source project with an open design philosophy. This
|
runc is an open-source project with an open design philosophy. This
|
||||||
means that the repository is the source of truth for EVERY aspect of the
|
means that the repository is the source of truth for EVERY aspect of the
|
||||||
project, including its philosophy, design, roadmap and APIs. *If it's
|
project, including its philosophy, design, roadmap and APIs. *If it's
|
||||||
part of the project, it's in the repo. It's in the repo, it's part of
|
part of the project, it's in the repo. It's in the repo, it's part of
|
||||||
|
|
@ -47,7 +45,7 @@ repository. An implementation change is a change to the source code. An
|
||||||
API change is a change to the API specification. A philosophy change is
|
API change is a change to the API specification. A philosophy change is
|
||||||
a change to the philosophy manifesto. And so on.
|
a change to the philosophy manifesto. And so on.
|
||||||
|
|
||||||
All decisions affecting libcontainer, big and small, follow the same 3 steps:
|
All decisions affecting runc, big and small, follow the same 3 steps:
|
||||||
|
|
||||||
* Step 1: Open a pull request. Anyone can do this.
|
* Step 1: Open a pull request. Anyone can do this.
|
||||||
|
|
||||||
|
|
@ -65,7 +63,7 @@ by anyone is denoted by adding a comment in the pull request: `LGTM`.
|
||||||
However, only currently listed `MAINTAINERS` are counted towards the required
|
However, only currently listed `MAINTAINERS` are counted towards the required
|
||||||
two LGTMs.
|
two LGTMs.
|
||||||
|
|
||||||
libcontainer follows the timeless, highly efficient and totally unfair system
|
runc follows the timeless, highly efficient and totally unfair system
|
||||||
known as [Benevolent dictator for life](http://en.wikipedia.org/wiki/Benevolent_Dictator_for_Life), with Michael Crosby in the role of BDFL.
|
known as [Benevolent dictator for life](http://en.wikipedia.org/wiki/Benevolent_Dictator_for_Life), with Michael Crosby in the role of BDFL.
|
||||||
This means that all decisions are made by default by Michael. Since making
|
This means that all decisions are made by default by Michael. Since making
|
||||||
every decision himself would be highly un-scalable, in practice decisions
|
every decision himself would be highly un-scalable, in practice decisions
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
libcontainer
|
runc
|
||||||
|
|
||||||
Copyright 2012-2015 Docker, Inc.
|
Copyright 2012-2015 Docker, Inc.
|
||||||
|
|
||||||
This product includes software developed at Docker, Inc. (http://www.docker.com).
|
This product includes software developed at Docker, Inc. (http://www.docker.com).
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# libcontainer Principles
|
# runc principles
|
||||||
|
|
||||||
In the design and development of libcontainer we try to follow these principles:
|
In the design and development of runc and libcontainer we try to follow these principles:
|
||||||
|
|
||||||
(Work in progress)
|
(Work in progress)
|
||||||
|
|
||||||
|
|
@ -1,257 +0,0 @@
|
||||||
# The libcontainer Contributors' Guide
|
|
||||||
|
|
||||||
Want to hack on libcontainer? Awesome! Here are instructions to get you
|
|
||||||
started. They are probably not perfect, please let us know if anything
|
|
||||||
feels wrong or incomplete.
|
|
||||||
|
|
||||||
## Reporting Issues
|
|
||||||
|
|
||||||
When reporting [issues](https://github.com/opencontainers/runc/libcontainer/issues)
|
|
||||||
on GitHub please include your host OS (Ubuntu 12.04, Fedora 19, etc),
|
|
||||||
the output of `uname -a`. Please include the steps required to reproduce
|
|
||||||
the problem if possible and applicable.
|
|
||||||
This information will help us review and fix your issue faster.
|
|
||||||
|
|
||||||
## Development Environment
|
|
||||||
|
|
||||||
### Requirements
|
|
||||||
|
|
||||||
For best results, use a Linux development environment.
|
|
||||||
The following packages are required to compile libcontainer natively.
|
|
||||||
|
|
||||||
- Golang 1.3
|
|
||||||
- GCC
|
|
||||||
- git
|
|
||||||
- cgutils
|
|
||||||
|
|
||||||
You can develop on OSX, but you are limited to Dockerfile-based builds only.
|
|
||||||
|
|
||||||
### Building libcontainer from Dockerfile
|
|
||||||
|
|
||||||
make all
|
|
||||||
|
|
||||||
This is the easiest way of building libcontainer.
|
|
||||||
As this build is done using Docker, you can even run this from [OSX](https://github.com/boot2docker/boot2docker)
|
|
||||||
|
|
||||||
### Testing changes with "nsinit"
|
|
||||||
|
|
||||||
make sh
|
|
||||||
|
|
||||||
This will create an container that runs `nsinit exec sh` on a busybox rootfs with the configuration from ['minimal.json'](https://github.com/opencontainers/runc/libcontainer/blob/master/sample_configs/minimal.json).
|
|
||||||
Like the previous command, you can run this on OSX too!
|
|
||||||
|
|
||||||
### Building libcontainer directly
|
|
||||||
|
|
||||||
> Note: You should add the `vendor` directory to your GOPATH to use the vendored libraries
|
|
||||||
|
|
||||||
./update-vendor.sh
|
|
||||||
go get -d ./...
|
|
||||||
make direct-build
|
|
||||||
# Run the tests
|
|
||||||
make direct-test-short | egrep --color 'FAIL|$'
|
|
||||||
# Run all the test
|
|
||||||
make direct-test | egrep --color 'FAIL|$'
|
|
||||||
|
|
||||||
### Testing Changes with "nsinit" directly
|
|
||||||
|
|
||||||
To test a change:
|
|
||||||
|
|
||||||
# Install nsinit
|
|
||||||
make direct-install
|
|
||||||
|
|
||||||
# Optional, add a docker0 bridge
|
|
||||||
ip link add docker0 type bridge
|
|
||||||
ifconfig docker0 172.17.0.1/16 up
|
|
||||||
|
|
||||||
mkdir testfs
|
|
||||||
curl -sSL https://github.com/jpetazzo/docker-busybox/raw/buildroot-2014.02/rootfs.tar | tar -xC testfs
|
|
||||||
cd testfs
|
|
||||||
cp <your-sample-config.json> container.json
|
|
||||||
nsinit exec sh
|
|
||||||
|
|
||||||
## Contribution Guidelines
|
|
||||||
|
|
||||||
### Pull requests are always welcome
|
|
||||||
|
|
||||||
We are always thrilled to receive pull requests, and do our best to
|
|
||||||
process them as fast as possible. Not sure if that typo is worth a pull
|
|
||||||
request? Do it! We will appreciate it.
|
|
||||||
|
|
||||||
If your pull request is not accepted on the first try, don't be
|
|
||||||
discouraged! If there's a problem with the implementation, hopefully you
|
|
||||||
received feedback on what to improve.
|
|
||||||
|
|
||||||
We're trying very hard to keep libcontainer lean and focused. We don't want it
|
|
||||||
to do everything for everybody. This means that we might decide against
|
|
||||||
incorporating a new feature. However, there might be a way to implement
|
|
||||||
that feature *on top of* libcontainer.
|
|
||||||
|
|
||||||
### Discuss your design on the mailing list
|
|
||||||
|
|
||||||
We recommend discussing your plans [on the mailing
|
|
||||||
list](https://groups.google.com/forum/?fromgroups#!forum/libcontainer)
|
|
||||||
before starting to code - especially for more ambitious contributions.
|
|
||||||
This gives other contributors a chance to point you in the right
|
|
||||||
direction, give feedback on your design, and maybe point out if someone
|
|
||||||
else is working on the same thing.
|
|
||||||
|
|
||||||
### Create issues...
|
|
||||||
|
|
||||||
Any significant improvement should be documented as [a GitHub
|
|
||||||
issue](https://github.com/opencontainers/runc/libcontainer/issues) before anybody
|
|
||||||
starts working on it.
|
|
||||||
|
|
||||||
### ...but check for existing issues first!
|
|
||||||
|
|
||||||
Please take a moment to check that an issue doesn't already exist
|
|
||||||
documenting your bug report or improvement proposal. If it does, it
|
|
||||||
never hurts to add a quick "+1" or "I have this problem too". This will
|
|
||||||
help prioritize the most common problems and requests.
|
|
||||||
|
|
||||||
### Conventions
|
|
||||||
|
|
||||||
Fork the repo and make changes on your fork in a feature branch:
|
|
||||||
|
|
||||||
- If it's a bugfix branch, name it XXX-something where XXX is the number of the
|
|
||||||
issue
|
|
||||||
- If it's a feature branch, create an enhancement issue to announce your
|
|
||||||
intentions, and name it XXX-something where XXX is the number of the issue.
|
|
||||||
|
|
||||||
Submit unit tests for your changes. Go has a great test framework built in; use
|
|
||||||
it! Take a look at existing tests for inspiration. Run the full test suite on
|
|
||||||
your branch before submitting a pull request.
|
|
||||||
|
|
||||||
Update the documentation when creating or modifying features. Test
|
|
||||||
your documentation changes for clarity, concision, and correctness, as
|
|
||||||
well as a clean documentation build. See ``docs/README.md`` for more
|
|
||||||
information on building the docs and how docs get released.
|
|
||||||
|
|
||||||
Write clean code. Universally formatted code promotes ease of writing, reading,
|
|
||||||
and maintenance. Always run `gofmt -s -w file.go` on each changed file before
|
|
||||||
committing your changes. Most editors have plugins that do this automatically.
|
|
||||||
|
|
||||||
Pull requests descriptions should be as clear as possible and include a
|
|
||||||
reference to all the issues that they address.
|
|
||||||
|
|
||||||
Pull requests must not contain commits from other users or branches.
|
|
||||||
|
|
||||||
Commit messages must start with a capitalized and short summary (max. 50
|
|
||||||
chars) written in the imperative, followed by an optional, more detailed
|
|
||||||
explanatory text which is separated from the summary by an empty line.
|
|
||||||
|
|
||||||
Code review comments may be added to your pull request. Discuss, then make the
|
|
||||||
suggested modifications and push additional commits to your feature branch. Be
|
|
||||||
sure to post a comment after pushing. The new commits will show up in the pull
|
|
||||||
request automatically, but the reviewers will not be notified unless you
|
|
||||||
comment.
|
|
||||||
|
|
||||||
Before the pull request is merged, make sure that you squash your commits into
|
|
||||||
logical units of work using `git rebase -i` and `git push -f`. After every
|
|
||||||
commit the test suite should be passing. Include documentation changes in the
|
|
||||||
same commit so that a revert would remove all traces of the feature or fix.
|
|
||||||
|
|
||||||
Commits that fix or close an issue should include a reference like `Closes #XXX`
|
|
||||||
or `Fixes #XXX`, which will automatically close the issue when merged.
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
|
|
||||||
Make sure you include suitable tests, preferably unit tests, in your pull request
|
|
||||||
and that all the tests pass.
|
|
||||||
|
|
||||||
*Instructions for running tests to be added.*
|
|
||||||
|
|
||||||
### Merge approval
|
|
||||||
|
|
||||||
libcontainer maintainers use LGTM (looks good to me) in comments on the code review
|
|
||||||
to indicate acceptance.
|
|
||||||
|
|
||||||
A change requires LGTMs from at lease two maintainers. One of those must come from
|
|
||||||
a maintainer of the component affected. For example, if a change affects `netlink/`
|
|
||||||
and `security`, it needs at least one LGTM from a maintainer of each. Maintainers
|
|
||||||
only need one LGTM as presumably they LGTM their own change.
|
|
||||||
|
|
||||||
For more details see [MAINTAINERS.md](MAINTAINERS.md)
|
|
||||||
|
|
||||||
### 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
|
|
||||||
[developercertificate.org](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:
|
|
||||||
|
|
||||||
Docker-DCO-1.1-Signed-off-by: Joe Smith <joe.smith@email.com> (github: github_handle)
|
|
||||||
|
|
||||||
using your real name (sorry, no pseudonyms or anonymous contributions.)
|
|
||||||
|
|
||||||
One way to automate this, is customise your get ``commit.template`` by adding
|
|
||||||
a ``prepare-commit-msg`` hook to your libcontainer checkout:
|
|
||||||
|
|
||||||
```
|
|
||||||
curl -o .git/hooks/prepare-commit-msg https://raw.githubusercontent.com/docker/docker/master/contrib/prepare-commit-msg.hook && chmod +x .git/hooks/prepare-commit-msg
|
|
||||||
```
|
|
||||||
|
|
||||||
* Note: the above script expects to find your GitHub user name in ``git config --get github.user``
|
|
||||||
|
|
||||||
#### Small patch exception
|
|
||||||
|
|
||||||
There are several exceptions to the signing requirement. Currently these are:
|
|
||||||
|
|
||||||
* Your patch fixes spelling or grammar errors.
|
|
||||||
* Your patch is a single line change to documentation contained in the
|
|
||||||
`docs` directory.
|
|
||||||
* Your patch fixes Markdown formatting or syntax errors in the
|
|
||||||
documentation contained in the `docs` directory.
|
|
||||||
|
|
||||||
If you have any questions, please refer to the FAQ in the [docs](to be written)
|
|
||||||
|
|
||||||
### How can I become a maintainer?
|
|
||||||
|
|
||||||
* Step 1: learn the component inside out
|
|
||||||
* Step 2: make yourself useful by contributing code, bugfixes, support etc.
|
|
||||||
* Step 3: volunteer on the irc channel (#libcontainer@freenode)
|
|
||||||
|
|
||||||
Don't forget: being a maintainer is a time investment. Make sure you will have time to make yourself available.
|
|
||||||
You don't have to be a maintainer to make a difference on the project!
|
|
||||||
|
|
||||||
|
|
@ -1,25 +0,0 @@
|
||||||
FROM golang:1.4
|
|
||||||
|
|
||||||
RUN echo "deb http://ftp.us.debian.org/debian testing main contrib" >> /etc/apt/sources.list
|
|
||||||
RUN apt-get update && apt-get install -y iptables criu=1.5.2-1 && rm -rf /var/lib/apt/lists/*
|
|
||||||
|
|
||||||
RUN go get golang.org/x/tools/cmd/cover
|
|
||||||
|
|
||||||
ENV GOPATH $GOPATH:/go/src/github.com/opencontainers/runc/libcontainer/vendor
|
|
||||||
RUN go get github.com/docker/docker/pkg/term
|
|
||||||
|
|
||||||
# setup a playground for us to spawn containers in
|
|
||||||
RUN mkdir /busybox && \
|
|
||||||
curl -sSL 'https://github.com/jpetazzo/docker-busybox/raw/buildroot-2014.11/rootfs.tar' | tar -xC /busybox
|
|
||||||
|
|
||||||
RUN curl -sSL https://raw.githubusercontent.com/docker/docker/master/hack/dind -o /dind && \
|
|
||||||
chmod +x /dind
|
|
||||||
|
|
||||||
COPY . /go/src/github.com/opencontainers/runc/libcontainer
|
|
||||||
WORKDIR /go/src/github.com/opencontainers/runc/libcontainer
|
|
||||||
RUN cp sample_configs/minimal.json /busybox/container.json
|
|
||||||
|
|
||||||
RUN make direct-install
|
|
||||||
|
|
||||||
ENTRYPOINT ["/dind"]
|
|
||||||
CMD ["make", "direct-test"]
|
|
||||||
|
|
@ -1,191 +0,0 @@
|
||||||
|
|
||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
Copyright 2014 Docker, Inc.
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
||||||
|
|
@ -1,5 +1,3 @@
|
||||||
## libcontainer - reference implementation for containers [](https://jenkins.dockerproject.org/job/Libcontainer%20Master/)
|
|
||||||
|
|
||||||
Libcontainer provides a native Go implementation for creating containers
|
Libcontainer provides a native Go implementation for creating containers
|
||||||
with namespaces, cgroups, capabilities, and filesystem access controls.
|
with namespaces, cgroups, capabilities, and filesystem access controls.
|
||||||
It allows you to manage the lifecycle of the container performing additional operations
|
It allows you to manage the lifecycle of the container performing additional operations
|
||||||
|
|
@ -147,19 +145,8 @@ If you don't already have `criu` installed, you can build it from source, follo
|
||||||
generated when building libcontainer with docker.
|
generated when building libcontainer with docker.
|
||||||
|
|
||||||
|
|
||||||
#### Future
|
|
||||||
See the [roadmap](ROADMAP.md).
|
|
||||||
|
|
||||||
## Copyright and license
|
## Copyright and license
|
||||||
|
|
||||||
Code and documentation copyright 2014 Docker, inc. Code released under the Apache 2.0 license.
|
Code and documentation copyright 2014 Docker, inc. Code released under the Apache 2.0 license.
|
||||||
Docs released under Creative commons.
|
Docs released under Creative commons.
|
||||||
|
|
||||||
## Hacking on libcontainer
|
|
||||||
|
|
||||||
First of all, please familiarise yourself with the [libcontainer Principles](PRINCIPLES.md).
|
|
||||||
|
|
||||||
If you're a *contributor* or aspiring contributor, you should read the [Contributors' Guide](CONTRIBUTING.md).
|
|
||||||
|
|
||||||
If you're a *maintainer* or aspiring maintainer, you should read the [Maintainers' Guide](MAINTAINERS_GUIDE.md) and
|
|
||||||
"How can I become a maintainer?" in the Contributors' Guide.
|
|
||||||
|
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
# libcontainer: what's next?
|
|
||||||
|
|
||||||
This document is a high-level overview of where we want to take libcontainer next.
|
|
||||||
It is a curated selection of planned improvements which are either important, difficult, or both.
|
|
||||||
|
|
||||||
For a more complete view of planned and requested improvements, see [the Github issues](https://github.com/opencontainers/runc/libcontainer/issues).
|
|
||||||
|
|
||||||
To suggest changes to the roadmap, including additions, please write the change as if it were already in effect, and make a pull request.
|
|
||||||
|
|
||||||
## Broader kernel support
|
|
||||||
|
|
||||||
Our goal is to make libcontainer run everywhere, but currently libcontainer requires Linux version 3.8 or higher. If you’re deploying new machines for the purpose of running libcontainer, this is a fairly easy requirement to meet. However, if you’re adding libcontainer to an existing deployment, you may not have the flexibility to update and patch the kernel.
|
|
||||||
|
|
||||||
## Cross-architecture support
|
|
||||||
|
|
||||||
Our goal is to make libcontainer run everywhere. Recently libcontainer has
|
|
||||||
expanded from its initial support for x86_64 systems to include POWER (ppc64
|
|
||||||
little and big endian variants), IBM System z (s390x 64-bit), and ARM. We plan
|
|
||||||
to continue expanding architecture support such that libcontainer containers
|
|
||||||
can be created and used on more architectures.
|
|
||||||
Loading…
Reference in New Issue