1
0
mirror of https://github.com/docker/cli.git synced 2026-01-16 20:22:36 +03:00
Commit Graph

101 Commits

Author SHA1 Message Date
Victoria Bialas
abee2dc945 re-doing Docker Engine overview topics for v.1.12
fixed broken links created from Engine Overview update by adding missing topic to daemon reference page and updating the hrefs in the api pages

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Upstream-commit: 8bd33b430b950ca5355f950d4b79a04ba0363c3c
Component: engine
2016-06-08 17:35:28 -07:00
allencloud
35c5774373 fix typos
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: c1be45fa38e82054dcad606d71446a662524f2d5
Component: engine
2016-06-02 17:17:22 +08:00
Wang Xing
b96d544c7a Fix bug which mistakes 400 error for 500
Signed-off-by: Wang Xing <hzwangxing@corp.netease.com>
Upstream-commit: beca2615782e24fa28803ada067129fdfa88c77d
Component: engine
2016-05-19 20:01:55 +08:00
Sebastiaan van Stijn
7c03d41081 update API example response for docker events
the events API was rewritten in 723be0a3325799fd6b2a6b689af54f5a07edf992,
but the example response in the documentation doesn't reflect the actual output

this fixes the example response

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 3932d46a7878e3e75d8119f332b927fd2107cb32
Component: engine
2016-04-29 17:37:04 +02:00
Sven Dowideit
21117de54d Small API formating fix.
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 204a52c689204a4d9506d500955673f7b5361d1d
Component: engine
2016-04-26 10:29:31 +00:00
Yong Tang
888a7f4130 Docs: Container creation param descriptions not under HostConfig
This fix tries to fix issues mentioned in #22100 for incorrect
description of remote API's container creation params.

Several issues have been fixed:
1. CPU and memory related params (e.g., `MemorySwap`, `CpuShares`, etc.)
were incorrectly placed under the top level instead of under the HostConfig.
(v1.18-v1.24)
2. The param `Cpuset` has been deprecated but was never removed.
(v1.18-v1.24)
3. The param `PidsLimit` was not added even though the description
has been added.
(v1.23-v1.24)

This fix fixes #22100

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: 332e3b545b0c0e825364c0f09315f82546c791f0
Component: engine
2016-04-18 21:15:33 -07:00
Alessandro Boch
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
Yong Tang
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
Yong Tang
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
Robin Naundorf
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
Robin Naundorf
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
Yong Tang
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
Arnaud Porterie
b9d40a7c24 docs: fix incorrect output for "/info" endpoint
OomScoreAjd is not part of `/info` output
Wrong field name `DiscoveryBackend` in API reference

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 9014ac2d15b65559468ef0496061a38b919e1680
Component: engine
2016-03-21 12:55:45 +01:00
Sebastiaan van Stijn
38c767cc35 Merge pull request #20990 from sds/fix-data-volume-rest-api-docs
Fix documentation for creating containers with data volumes
Upstream-commit: f480c696251906d86c800b5cf3660c48335e361c
Component: engine
2016-03-14 15:06:40 +01:00
Kanstantsin Shautsou
8fd7f3b992 Add missing fields for NetworkSettings
Dump from 1.10.1 has this fields.

Signed-off-by: Kanstantsin Shautsou <kanstantsin.sha@gmail.com>

Close and carry #20377
Include David's request

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: 205844875cb848b04fef401d3e7fcc3a8959bba0
Component: engine
2016-03-09 12:43:48 -08:00
Shane da Silva
674ffcbaf5 Fix documentation for creating containers with data volumes
The documentation for Docker 1.10.2 (API version 1.22) mentions under
the "Create a container"[1] section that `HostConfig.Binds` can be given
a "container path" which will automatically "create a new volume for the
container."

I interpreted this to mean it that the following two commands should
have the same net result:

    # Create container with data volume via REST API
    curl --unix-socket /var/run/docker.sock -XPOST \
         http://localhost/containers/create \
         -H"Content-Type: application/json" \
         -d'{
           "Image": "<image-id>",
           ...
           "HostConfig": {
             "Binds": [
               "/some/data/volume"
             ]
           }
         }'

    # Create container with data volume via CLI
    docker create -v /some/data/volume <image-id> <command>

However, this turned out not the be the case, as the former would create
a mount with no source and no corresponding volume:

    ...
    "Mounts": [
      {
        "Source": "",
        "Destination": "/some/data/volume",
        "Driver": "local",
        "Mode": "",
        "RW": true,
        "Propagation": "rprivate"
      }
    ],
    ...
    "Config": {
      ...
      "Volumes": null,
      ...
    }

...whereas the latter would create a volume and mount it:

    ...
    "Mounts": [
      {
        "Name": "9b38af46d6..."
        "Source": "/var/lib/docker/volumes/9b38af46d6.../_data",
        "Destination": "/some/data/volume",
        "Driver": "local",
        "Mode": "",
        "RW": true,
        "Propagation": ""
      }
    ],
    ...
    "Config": {
      ...
      "Volumes": {
        "/some/data/volume": {}
      },
      ...
    }

However, if you instead specify the data volume via the `Volumes` key,
then it works as expected, e.g.

    curl --unix-socket /var/run/docker.sock -XPOST \
         http://localhost/containers/create \
         -H"Content-Type: application/json" \
         -d'{
           "Image": "...",
           ...
           "Volumes": {"/some/data/volume": {}}
          }'

...will create a data volume and mount it.

Thus the documentation is either incorrect, or this is a bug and the
ability to create a data volume via `HostConfig.Binds` does not
work as advertised for API version 1.22 (and likely others).

I concluded that the documentation was incorrect. Since I've only
verified this behavior for Docker 1.10.2, I updated the docs for
API versions 1.22 and 1.23, but this may apply to other versions as
well.

[1] https://docs.docker.com/engine/reference/api/docker_remote_api_v1.22/#create-a-container

Signed-off-by: Shane da Silva <shane@dasilva.io>
Upstream-commit: 62fef18d69be7d8c5338fe5a471966dc1e6d68f7
Component: engine
2016-03-07 01:34:14 +00:00
Christian Böhme
345f6f4c72 Changed the Remote API reference to connect a container to a network in v1.22
and v1.23

Signed-off-by: Christian Böhme <development@boehme3d.de>
Upstream-commit: 2bd365ae2f9c80aa03db30c817ced6ee1d80aa45
Component: engine
2016-02-27 01:31:03 +01:00
ZJUshuaizhou
c78bf4e1c8 update all the versions from v1.19 to v1.23
update v1.22

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>

update all the versions docs

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>

revert v1,20

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>

update v1,20

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>

revert v1,20

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>

update v1,20

Signed-off-by: ZJUshuaizhou <21551191@zju.edu.cn>
Upstream-commit: 220a188ae820fac1198c54b7f0358525457a8609
Component: engine
2016-02-23 14:34:27 +08:00
hsinko
4baeda8a40 Update docker_remote_api_v1.22.md and v1.23 to complete the docs
Signed-off-by: hsinko <21551195@zju.edu.cn>

id in example request should be a exact value

Signed-off-by: hsinko <21551195@zju.edu.cn>

revert v1.22 doc

Signed-off-by: hsinko <21551195@zju.edu.cn>

fix tiny errors

Signed-off-by: hsinko <21551195@zju.edu.cn>
Upstream-commit: 5642cdeac5df08414744203235462a6b99261239
Component: engine
2016-02-22 20:49:10 +08:00
Roland Huß
d4a856da9f Extended explanation of NetworkMode's value
* Add network mode `none` to list of possible values for API version 1.15 - 1.23
* For API version 1.21 - 1.23 add explanation that any other value is taken as a custom network's name

Signed-off-by: Roland Huß <roland@jolokia.org>
Upstream-commit: c80b36c938306ef9cc9ad6865cfc251a694f59aa
Component: engine
2016-02-13 10:00:51 +01:00
Sebastiaan van Stijn
ec3cd49e30 Fix memory-swap description in older API versions
A value of -1 disables the *limit* so enables unlimited swap

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 1c95b858ac040974d2be73bb31d0d59af9b0b960
Component: engine
2016-02-02 14:49:14 +01:00
Sebastiaan van Stijn
18160b41cf Merge pull request #19846 from shin-/remote_api_container_update_doc
Update example request for container update in docs.
Upstream-commit: d069e8e7b7733fbde5889d3afd97cac21ff474b3
Component: engine
2016-01-30 08:05:55 -08:00
Vincent Demeester
8c7b621b27 Merge pull request #19646 from nishanttotla/19277-CustomInfoField
Display SystemStatus field in docker info
Upstream-commit: 6b573801730f7655a1e2ef1edc35df8e32b713f7
Component: engine
2016-01-30 11:48:01 +01:00
Joffrey F
6d05098f7a Update example request for container update in docs.
Signed-off-by: Joffrey F <joffrey@docker.com>
Upstream-commit: 5f0643b082d4fe5a7be9fa0a00088e3e37882824
Component: engine
2016-01-29 18:35:29 -08:00
Nishant Totla
9aabd7572f Adding SystemStatus field for /info endpoint
Signed-off-by: Nishant Totla <nishanttotla@gmail.com>
Upstream-commit: 6c5e8dd4c2351fac8bd76d409f44f42edd4b2f4a
Component: engine
2016-01-29 16:26:43 -08:00
Mary Anthony
e734434f58 Creating Engine specific menu
Fixing the links
Updating with Seb's comments
Adding weight
Fixing the engine aliases
Updating after Arun pushed
Removing empty file

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: e310d070f498a2ac494c6d3fde0ec5d6e4479e14
Component: engine
2016-01-26 15:58:53 -08:00
Wen Cheng Ma
819b85bb3a Add Subnets info for user-defined network
* If user doesn't specify the subnets to create a network, it will pick
  subnets from inside preferred pool. This PR aims to inspect these subnets info

* Add integration tests for docker inspect the subnets.

* docker-py project is already synchronized.

* jenkins checks depend on https://github.com/docker/docker-py/pull/888

Fixes issue #18626

Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
Upstream-commit: 5cc672b0061f3df41073cb7b4ff962998a13a09c
Component: engine
2016-01-15 10:03:29 +08:00
Ryan Belgrave
f8714c52f0 Add IPAM Config Options to match libnetwork
Signed-off-by: Ryan Belgrave <rmb1993@gmail.com>
Upstream-commit: 662cac08ef83ee105addb4d29f6e46188468306f
Component: engine
2016-01-14 14:32:25 -05:00
Wen Cheng Ma
806650627f Add network ID to container inspect
Fixes issue #19089

Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
Upstream-commit: 9f676ade0aef66bb66a26171d6bfb27f105fa1df
Component: engine
2016-01-14 22:33:41 +08:00
Vincent Demeester
da272e0828 Merge pull request #19317 from mavenugo/epforce
Forced endpoint cleanup
Upstream-commit: 851c94db1bafac593cf193dd9dde26cd3d9e7f23
Component: engine
2016-01-14 14:21:30 +01:00
Vincent Demeester
ae43fa875b Merge pull request #19286 from aboch/ipdocs
Add missing documentation for static IP options
Upstream-commit: ec143968de233c9767854e4c7ba08b3629070696
Component: engine
2016-01-14 11:00:09 +01:00
Vincent Demeester
ed3f8ef029 Merge pull request #19252 from HackToday/fix-vol-resp-doc
Update response content for volume mounts
Upstream-commit: 63525a6dc5f7be370736ec2905d40a8c8fdf1162
Component: engine
2016-01-14 09:15:13 +01:00
Madhu Venugopal
2b7ea75ef2 Forced endpoint cleanup
docker's network disconnect api now supports `Force` option which can be
used to force cleanup an endpoint from any host in the cluster.

Signed-off-by: Madhu Venugopal <madhu@docker.com>
Upstream-commit: b464f1d78cdfa2a4124e083b8f7b0f2353f12de3
Component: engine
2016-01-13 21:28:52 -08:00
Alessandro Boch
e45d68c9fe Add missing documentation for static IP options
Signed-off-by: Alessandro Boch <aboch@docker.com>
Upstream-commit: ee14232647085ce2faf7167959728977d36e5503
Component: engine
2016-01-13 14:53:14 -08:00
Chun Chen
9c6798de6b Add network interal mode
Signed-off-by: Chun Chen <ramichen@tencent.com>
Signed-off-by: David Calavera <david.calavera@gmail.com>
Upstream-commit: b70954e60a15d09756bd6b00a6fadedc64829477
Component: engine
2016-01-13 11:30:36 -05:00
Antonio Murdaca
69c1610f93 Merge pull request #19249 from calavera/carry_17414
[Carry 17414] Added additional container information to "docker info".
Upstream-commit: a79f96828f7da2fc762002bf79ab8a9dcf908457
Component: engine
2016-01-13 10:42:22 +01:00
Kai Qiang Wu(Kennan)
c28d7c537e Update response content for volume mounts
Signed-off-by: Kai Qiang Wu(Kennan) <wkqwu@cn.ibm.com>
Upstream-commit: 6a04ecf81333d7b26928f0dcbfb416ca788f287c
Component: engine
2016-01-13 03:48:14 +00:00
David Calavera
a4e709fac0 Complete documentation about extra container information.
Signed-off-by: David Calavera <david.calavera@gmail.com>
Upstream-commit: e5edc168a65e038245efbc5353a456302554f4eb
Component: engine
2016-01-12 18:16:58 -05:00
Vincent Demeester
62a5091381 Add a specific config for the update command
This allows to define clearly what is mutable or not in a container
and remove the use of the internal HostConfig struct to be used.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: a4f6920731c6af27a7e89c3da8d0e6fd309de90a
Component: engine
2016-01-12 08:33:41 +01:00
Alessandro Boch
7467c1af44 Allow user to choose the IP address for the container
Signed-off-by: Alessandro Boch <aboch@docker.com>
Upstream-commit: 2bb3fc1bc522059e9be5bd967b6a5c49917f5d0c
Component: engine
2016-01-08 10:09:16 -08:00
Oliver Neal
c4d25ca65c added documentation for groupadd within hostConfig that was added in remote api 1.20
Signed-off-by: Oliver Neal <ItsVeryWindy@users.noreply.github.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: ade71ace7df285795381d1317f8069f14e099bb3
Component: engine
2016-01-07 12:30:27 +01:00
Sebastiaan van Stijn
25ac09e895 Merge pull request #19090 from thaJeztah/fix-api-markdown
fix markdown and typos in API docs
Upstream-commit: 3442339b98dccc7137ea8d49393eff44166a67ec
Component: engine
2016-01-07 08:32:01 +01:00
moxiegirl
caf108c7a2 Merge pull request #19045 from wenchma/network_api_update
Update docker network api doc
Upstream-commit: 180ff8d5015d60f1d1d7c9838d476ca5e4fc6117
Component: engine
2016-01-05 10:55:56 -08:00
Sebastiaan van Stijn
40a92806fd fix markdown and typos in API docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 72472f5639fc92f3fd554e4eb860b0cb6938f7c2
Component: engine
2016-01-05 16:33:32 +01:00
Kai Qiang Wu(Kennan)
d4f5e05d82 Fix the unnecessary parameter
Signed-off-by: Kai Qiang Wu(Kennan) <wkqwu@cn.ibm.com>
Upstream-commit: 52b944dbba74b7d2be5bcabfe6937a5578020101
Component: engine
2016-01-05 10:26:01 +00:00
David Calavera
58e545b6bf Merge pull request #18888 from calavera/event_types
Event all the things!
Upstream-commit: 723be0a3325799fd6b2a6b689af54f5a07edf992
Component: engine
2016-01-04 13:07:33 -08:00
David Calavera
c2e5fdc393 Add filter by event type and documentation.
Signed-off-by: David Calavera <david.calavera@gmail.com>
Upstream-commit: 851fe00c64ffafeb27b12f7b0ed8e41f7720b477
Component: engine
2016-01-04 14:58:04 -05:00
Wen Cheng Ma
cf1cf1d767 Update docker network api doc
Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
Upstream-commit: d92d1de3d529343317e47f604963e5ad8476b3e6
Component: engine
2016-01-04 18:05:02 +08:00
Vincent Demeester
5582f5eb83 Implement configurable detach key
Implement configurable detach keys (for `attach`, exec`, `run` and
`start`) using the client-side configuration

- Adds a `--detach-keys` flag to `attach`, `exec`, `run` and `start`
  commands.
- Adds a new configuration field (in `~/.docker/config.json`) to
  configure the default escape keys for docker client.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 15aa2a663b47b6126a66efefcadb64edfbffb9f5
Component: engine
2016-01-03 23:03:39 +01:00
Qiang Huang
c4af30652d Implemet docker update command
It's used for updating properties of one or more containers, we only
support resource configs for now. It can be extended in the future.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
Upstream-commit: 8799c4fc0feadede6ae60e77bd7d9dfd7cc72a79
Component: engine
2015-12-28 19:19:26 +08:00