Commit Graph

762 Commits

Author SHA1 Message Date
3fe83c23f0 docs: update API for features added in 1.11
Docker 1.11 added a feature to set labels on volumes,
networks and images (during build), but these changes
were not documented in the API documentation.

This adds the new features to the documentation.

Also fixes some minor formatting, and options that
were not used in the examples.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: ba353f37870fdeb8b875a79e1aec54dc3d1aedc4
Component: engine
2016-04-16 02:27:52 +02:00
0358d67fc6 Fix incorrect docs in remote API for the option of SecurityOpt
This fix tries to fix the issue in remote API docs for v1.15 (Docker 1.3.x)
and v1.16 (Docker 1.4.x) where `SecurityOpts` was used but the actual field
should be `SecurityOpt`.

This `SecurityOpt` field is verified through the source code in
v1.3.0 and v1.4.0:
https://github.com/docker/docker/blob/v1.3.0/runconfig/config.go#L35
https://github.com/docker/docker/blob/v1.4.0/runconfig/hostconfig.go#L98

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: f3f981624bc9329740e9a1c52e71471ca38d8171
Component: engine
2016-04-15 11:08:15 -07:00
23c1fd9d95 Merge pull request #21006 from cpuguy83/volume_inspect_meta
Allow volume drivers to provide a `Status` field
Upstream-commit: e40e5b97c1ad540aa0be568467546f27932ef3a5
Component: engine
2016-04-15 18:53:39 +02:00
ed92db4f93 Allow volume drivers to provide a Status field
The `Status` field is a `map[string]interface{}` which allows the driver to pass
back low-level details about the underlying volume.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
Upstream-commit: 36a1c56cf555f8fe9ceabeebb8fc956e05863fc7
Component: engine
2016-04-15 10:56:38 -04:00
4e9b36b9f3 Merge pull request #20924 from Microsoft/10662-CPUResourceControls
Add CPU count and maximum resource controls for Windows
Upstream-commit: 172ca1ca8c4d5157789feb97a6424104b81a3479
Component: engine
2016-04-15 08:14:59 +02:00
b6c2e57eab Merge pull request #21172 from yongtang/20909-seccomp-in-docker-info
Show "seccomp" in docker info (#20909).
Upstream-commit: bc0c8828e9afc32f1660a1f679ed523376c7d3d2
Component: engine
2016-04-15 01:24:54 +02:00
22a06166b3 Add CPU count and maximum resource controls for Windows
Signed-off-by: Darren Stahl <darst@microsoft.com>
Upstream-commit: ea8c690886970b2929d52d8b61dcfb8becc24db9
Component: engine
2016-04-14 15:40:25 -07:00
06666cda9a Move volume filters to API 1.24 docs
This feature was added after the 1.11 code-freeze,
so will be part of the 1.12 release. Moving it to the
right API version.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 8ef76f779d6ea59cb1a8c6fde52e4d719a8c073a
Component: engine
2016-04-14 17:12:28 +02:00
2a0b94972b Merge pull request #19265 from rhatdan/netsysctl
Add support for setting sysctls
Upstream-commit: 988508a2b5aa18c04fd3db143b4e4f5f207ea15e
Component: engine
2016-04-13 18:36:30 +02:00
977c2f6a60 Fixes #21701 devicemapper docs
Copy edit the content
Updates to existing material
Adding mbentley's comments
Updating with last minute comments
Update with Seb's comments

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: 783ebebff40ebdae27dc72b4c8c5151a01220a87
Component: engine
2016-04-13 08:02:16 -07:00
9a1f7c0972 Merge pull request #21885 from triccardi-systran/20612-improve-build-cache-miss-documentation
Improve build cache miss doc for `ARG` and `RUN`
Upstream-commit: edfe4e9fba89d0b8458e7e76132da2440c29ccbd
Component: engine
2016-04-13 15:23:14 +02:00
44c73694c8 Improve build cache miss doc for ARG and RUN
The documentation already says the cache miss happens only at `ARG`
variable usage, not declaration, but there is a very common implicit
usage: `RUN`, which this commit documents even more, improving on #21790.

Also, use `definition` instead of `declaration`: it's the same thing, and
`definition` is already used in this documentation, contrary to
`declaration`.

Also, distinguish between "instructions" and "variables defined by `ARG`
instructions".

Signed-off-by: Thomas Riccardi <riccardi@systran.fr>
Upstream-commit: 82f5ef2d2562f9e742eb694dc4b0a1f768a4f0de
Component: engine
2016-04-13 15:02:09 +02:00
8becc1526b Update /containers/create remote API docs
- Show how to pass the networking config in POST containers/create body

Signed-off-by: Alessandro Boch <aboch@docker.com>
Upstream-commit: 30859c34569b900d3d798ad55f48f3d4fd7dc32c
Component: engine
2016-04-12 13:41:13 -07:00
3b52ebb9ff Add support for setting sysctls
This patch will allow users to specify namespace specific "kernel parameters"
for running inside of a container.

Signed-off-by: Dan Walsh <dwalsh@redhat.com>
Upstream-commit: 9caf7aeefd23263a209c26c8439d26c147972d81
Component: engine
2016-04-12 13:37:31 -04:00
8e90b734bc Fix incorrect request json body for /containers/create in remote API docs.
This fix tries to fix the incorrect request json body for
`/containers/create` in remote API docs.

When using the example json request for `/containers/create`, there are two
errors:
(1). `invalid character '"' after object key:value pair`
     This is because a `,` is missing after `"Volumes": {}`
     This issue exists in v1.20-v1.24
(2). `Invalid --security-opt: ""`
     This is becasue in `"SecurityOpt": [""]` line, an empty string
     `""` is passed yet `""` is not a valid `SecurityOpt`. Either no string,
     or a valid string (e.g., "no-new-privileges") could be used.
     This issue exists in v1.15-v1.24

This fix updates the docs and correct the above two issues.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: f919a26a9fb96ef07133183b4f693ff9508ae823
Component: engine
2016-04-09 18:39:33 +00:00
a5c656d2b9 Change HumanSize to BytesSize for memory output in docker stats.
This fix tries to fix the discrepancy between `docker stats` and
`docker run` where `docker run` uses RAMInBytes for all memory
related inputs but `docker stats` uses HumanSize for all memory
related outputs.

To be consistent, `docker stats` needs to use BytesSize for all
memory related outputs to conform to RAMInBytes in `docker run`.

This fix addresses this issue. As BytesSize is used, the test
cases needs to be adjusted to match `KiB/MiB/GiB` instead of
`KB/MB/GB`.

The documentation has also been updated.

This fix fixes #21765.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 0e3846e280195cb47c47a7739b475b281dd301cb
Component: engine
2016-04-08 20:01:50 +00:00
55523d36c7 Fix the docker image --no-trunk output format
docker 1.10 change the output format of image id.

Signed-off-by: hyzhou.zhy <hyzhou.zhy@alibaba-inc.com>
Upstream-commit: b83e9df7609e705a85545a8a63db81ef73d85b0e
Component: engine
2016-04-08 08:59:59 +08:00
d23c572e2b Fix deprecated format for security-opt
Signed-off-by: Kai Qiang Wu(Kennan) <wkqwu@cn.ibm.com>
Upstream-commit: 0b207e75585cd4ba9a40460d87766052dd7508a7
Component: engine
2016-04-07 02:09:18 +00:00
ceda4e4efa Merge pull request #21712 from yongtang/21335-docs-container-with-volumes
Remote API docs give incorrect example for creating a container with volumes.
Upstream-commit: 3d800dc0192d0d246b0c1888bbe94aca5d52e1d2
Component: engine
2016-04-06 10:15:37 -07:00
7d665b791e Merge pull request #21799 from coolljt0725/fix_docs
Correct the description of --group-add in run.md
Upstream-commit: bbcbed3b54ca5e1ed4f23bb4bf58397e8f7d645b
Component: engine
2016-04-06 10:02:32 -07:00
d8939e35f7 Correct the description of --group-add in run.md
Signed-off-by: Lei Jitang <leijitang@huawei.com>
Upstream-commit: 9a7f2e726885386f57d115f8652b0ae87b20dce6
Component: engine
2016-04-06 21:52:10 +08:00
09c84ecb5a make the cache miss clear
Signed-off-by: mikelinjie <294893458@qq.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 66b8714da4e92b3587cbbf25116541f4de63169e
Component: engine
2016-04-06 00:48:21 -07:00
e0605e5ec1 Remote API docs give incorrect example for creating a container with volumes.
This fix tries to address the issue mentioned in Docker Remote API where
the examples for creating a container (`POST /containers/create`) with
volumes were incorrect. In the previous remote API document, the `Mounts`
fields was used for volume creation yet since v1.20 `Volumes` should be
used.

This fix fixes #21335.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 4ed20402580c4476360736f2bdaa2604dc76cd54
Component: engine
2016-04-02 19:59:02 +00:00
0d08181d47 Merge pull request #20410 from tkopczynski/20236-info-insecure-registry
Add insecure registries to docker info
Upstream-commit: 4a7bd7eaef0038b006cf23adface84081e5aab3b
Component: engine
2016-03-31 16:39:25 -07:00
d4b4130c2f Merge pull request #21681 from senk/21653-api-docs-revisit
Fixed api docs
Upstream-commit: 0d933359623429b301a79874c68b8539dda52d4b
Component: engine
2016-03-31 07:32:57 -07:00
dc335512b1 Merge pull request #21607 from allencloud/change-validateNoSchema-to-validateNoScheme
change validateNoSchema to validateNoScheme
Upstream-commit: e6f2429e017eb3c41bbc77442e81a23635287625
Component: engine
2016-03-31 10:14:23 +02:00
8bd53c59b9 Fixed docs fixes #21653
Fixed some http status codes and decreased site-order for docker_remote_api_v1.24.md to appear in the right order in the menu
Signed-off-by: Robin Naundorf <r.naundorf@fh-muenster.de>
Upstream-commit: 5d2f6b3ea3d307c32089757d84c94fab3d8e55d7
Component: engine
2016-03-31 08:39:40 +02:00
58855775ca Add insecure registries to docker info
Signed-off-by: Tomasz Kopczynski <tomek@kopczynski.net.pl>
Upstream-commit: 44a50abe7b16368bdc8b70e01cb095dc46cbbbaf
Component: engine
2016-03-31 08:27:24 +02:00
8ae6c0847a 1.change validateNoSchema into validateNoScheme
2.change schema into scheme in docs and some annotations.

Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: 28d3c22e55259281c70fd90780a1b0d388450ddf
Component: engine
2016-03-31 12:29:15 +08:00
d01eb0569f Un-deprecate auto-creation of host directories for mounts
Auto-creation of host-directories was marked deprecated in
Docker 1.9, but was decided to be too much of an backward-incompatible
change, so it was decided to keep the feature.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 0f70f53826ac311ca1653827c0d6bc170f300e84
Component: engine
2016-03-30 15:00:09 -07:00
7450a571b9 Fixed some differences between API and Docs in v1.22,v1.23,v1.24
Signed-off-by: Robin Naundorf <r.naundorf@fh-muenster.de>
Upstream-commit: 370dbe0cd98e924e8641a72a437281dd7bce9f3d
Component: engine
2016-03-30 14:04:25 +02:00
c287a54185 Show "seccomp" in docker info (#20909).
This pull request added a `SecurityOptions` field in the `GET /info`
output to show if there is `apparmor`, `seccomp`, or `selinux` suport.

The API changes are updated in the documentation and the update in
`GET /info` is covered by the test case in `TestInfoApi`.

This pull request fixes #20909.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 190654aa2ee880c2052c0887a215b85d24049f6d
Component: engine
2016-03-30 09:23:15 +00:00
e912ffb0bc Merge pull request #21638 from yongtang/21605-docs-Warnings-in-volumes-API
Update documentations for `Warnings` fields in `GET /volumes` API
Upstream-commit: 457eb89bd50ebee912db5cf65cd7332d46d5e27c
Component: engine
2016-03-29 19:11:36 -07:00
93c7f3e4ce Update documentations for Warnings fields in GET /volumes API
This fix updated documentations to add the `Warnings` fields in
`GET /volumes` API.

The `Warnings` has been part of the `GET /volumes` API response
since Docker 1.10 (v1.21). However, the `Warnings` field is not
in the documentation so there are some confusions (See #21606).

This fix updated the related documentations in v1.22, v1.23, and
v1.24 and added this field to the API.

This fix is related to #21605.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: d77392798550e47fd3719ad658c6a92d1282d5b2
Component: engine
2016-03-30 01:35:39 +00:00
5888c28b47 Merge pull request #21592 from anusha-ragunathan/docker-systemd
When using systemd, pass expected cgroupsPath and cli options to runc.
Upstream-commit: 99adcaebc0aca57f2665f356e4a9b4218aa5d5f7
Component: engine
2016-03-29 17:00:10 -07:00
3b9321568d When using systemd, pass expected cgroupsPath and cli options to runc.
runc expects a systemd cgroupsPath to be in slice:scopePrefix:containerName
format and the "--systemd-cgroup" option to be set. Update docker accordingly.

Fixes 21475

Signed-off-by: Anusha Ragunathan <anusha@docker.com>
Upstream-commit: 7ed3d265a4499ec03f10537fea0aac3ebaa0cec6
Component: engine
2016-03-29 14:20:10 -07:00
5f7e4a225f Merge pull request #21597 from aaronlehmann/mention-docker-login
Mention "docker login" in push/pull documentation
Upstream-commit: 08db95161a1dc7c5bfe570652d4eb859025a62cb
Component: engine
2016-03-29 09:27:53 +02:00
2a9ea71f8e Merge pull request #21576 from albers/docs-daemon--containerd
docs for `docker daemon --containerd`
Upstream-commit: b9d59e86d35bd2cfba0c77c323b14b05a238eae6
Component: engine
2016-03-29 09:25:16 +02:00
57e1cc77d5 Merge pull request #19367 from shishir-a412ed/rootfs_size_configurable_cli
CLI flag for docker create(run) to change block device size.
Upstream-commit: e6aa40a017e0c11186fb9053b9e71e34b93ebe1c
Component: engine
2016-03-29 08:52:54 +02:00
4afee18d2e Mention "docker login" in push/pull documentation
It was suggested to me that documentation for "docker pull" and "docker
push" should reference "docker login", to make clearer how to specify
credentials for a push or pull operation. Add a note to the manual pages
and reference documentation explaining how registry credentials are
managed.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: fb5ea0c0efec238aeeff7c5c3742a0e4eccff2c7
Component: engine
2016-03-28 17:22:41 -07:00
9ab7e4327f CLI flag for docker create(run) to change block device size.
Signed-off-by: Shishir Mahajan <shishir.mahajan@redhat.com>
Upstream-commit: b16decfccfdb0749c490be9272cb7b4789be87b4
Component: engine
2016-03-28 10:05:18 -04:00
9332b48560 docs for docker daemon --containerd
Signed-off-by: Harald Albers <github@albersweb.de>
Upstream-commit: 75f0015c50fef03067c5d54097fb6eb8cb62200b
Component: engine
2016-03-28 05:40:27 -07:00
40b838beee fix wrong option name in dm.min_free_space examples
Signed-off-by: Harald Albers <github@albersweb.de>
Upstream-commit: 2623b3496ead7c275d2e54bdfcdab0eab528be51
Component: engine
2016-03-28 05:20:06 -07:00
779c6aca92 docs for labels on build, networks and volumes
Signed-off-by: Harald Albers <github@albersweb.de>
Upstream-commit: 995e5beda74b99dfc920f6a79aee977ff5a15a72
Component: engine
2016-03-25 11:16:19 -07:00
cfeb820c82 Merge pull request #21361 from HackToday/addfilter
Add name/driver filter support for volume
Upstream-commit: 2de29fb9c2eaee803d69625a7105953da941356e
Component: engine
2016-03-25 08:07:38 +01:00
553d05c397 Add name/driver filter support for volume
This change include filter `name` and `driver`,
and also update related docs to reflect that filters usage.

Closes: #21243

Signed-off-by: Kai Qiang Wu(Kennan) <wkqwu@cn.ibm.com>
Upstream-commit: 8e9305ef946843ce2f8ef47909d6a866eab5dfa8
Component: engine
2016-03-25 01:11:17 +00:00
37e1c9e1c1 add docs for docker load --quiet
Signed-off-by: Harald Albers <github@albersweb.de>
Upstream-commit: 610ec8c7396ea4cc20465b99cf326684c82d23ff
Component: engine
2016-03-24 18:57:44 +01:00
91408a7472 Bump API Version to v1.24
Signed-off-by: Tibor Vass <tibor@docker.com>
Upstream-commit: 928ea1e957812c351b77bb33be7f3ef9fd629231
Component: engine
2016-03-23 12:26:23 -04:00
9e6a0a5df2 Merge pull request #21340 from SvenDowideit/workdir-does-a-mkdir-p
WORKDIR is like calling mkdir - but we've not told people
Upstream-commit: f26193e2cfa04e4fa37cebe62de07eb46e0efed7
Component: engine
2016-03-22 18:41:15 -07:00
7c90f8b43b Merge pull request #21370 from tonistiigi/expose-layer-ids
Expose RootFS in image inspect
Upstream-commit: 694b32df51ac82afdf4695569e87dad7eaf71de4
Component: engine
2016-03-22 20:33:18 -04:00