Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/man
History
Erik St. Martin 42ef78911e 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>
 		2017-06-02 00:10:28 +00:00
..
Dockerfile Use the correct version of glide 2017-06-02 00:10:06 +00:00
Dockerfile.5.md Clarify warning against using build-time variables for secrets 2017-06-02 00:07:49 +00:00
Dockerfile.aarch64 Add a Dockerfile for generating manpages on aarch64 2017-06-02 00:10:06 +00:00
Dockerfile.armhf Use the correct version of glide 2017-06-02 00:10:06 +00:00
Dockerfile.ppc64le ppc64le: add support for building docker debs for xenial 2017-06-02 00:10:06 +00:00
Dockerfile.s390x Add a Dockerfile for generating manpages on s390x 2017-06-02 00:10:06 +00:00
README.md Make README less scabious 2017-06-02 00:10:02 +00:00
docker-attach.1.md Fix a couple of typos in the docs of `docker attach` 2017-06-02 00:07:42 +00:00
docker-build.1.md add --network option for docker build 2017-06-02 00:10:28 +00:00
docker-commit.1.md Document valid chars in image name and tag 2017-06-02 00:07:39 +00:00
docker-config-json.5.md man: mv config-json.5 to docker-config-json.5 2017-06-02 00:07:42 +00:00
docker-cp.1.md update docs/reference/commandline/cp.md 2017-06-02 00:07:40 +00:00
docker-create.1.md Implementing support for --cpu-rt-period and --cpu-rt-runtime so that 2017-06-02 00:10:28 +00:00
docker-diff.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-events.1.md Fix typs from go to Go 2017-06-02 00:10:24 +00:00
docker-exec.1.md Exec: Add ability to set environment variables 2017-06-02 00:10:25 +00:00
docker-export.1.md various man page typos 2017-06-02 00:07:12 +00:00
docker-history.1.md remove =false from options that default to false in the docs 2017-06-02 00:07:21 +00:00
docker-images.1.md fix the man page and zsh completion for `docker images` 2017-06-02 00:10:11 +00:00
docker-import.1.md Fix some flaws in man. 2017-06-02 00:07:30 +00:00
docker-info.1.md Fix typs from go to Go 2017-06-02 00:10:24 +00:00
docker-inspect.1.md Refactor `docker inspect` to work on all types 2017-06-02 00:10:07 +00:00
docker-kill.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-load.1.md Update docker-load documentation 2017-06-02 00:07:42 +00:00
docker-login.1.md fix docs about `sudo docker login` 2017-06-02 00:10:08 +00:00
docker-logout.1.md Remove some references to "register" through login 2017-06-02 00:07:30 +00:00
docker-logs.1.md Replace U+2018 and U+2019 with U+0027 in manpages 2017-06-02 00:07:39 +00:00
docker-network-connect.1.md Improve wording about re-assigning IP addresses 2017-06-02 00:07:27 +00:00
docker-network-create.1.md Fix incorrect aux-address examples and test 2017-06-02 00:10:12 +00:00
docker-network-disconnect.1.md Forced endpoint cleanup 2017-06-02 00:07:23 +00:00
docker-network-inspect.1.md Fix typs from go to Go 2017-06-02 00:10:24 +00:00
docker-network-ls.1.md Fix incorrect help output in `docker network ls` 2017-06-02 00:10:08 +00:00
docker-network-rm.1.md Fix some flaws in man. 2017-06-02 00:07:30 +00:00
docker-pause.1.md Implement Pause Resume support for Windows 2017-06-02 00:10:13 +00:00
docker-port.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-ps.1.md Add a new "is-task" ps filter 2017-06-02 00:10:12 +00:00
docker-pull.1.md Mention "docker login" in push/pull documentation 2017-06-02 00:07:34 +00:00
docker-push.1.md Synchronize push reference with man page 2017-06-02 00:10:10 +00:00
docker-rename.1.md Modify rename function usage 2017-06-02 00:10:09 +00:00
docker-restart.1.md Modify docker-restart.1.md 2017-06-02 00:10:08 +00:00
docker-rm.1.md Fix some flaws in man. 2017-06-02 00:07:30 +00:00
docker-rmi.1.md remove =false from options that default to false in the docs 2017-06-02 00:07:21 +00:00
docker-run.1.md Implementing support for --cpu-rt-period and --cpu-rt-runtime so that 2017-06-02 00:10:28 +00:00
docker-save.1.md Update 'save' command help 2017-06-02 00:07:32 +00:00
docker-search.1.md Add `--limit` option to `docker search` 2017-06-02 00:07:41 +00:00
docker-start.1.md Implement configurable detach key 2017-06-02 00:07:22 +00:00
docker-stats.1.md Add documentation for docker stats --format 2017-06-02 00:10:11 +00:00
docker-stop.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-tag.1.md Document valid chars in image name and tag 2017-06-02 00:07:39 +00:00
docker-top.1.md Improvement of docker top Man Page 2017-06-02 00:07:18 +00:00
docker-unpause.1.md Implement Pause Resume support for Windows 2017-06-02 00:10:13 +00:00
docker-update.1.md Implementing support for --cpu-rt-period and --cpu-rt-runtime so that 2017-06-02 00:10:28 +00:00
docker-version.1.md Fix typs from go to Go 2017-06-02 00:10:24 +00:00
docker-wait.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker.1.md Modify restart function prompt 2017-06-02 00:10:07 +00:00
dockerd.8.md Make experimental a runtime flag 2017-06-02 00:10:28 +00:00
generate.go Move api/client -> cli/command 2017-06-02 00:10:09 +00:00
generate.sh Add a script to generate man pages from cobra commands. 2017-06-02 00:07:51 +00:00
glide.lock Update sfp13/pflag 2017-06-02 00:10:25 +00:00
glide.yaml Add a script to generate man pages from cobra commands. 2017-06-02 00:07:51 +00:00
md2man-all.sh Moving man pages out of docs 2017-06-02 00:06:57 +00:00

README.md

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