1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
moby--moby/man
Erik St. Martin 56f77d5ade Implementing support for --cpu-rt-period and --cpu-rt-runtime so that
containers may specify these cgroup values at runtime. This will allow
processes to change their priority to real-time within the container
when CONFIG_RT_GROUP_SCHED is enabled in the kernel. See #22380.

Also added sanity checks for the new --cpu-rt-runtime and --cpu-rt-period
flags to ensure that that the kernel supports these features and that
runtime is not greater than period.

Daemon will support a --cpu-rt-runtime flag to initialize the parent
cgroup on startup, this prevents the administrator from alotting runtime
to docker after each restart.

There are additional checks that could be added but maybe too far? Check
parent cgroups to ensure values are <= parent, inspecting rtprio ulimit
and issuing a warning.

Signed-off-by: Erik St. Martin <alakriti@gmail.com>
2016-10-26 11:33:06 -04:00
..
docker-attach.1.md Fix a couple of typos in the docs of docker attach 2016-06-06 19:06:50 -07:00
docker-build.1.md add --network option for docker build 2016-10-25 10:25:36 -07:00
docker-commit.1.md Document valid chars in image name and tag 2016-05-21 19:49:19 +01:00
docker-config-json.5.md man: mv config-json.5 to docker-config-json.5 2016-06-03 15:28:19 +02:00
docker-cp.1.md update docs/reference/commandline/cp.md 2016-05-24 11:09:38 +00:00
docker-create.1.md Implementing support for --cpu-rt-period and --cpu-rt-runtime so that 2016-10-26 11:33:06 -04:00
docker-diff.1.md
docker-events.1.md Fix typs from go to Go 2016-10-18 19:40:16 +08:00
docker-exec.1.md Exec: Add ability to set environment variables 2016-10-19 12:39:25 -02:00
docker-export.1.md various man page typos 2015-10-13 11:52:14 -04:00
docker-history.1.md remove =false from options that default to false in the docs 2015-12-23 07:11:35 -08:00
docker-images.1.md fix the man page and zsh completion for docker images 2016-09-02 09:52:10 +00:00
docker-import.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-info.1.md Fix typs from go to Go 2016-10-18 19:40:16 +08:00
docker-inspect.1.md Refactor docker inspect to work on all types 2016-08-25 16:29:08 -07:00
docker-kill.1.md Fix man pages 2015-11-10 09:33:55 +08:00
docker-load.1.md Update docker-load documentation 2016-06-08 17:40:37 +02:00
docker-login.1.md fix docs about sudo docker login 2016-09-05 04:44:18 +00:00
docker-logout.1.md Remove some references to "register" through login 2016-03-01 17:33:23 +01:00
docker-logs.1.md Replace U+2018 and U+2019 with U+0027 in manpages 2016-05-20 20:15:57 +02:00
docker-network-connect.1.md Improve wording about re-assigning IP addresses 2016-01-27 17:11:12 +00:00
docker-network-create.1.md Fix incorrect aux-address examples and test 2016-09-27 01:12:29 +02:00
docker-network-disconnect.1.md Forced endpoint cleanup 2016-01-13 21:28:52 -08:00
docker-network-inspect.1.md Fix typs from go to Go 2016-10-18 19:40:16 +08:00
docker-network-ls.1.md Fix incorrect help output in docker network ls 2016-09-05 08:24:22 -07:00
docker-network-rm.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-pause.1.md Implement Pause Resume support for Windows 2016-10-11 16:23:35 -07:00
docker-port.1.md
docker-ps.1.md Add a new "is-task" ps filter 2016-09-28 12:45:30 +02:00
docker-pull.1.md Mention "docker login" in push/pull documentation 2016-03-28 17:22:41 -07:00
docker-push.1.md Synchronize push reference with man page 2016-09-15 18:53:46 +02:00
docker-rename.1.md Modify rename function usage 2016-09-01 14:48:02 +08:00
docker-restart.1.md Modify docker-restart.1.md 2016-09-02 13:06:08 +08:00
docker-rm.1.md Fix some flaws in man. 2016-02-25 09:48:21 +08:00
docker-rmi.1.md remove =false from options that default to false in the docs 2015-12-23 07:11:35 -08:00
docker-run.1.md Implementing support for --cpu-rt-period and --cpu-rt-runtime so that 2016-10-26 11:33:06 -04:00
docker-save.1.md Update 'save' command help 2016-03-22 08:16:52 +01:00
docker-search.1.md Add --limit option to docker search 2016-06-02 19:12:20 -07:00
docker-start.1.md Implement configurable detach key 2016-01-03 23:03:39 +01:00
docker-stats.1.md Add documentation for docker stats --format 2016-09-26 09:26:48 +03:00
docker-stop.1.md Fix man pages 2015-11-10 09:33:55 +08:00
docker-tag.1.md Document valid chars in image name and tag 2016-05-21 19:49:19 +01:00
docker-top.1.md Improvement of docker top Man Page 2015-12-02 18:54:52 +01:00
docker-unpause.1.md Implement Pause Resume support for Windows 2016-10-11 16:23:35 -07:00
docker-update.1.md Implementing support for --cpu-rt-period and --cpu-rt-runtime so that 2016-10-26 11:33:06 -04:00
docker-version.1.md Fix typs from go to Go 2016-10-18 19:40:16 +08:00
docker-wait.1.md
docker.1.md Modify restart function prompt 2016-08-30 12:07:38 +08:00
dockerd.8.md Make experimental a runtime flag 2016-10-24 15:20:01 -07:00
Dockerfile Use the correct version of glide 2016-08-18 20:43:50 -04:00
Dockerfile.5.md Clarify warning against using build-time variables for secrets 2016-07-11 21:21:33 -04:00
Dockerfile.aarch64 Add a Dockerfile for generating manpages on aarch64 2016-08-19 15:39:21 +01:00
Dockerfile.armhf Use the correct version of glide 2016-08-18 20:43:50 -04:00
Dockerfile.ppc64le ppc64le: add support for building docker debs for xenial 2016-08-18 22:25:14 -04:00
Dockerfile.s390x Add a Dockerfile for generating manpages on s390x 2016-08-19 17:18:49 +01:00
generate.go Move api/client -> cli/command 2016-09-08 15:46:29 -04:00
generate.sh Add a script to generate man pages from cobra commands. 2016-07-19 12:00:21 -04:00
glide.lock Update sfp13/pflag 2016-10-18 17:17:22 -07:00
glide.yaml Add a script to generate man pages from cobra commands. 2016-07-19 12:00:21 -04:00
md2man-all.sh
README.md Make README less scabious 2016-07-22 09:43:08 +01:00

Docker Documentation

This directory contains scripts for generating the man pages. Many of the man pages are generated directly from the spf13/cobra Command definition. Some legacy pages are still generated from the markdown files in this directory. Do not edit the man pages in the man1 directory. Instead, update the Cobra command or amend the Markdown files for legacy pages.

Generate the man pages

From within the project root directory run:

make manpages