Skip to content

Commit

Permalink
Updated Yaml files
Browse files Browse the repository at this point in the history
Signed-off-by: French Ben <frenchben@docker.com>
  • Loading branch information
French Ben committed Dec 16, 2016
1 parent 94a5093 commit 5e9e235
Show file tree
Hide file tree
Showing 83 changed files with 990 additions and 411 deletions.
110 changes: 108 additions & 2 deletions _data/engine-cli/docker.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,109 @@
command: docker
cname: docker wait
clink: docker_wait.yaml
cname:
- docker attach
- docker build
- docker checkpoint
- docker commit
- docker container
- docker cp
- docker create
- docker deploy
- docker diff
- docker events
- docker exec
- docker export
- docker history
- docker image
- docker images
- docker import
- docker info
- docker inspect
- docker kill
- docker load
- docker login
- docker logout
- docker logs
- docker network
- docker node
- docker pause
- docker plugin
- docker port
- docker ps
- docker pull
- docker push
- docker rename
- docker restart
- docker rm
- docker rmi
- docker run
- docker save
- docker search
- docker secret
- docker service
- docker stack
- docker start
- docker stats
- docker stop
- docker swarm
- docker system
- docker tag
- docker top
- docker unpause
- docker update
- docker version
- docker volume
- docker wait
clink:
- docker_attach.yaml
- docker_build.yaml
- docker_checkpoint.yaml
- docker_commit.yaml
- docker_container.yaml
- docker_cp.yaml
- docker_create.yaml
- docker_deploy.yaml
- docker_diff.yaml
- docker_events.yaml
- docker_exec.yaml
- docker_export.yaml
- docker_history.yaml
- docker_image.yaml
- docker_images.yaml
- docker_import.yaml
- docker_info.yaml
- docker_inspect.yaml
- docker_kill.yaml
- docker_load.yaml
- docker_login.yaml
- docker_logout.yaml
- docker_logs.yaml
- docker_network.yaml
- docker_node.yaml
- docker_pause.yaml
- docker_plugin.yaml
- docker_port.yaml
- docker_ps.yaml
- docker_pull.yaml
- docker_push.yaml
- docker_rename.yaml
- docker_restart.yaml
- docker_rm.yaml
- docker_rmi.yaml
- docker_run.yaml
- docker_save.yaml
- docker_search.yaml
- docker_secret.yaml
- docker_service.yaml
- docker_stack.yaml
- docker_start.yaml
- docker_stats.yaml
- docker_stop.yaml
- docker_swarm.yaml
- docker_system.yaml
- docker_tag.yaml
- docker_top.yaml
- docker_unpause.yaml
- docker_update.yaml
- docker_version.yaml
- docker_volume.yaml
- docker_wait.yaml
7 changes: 7 additions & 0 deletions _data/engine-cli/docker_build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ options:
- option: memory-swap
description: |
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
- option: network
default_value: default
description: |
Set the networking mode for the RUN instructions during build
- option: no-cache
default_value: "false"
description: Do not use cache when building the image
Expand All @@ -68,6 +72,9 @@ options:
description: Security options
- option: shm-size
description: Size of /dev/shm, default value is 64MB
- option: squash
default_value: "false"
description: Squash newly built layers into a single new layer
- option: tag
shorthand: t
default_value: '[]'
Expand Down
14 changes: 14 additions & 0 deletions _data/engine-cli/docker_checkpoint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
command: docker checkpoint
short: Manage checkpoints
long: Manage checkpoints
usage: docker checkpoint
pname: docker
plink: docker.yaml
cname:
- docker checkpoint create
- docker checkpoint ls
- docker checkpoint rm
clink:
- docker_checkpoint_create.yaml
- docker_checkpoint_ls.yaml
- docker_checkpoint_rm.yaml
12 changes: 12 additions & 0 deletions _data/engine-cli/docker_checkpoint_create.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
command: docker checkpoint create
short: Create a checkpoint from a running container
long: Create a checkpoint from a running container
usage: docker checkpoint create [OPTIONS] CONTAINER CHECKPOINT
pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
description: Use a custom checkpoint storage directory
- option: leave-running
default_value: "false"
description: Leave the container running after checkpoint
9 changes: 9 additions & 0 deletions _data/engine-cli/docker_checkpoint_ls.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
command: docker checkpoint ls
short: List checkpoints for a container
long: List checkpoints for a container
usage: docker checkpoint ls [OPTIONS] CONTAINER
pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
description: Use a custom checkpoint storage directory
9 changes: 9 additions & 0 deletions _data/engine-cli/docker_checkpoint_rm.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
command: docker checkpoint rm
short: Remove a checkpoint
long: Remove a checkpoint
usage: docker checkpoint rm [OPTIONS] CONTAINER CHECKPOINT
pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
description: Use a custom checkpoint storage directory
54 changes: 52 additions & 2 deletions _data/engine-cli/docker_container.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,55 @@ long: Manage containers
usage: docker container
pname: docker
plink: docker.yaml
cname: docker container wait
clink: docker_container_wait.yaml
cname:
- docker container attach
- docker container commit
- docker container cp
- docker container create
- docker container diff
- docker container exec
- docker container export
- docker container inspect
- docker container kill
- docker container logs
- docker container ls
- docker container pause
- docker container port
- docker container prune
- docker container rename
- docker container restart
- docker container rm
- docker container run
- docker container start
- docker container stats
- docker container stop
- docker container top
- docker container unpause
- docker container update
- docker container wait
clink:
- docker_container_attach.yaml
- docker_container_commit.yaml
- docker_container_cp.yaml
- docker_container_create.yaml
- docker_container_diff.yaml
- docker_container_exec.yaml
- docker_container_export.yaml
- docker_container_inspect.yaml
- docker_container_kill.yaml
- docker_container_logs.yaml
- docker_container_ls.yaml
- docker_container_pause.yaml
- docker_container_port.yaml
- docker_container_prune.yaml
- docker_container_rename.yaml
- docker_container_restart.yaml
- docker_container_rm.yaml
- docker_container_run.yaml
- docker_container_start.yaml
- docker_container_stats.yaml
- docker_container_stop.yaml
- docker_container_top.yaml
- docker_container_unpause.yaml
- docker_container_update.yaml
- docker_container_wait.yaml
26 changes: 23 additions & 3 deletions _data/engine-cli/docker_container_create.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ options:
description: Attach to STDIN, STDOUT or STDERR
- option: blkio-weight
default_value: "0"
description: Block IO (relative weight), between 10 and 1000
description: |
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
- option: blkio-weight-device
default_value: '[]'
description: Block IO weight (relative device weight)
Expand All @@ -28,6 +29,9 @@ options:
description: Optional parent cgroup for the container
- option: cidfile
description: Write the container ID to the file
- option: cpu-count
default_value: "0"
description: CPU count (Windows only)
- option: cpu-percent
default_value: "0"
description: CPU percent (Windows only)
Expand All @@ -37,10 +41,19 @@ options:
- option: cpu-quota
default_value: "0"
description: Limit CPU CFS (Completely Fair Scheduler) quota
- option: cpu-rt-period
default_value: "0"
description: Limit CPU real-time period in microseconds
- option: cpu-rt-runtime
default_value: "0"
description: Limit CPU real-time runtime in microseconds
- option: cpu-shares
shorthand: c
default_value: "0"
description: CPU shares (relative weight)
- option: cpus
default_value: "0.000"
description: Number of CPUs
- option: cpuset-cpus
description: CPUs in which to allow execution (0-3, 0,1)
- option: cpuset-mems
Expand Down Expand Up @@ -71,6 +84,9 @@ options:
- option: dns-opt
default_value: '[]'
description: Set DNS options
- option: dns-option
default_value: '[]'
description: Set DNS options
- option: dns-search
default_value: '[]'
description: Set custom DNS search domains
Expand All @@ -93,13 +109,14 @@ options:
description: Command to run to check health
- option: health-interval
default_value: "0"
description: Time between running the check
description: Time between running the check (ns|us|ms|s|m|h) (default 0s)
- option: health-retries
default_value: "0"
description: Consecutive failures needed to report unhealthy
- option: health-timeout
default_value: "0"
description: Maximum time to allow one check to run
description: |
Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s)
- option: help
default_value: "false"
description: Print usage
Expand Down Expand Up @@ -221,6 +238,9 @@ options:
- option: stop-signal
default_value: SIGTERM
description: Signal to stop a container, SIGTERM by default
- option: stop-timeout
default_value: "0"
description: Timeout (in seconds) to stop a container
- option: storage-opt
default_value: '[]'
description: Storage driver options for the container
Expand Down
4 changes: 4 additions & 0 deletions _data/engine-cli/docker_container_exec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ options:
description: 'Detached mode: run command in the background'
- option: detach-keys
description: Override the key sequence for detaching a container
- option: env
shorthand: e
default_value: '[]'
description: Set environment variables
- option: interactive
shorthand: i
default_value: "false"
Expand Down
2 changes: 1 addition & 1 deletion _data/engine-cli/docker_container_inspect.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ plink: docker_container.yaml
options:
- option: format
shorthand: f
description: Format the output using the given go template
description: Format the output using the given Go template
- option: size
shorthand: s
default_value: "false"
Expand Down
Loading

0 comments on commit 5e9e235

Please sign in to comment.