Commit Graph

103 Commits

Author SHA1 Message Date
Steven Hartland a887fc3f2d Add godoc links to README.md files
Add godoc links to README.md files for runc and libcontainer so its easy to access the golang documentation.

Signed-off-by: Steven Hartland <steven.hartland@multiplay.co.uk>
2017-01-21 18:21:03 +00:00
Xianglin Gao 27f7490b7e Add badge for Go Report Card
Signed-off-by: Xianglin Gao <xlgao@zju.edu.cn>
2017-01-04 16:52:29 +08:00
Chris Aniszczyk 165fba9e4b Add Travis CI badge to README
https://travis-ci.org/opencontainers/runc

Signed-off-by: Chris Aniszczyk <caniszczyk@gmail.com>
2017-01-03 19:31:29 -06:00
Aleksa Sarai ac422aa545
*: add information about security mailing list
Signed-off-by: Aleksa Sarai <asarai@suse.de>
2016-12-03 18:54:53 +11:00
Michael Crosby 603c151e6c Move ambient capabilties behind build tag
This moves the ambient capability support behind an `ambient` build tag
so that it is only compiled upon request.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2016-11-02 10:59:59 -07:00
Harry Zhang 4d76a85559 Clarify libseccomp-devel in guide
Signed-off-by: Harry Zhang <harryz@hyper.sh>
2016-10-31 03:27:05 -04:00
rajasec 4cfbd2555d Small typo in README
Signed-off-by: rajasec <rajasec79@gmail.com>

Fixing small typo in README

Signed-off-by: rajasec <rajasec79@gmail.com>
2016-10-23 19:08:17 +05:30
rajasec c4ffabc033 Typo in README.md
Signed-off-by: rajasec <rajasec79@gmail.com>
2016-09-06 20:24:25 +05:30
Jonathan Boulle 67a6e679c6 Fix runtime-spec repository reference in README
Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
2016-08-31 18:43:57 +02:00
Michael Crosby 762ff42a49 Update readme for create start
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2016-06-10 16:37:55 -07:00
Mrunal Patel b12fbe0b15 readme: Mention the go 1.6 requirement in the README for building runc
Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2016-06-09 16:23:43 -07:00
rajasec 0307c88ee9 Updating README for starting the container
Signed-off-by: rajasec <rajasec79@gmail.com>

Updating README for starting the container

Signed-off-by: rajasec <rajasec79@gmail.com>

Updating README files for container start

Signed-off-by: rajasec <rajasec79@gmail.com>

updating README files for container start

Signed-off-by: rajasec <rajasec79@gmail.com>
2016-06-05 14:41:58 +05:30
rajasec b3503c3516 Changing OCF to OCI in README
Signed-off-by: rajasec <rajasec79@gmail.com>
2016-05-28 14:28:17 +05:30
rajasec 0015f86cf3 Updating README for runc path
Signed-off-by: rajasec <rajasec79@gmail.com>
2016-04-23 22:00:08 +05:30
Mrunal Patel b407ca684d Merge pull request #749 from jonboulle/master
Fix OCI reference in README
2016-04-14 12:18:39 -07:00
Antonio Murdaca 18f60ae906 README.md: simplify Docker image example
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
2016-04-13 23:09:58 +02:00
Jonathan Boulle bf8e444f77 Fix OCI reference in README
Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
2016-04-13 19:38:58 +02:00
Michael Crosby f417e993d0 Update spec to v0.5.0
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2016-04-12 14:11:40 -07:00
Alberto Leal 7ec83f8b38 Typo on Readme file
Signed-off-by: Alberto Leal <albertonb@gmail.com>
2016-04-06 15:15:11 +01:00
Michael Crosby a7278cad98 Require containerd id as arg 1
Closes #532

This requires the container id to always be passed to all runc commands
as arg one on the cli.  This was the result of the last OCI meeting and
how operations work with the spec.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2016-02-09 11:20:55 -08:00
Michael Crosby 3baae2d525 Update runc for devices changes
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2016-02-08 13:15:12 -08:00
Marcos Nils 7871e987ca Add build status badge
Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
2016-01-22 16:47:30 -03:00
Qiang Huang bf00d9c367 Remove the timeframe for v1 spec
Fixes: #429

We missed the former one and haven't got a new one, remove
it from README to avoid confusing.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-12-11 09:11:17 +08:00
Mrunal Patel 36015470c2 Merge pull request #371 from hqhq/hq_fix_readme
README.md: clarify OCI JSON files
2015-11-24 15:00:36 -08:00
Qiang Huang 826c92faed README.md: fix description for runc with systemd
Fix the command and elaborate the instruction.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-10-28 04:21:39 -04:00
Qiang Huang d72c391402 README.md: clarify OCI JSON files
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-10-27 15:34:38 +08:00
Lai Jiangshan 7a54c7bd7b README.md: Update the config example
* version in the config example is advanced to 0.1.0
* rootfsPropagation in config.json is removed
    (The same one is already in runtime.json)
* rlimit time is changed from magic number to name(string)
* add pids cgroup
* add cgroup path

After this change applied, the example config in this README.md
is consistent with the result of `runc spec`.

Signed-off-by: Lai Jiangshan <jiangshanlai@gmail.com>
2015-09-19 08:46:55 +08:00
Mrunal Patel ec37110957 Update README for the CAP prefix change
Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2015-09-15 14:44:12 -04:00
Mrunal Patel 4ab132458f Merge pull request #242 from LK4D4/adjust_spec
Adjust runc to new opencontainers/specs version
2015-09-15 10:21:58 -07:00
Alexander Morozov ea5032bc5e Adjust runc to new opencontainers/specs version
I deleted possibility to specify config file from commands for now.
Until we decide how it'll be done. Also I changed runc spec interface to
write config files instead of output them.

Signed-off-by: Alexander Morozov <lk4d4@docker.com>
2015-09-15 08:35:25 -07:00
Qiang Huang 088fd3f6df Add testing docs in README
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-09-15 08:30:28 +08:00
Michael Crosby 3200c16937 Add all support build tags for runc features
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-09-11 12:12:18 -07:00
Michael Crosby a8e0185d97 Add seccomp build tag
Add a seccomp build tag and also support in the Makefile to add or
remove build tags.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-09-11 12:03:57 -07:00
Mrunal Patel 8b18c9af08 Merge pull request #229 from booyaa/doc_linux_only
Add caveat will only build on Linux as per #9
2015-08-28 11:29:07 -07:00
Michael Crosby 5e75a12ec1 Merge pull request #224 from marcosnils/master
Update README config file devices
2015-08-28 10:46:09 -07:00
Michael Crosby b9c32b3869 Merge pull request #223 from rajasec/rlimitspec
Adding rlimit in spec
2015-08-28 10:34:59 -07:00
Mark Sta Ana a491b93ff3 Add caveat will only build on Linux as per #9
Signed-off-by: Mark Sta Ana <booyaabooyaabooyaa@gmail.com>
2015-08-27 08:50:46 +01:00
Rajasekaran fc97aa44e1 Updating README for rlimit
Signed-off-by: Rajasekaran <rajasec79@gmail.com>

Fixing indentation issue in README

Signed-off-by: Rajasekaran <rajasec79@gmail.com>
2015-08-25 06:02:59 +05:30
Marcos Lilljedahl 241306b95c Update README config file devices
Signed-off-by: Marcos Lilljedahl <marcosnils@gmail.com>
2015-08-23 12:52:50 -03:00
Doug Davis 714ae2acc9 Add a 'start' command
When any non-global-flag parameter appears on the command line make sure
there's a "command" even in the 'start' (run) case to ensure its not
ambiguous as to what the arg is. For example, w/o this fix its not
clear if
   runc foo
means 'foo' is the name of a config file or an unknown command.  Or worse,
you can't name a config file the same a ANY command, even future (yet to
be created) commands.

We should fix this now before we ship 1.0 and are forced to support this
ambiguous case for a long time.

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-08-21 15:26:34 -07:00
Doug Davis 88de2aee5a Minor update to usage/help text
Seemed a little out of date

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-08-10 12:56:53 -07:00
William Temple a5d98a64e0 Changed README.md to refer to "pid" namespace rather than "process."
Signed-off-by: William Temple <wtemple@redhat.com>
2015-08-05 14:09:53 -04:00
Phil Estes 7082ed370e Update README.md to correct comment about spec and user
Now that the generated spec (and the example above in the README) use
uid/gid and don't have the hardcoded `daemon` entry, the statement about
changing `daemon` to `root` no longer applies.  Also added a comment
about using the `runc spec` command to generate `config.json`.

Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp)
2015-07-28 10:27:09 -04:00
Mrunal Patel 42aa891a6b Merge pull request #91 from hqhq/hq_add_cgroup_mount
Add cgroup mount in the recommended config
2015-07-15 09:51:24 -07:00
Qiang Huang d7181a73e4 Add cgroup mount in the recommended config
And allow cgroup mount take flags from user configs.
As we show ro in the recommendation, so hard-coded
read-only flag should be removed.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-07-15 09:31:39 +08:00
Zefan Li 6bd71ad6a4 Add memory swappiness support
- Initialize swappiness to -1 for the default config.json
- Pass swappiness from config.json to libcontainer config

Signed-off-by: Zefan Li <lizefan@huawei.com>
2015-07-14 10:43:43 +08:00
zenlin cb561f54f2 Fix bug in Readme.md,change GOPATH to GOPATH/src
to avoid missunderstanding of how to build.

Signed-off-by: zenlin <linzhinan@huawei.com>
2015-07-08 19:10:22 +08:00
Michael Crosby 845fc65e54 Create linux spec for runc spec command
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-07-02 13:45:56 -07:00
Michael Crosby e15b86edb9 Add user struct based on spec implementation.
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-07-02 13:45:27 -07:00
Mrunal Patel b3eaad364f README changes for the newer spec format.
Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2015-06-30 13:02:34 -04:00