Commit graph

1281 commits

Author SHA1 Message Date
Sebastiaan van Stijn
45818d6fc4
Removed engine-api leftovers
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-21 12:36:52 +02:00
Sebastiaan van Stijn
708892c403
Update API docs for "HostConfig.Binds"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-20 17:41:59 +02:00
Brian Goff
5fa94084ac Merge pull request #26741 from thaJeztah/fix-api-docs
Fix incorrectly named API options
2016-09-20 09:14:08 -04:00
Vincent Demeester
00615efced Merge pull request #25025 from cpuguy83/service_inspect_formatter
Add formatter for service inspect
2016-09-20 14:49:45 +02:00
Sebastiaan van Stijn
36a25bdbe4
Fix incorrectly named API options
This renames `MaximumIOps` to `IOMaximumBandwidth`,
and `MaximumIOBps` to `IOMaximumIOps` to match
the actual code.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-20 13:51:55 +02:00
Sebastiaan van Stijn
374ae5ce13 Merge pull request #26732 from yuexiao-wang/update-index
Update on index reference documentation
2016-09-20 11:42:17 +02:00
yuexiao-wang
0483d77613 Update on index refernce documentation
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2016-09-20 16:37:52 +08:00
Vincent Demeester
a43691d645 Merge pull request #26482 from yuexiao-wang/add-option
Update the options for docker client
2016-09-20 09:51:57 +02:00
Michael Crosby
ee3ac3aa66 Add init process for zombie fighting
This adds a small C binary for fighting zombies.  It is mounted under
`/dev/init` and is prepended to the args specified by the user.  You
enable it via a daemon flag, `dockerd --init`, as it is disable by
default for backwards compat.

You can also override the daemon option or specify this on a per
container basis with `docker run --init=true|false`.

You can test this by running a process like this as the pid 1 in a
container and see the extra zombie that appears in the container as it
is running.

```c

int main(int argc, char ** argv) {
	pid_t pid = fork();
	if (pid == 0) {
		pid = fork();
		if (pid == 0) {
			exit(0);
		}
		sleep(3);
		exit(0);
	}
	printf("got pid %d and exited\n", pid);
	sleep(20);
}
```

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2016-09-19 17:33:50 -07:00
Brian Goff
54ba82beab Add formatter for service inspect
Allows the user to use `pretty` as the format string.
This enables users to put custom format options into their CLI config
just like is supported for `docker ps` and `docker images`

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2016-09-19 16:28:19 -04:00
Sebastiaan van Stijn
bb6fe56e88 Merge pull request #26268 from AkihiroSuda/eventsjsonl
add `docker events --format`
2016-09-19 17:30:27 +02:00
Sebastiaan van Stijn
533b00da8b
Fix Markdown formatting and missing prompt in service create
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-19 13:57:39 +02:00
Misty Stanley-Jones
5880d62953
Misty's edits and additions
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit 3de7d725137ee1620ae2050e65ace4990a3af87e)
2016-09-19 12:12:54 +02:00
Sebastiaan van Stijn
eb3a01eb43 Add --mount syntax documentation to CLI reference
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-19 11:56:59 +02:00
yuexiao-wang
0f0b0db842 fix typo for docs reference
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2016-09-18 11:00:19 +08:00
John Howard
4a0419f536 Merge pull request #25737 from Microsoft/jjh-statistics
Windows: Add support for docker stats
2016-09-17 09:31:24 -07:00
Sebastiaan van Stijn
788a8a3cac Merge pull request #26634 from thaJeztah/fix-api-docs-for-services
Fix service and tasks API documentation
2016-09-17 16:13:15 +02:00
Sebastiaan van Stijn
1fb556bb7e Merge pull request #26654 from thaJeztah/sync-api-docs
Synchronize API docs
2016-09-17 16:11:42 +02:00
Sebastiaan van Stijn
2f5b379192 Merge pull request #26653 from thaJeztah/move-mounts-to-correct-api-version
Move HostConfig.Mounts to correct API version
2016-09-17 13:53:37 +02:00
Sebastiaan van Stijn
1c117aa8cc Merge pull request #26289 from aboch/doc
Fix mtu option in documentation
2016-09-17 03:32:23 +02:00
Sebastiaan van Stijn
53b1dcb25c
Synchronize API docs
This synchronizes changes between API versions, and:

- applies e0a552504e to
  older versions of the documentation
- applies a2a0a03e2b to
  API version 1.25
- syncs some minor differences

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-17 03:02:12 +02:00
Sebastiaan van Stijn
cd73ceffd8
Move HostConfig.Mounts to correct API version
This was added in fc7b904dce,
but some parts of the documentation ended up in the
wrong API version, and was overlooked during
review :)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-17 02:36:07 +02:00
Sebastiaan van Stijn
d69409fd43
Fix service and tasks API documentation
The documentation contained some outdated information
on these endpoints.

This change fixes those parts of the documentation

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-17 02:29:38 +02:00
Josh Bodah
484fbe236d Remove extra paren in run --link docs
Signed-off-by: Josh Bodah <jb3689@yahoo.com>
2016-09-16 15:32:12 -04:00
John Howard
340e5233b2 Windows: stats support
Signed-off-by: John Howard <jhoward@microsoft.com>
2016-09-16 11:56:15 -07:00
Vincent Demeester
8a7006ff8e Merge pull request #26620 from runcom/fix-docs
docs: reference: api: clarify pull all tags
2016-09-16 20:56:04 +02:00
Sebastiaan van Stijn
87b174080b
Use "sudo" for dockerd examples
Because we standardize on using a non-privileged
prompt (`$`) instead of `#`, replacing the
examples to use `sudo` instead to indicate
this has to be run as root.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-16 17:22:58 +02:00
Antonio Murdaca
03a8b6798d
docs: reference: api: clarify pull all tags
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
2016-09-16 16:35:15 +02:00
Sebastiaan van Stijn
7ca02f86de
Add link to logging drivers reference
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-16 15:29:28 +02:00
Sebastiaan van Stijn
dddea689ab
Synchronize push reference with man page
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-15 18:53:46 +02:00
Sebastiaan van Stijn
edbb8fb86d
Restore missing "format" example
The "format" example got lost during the
rewrite of the documentation for Cobra. This
restores the missing example.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-15 16:09:24 +02:00
Akihiro Suda
5af5a1be62 add docker events --format
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2016-09-15 09:55:29 +00:00
Sven Dowideit
37869b237c Merge pull request #25774 from ddgenome/cmd-entrypoint-table
Update ENTRYPOINT/CMD table to agree with docs
2016-09-15 09:35:13 +10:00
Anusha Ragunathan
e482d4ee71 Merge pull request #26575 from anusha-ragunathan/update_plugin_docs
Update plugin install docs with registry specifics.
2016-09-14 14:43:41 -07:00
Sebastiaan van Stijn
86de72fef2
Add direct link to event chart image
This adds a direct link to the event chart image
so that the full-resolution image can be "zoomed"
in to.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-14 23:16:32 +02:00
Anusha Ragunathan
81d5abf334 Update plugin install docs with registry specifics.
Signed-off-by: Anusha Ragunathan <anusha@docker.com>
2016-09-14 10:21:31 -07:00
Sebastiaan van Stijn
9e9ba1e1c1 Merge pull request #26526 from lixiaobing10051267/masterSymble
fix some incorrect symbols before executing command
2016-09-14 17:48:43 +02:00
lixiaobing10051267
7b73b5fd6a fix some incorrect symbols before executing command
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
2016-09-14 22:28:09 +08:00
Sebastiaan van Stijn
8ac2000f50 Merge pull request #25540 from estesp/ro-plus-userns
Remove --read-only restriction when user ns enabled
2016-09-14 13:53:58 +02:00
Brian Goff
fc7b904dce Add new HostConfig field, Mounts.
`Mounts` allows users to specify in a much safer way the volumes they
want to use in the container.
This replaces `Binds` and `Volumes`, which both still exist, but
`Mounts` and `Binds`/`Volumes` are exclussive.
The CLI will continue to use `Binds` and `Volumes` due to concerns with
parsing the volume specs on the client side and cross-platform support
(for now).

The new API follows exactly the services mount API.

Example usage of `Mounts`:

```
$ curl -XPOST localhost:2375/containers/create -d '{
  "Image": "alpine:latest",
  "HostConfig": {
    "Mounts": [{
      "Type": "Volume",
      "Target": "/foo"
      },{
      "Type": "bind",
      "Source": "/var/run/docker.sock",
      "Target": "/var/run/docker.sock",
      },{
      "Type": "volume",
      "Name": "important_data",
      "Target": "/var/data",
      "ReadOnly": true,
      "VolumeOptions": {
	"DriverConfig": {
	  Name: "awesomeStorage",
	  Options: {"size": "10m"},
	  Labels: {"some":"label"}
	}
      }]
    }
}'
```

There are currently 2 types of mounts:

  - **bind**: Paths on the host that get mounted into the
    container. Paths must exist prior to creating the container.
  - **volume**: Volumes that persist after the
    container is removed.

Not all fields are available in each type, and validation is done to
ensure these fields aren't mixed up between types.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2016-09-13 09:55:35 -04:00
Sebastiaan van Stijn
027e7be348 Merge pull request #25817 from sfsmithcha/update_glossary
add swarm mode terms to the glossary
2016-09-13 12:08:32 +02:00
Sebastiaan van Stijn
4d187df277 Merge pull request #25466 from justincormack/deprecate-maintainer
Begin process of deprecating MAINTAINER
2016-09-13 12:07:04 +02:00
Vincent Demeester
0c90f777b7 Merge pull request #26489 from yuexiao-wang/update-exec
update option for docker exec
2016-09-13 11:16:22 +02:00
Brian Goff
e41839e8a1 Merge pull request #26472 from yongtang/09112016-docker-build-step-0
Fix documentation for `Step 0` to `Step 1` in `docker build`
2016-09-12 09:08:35 -04:00
yuexiao-wang
7084aa24c7 update option for docker commands
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2016-09-12 19:10:45 +08:00
yuexiao-wang
1917d3b958 add option and update the description
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2016-09-12 16:08:59 +08:00
Sven Dowideit
2cce7bf33a Merge pull request #26306 from deployable/patch-1
Remote API documentation consistancy
2016-09-12 10:52:30 +10:00
Yong Tang
256dbe4b75 Fix documentation for Step 0 to Step 1 in docker build
The indexing of steps in the output of `docker build` starts with `Step 1`.
However, there are several places in the docs that start with `Step 0`.

This fix addresses the issue and changes `Step 0` to `Step 1` (and subsequent steps).

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-09-11 10:52:40 -07:00
Vincent Demeester
e6f76800f5 Merge pull request #26426 from sfsmithcha/carry_pry_25414
Carry pr 25414
2016-09-10 11:50:28 +02:00
Matt Hoyle
e0a552504e Keep headings consistant in API documentation
The "Stream details" sections are currently a part of the Status codes list.

This change moves them out to the same level as other surrounding sections.

Use () for a paramaters

Remove query param from end point heading

Signed-off-by: Matt Hoyle <matt@deployable.co>
2016-09-10 12:27:41 +10:00