Commit Graph

1090 Commits

Author SHA1 Message Date
Misty Stanley-Jones
68aca71637 Fix link to non-existent file
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit ca04f02d7655e7306c7c0cde6fa1895a14f0a673)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:29:07 +02:00
Sebastiaan van Stijn
ca474f7808 Fix incorrect aux-address examples and test
The (host)name for aux-addresses should
be unique, otherwise later values overwrite
earlier values.

Before this change, the example command
would send this API request;

    {
      "Attachable": false,
      "CheckDuplicate": true,
      "Driver": "overlay",
      "EnableIPv6": false,
      "IPAM": {
        "Config": [
          {
            "Gateway": "192.168.0.100",
            "IPRange": "192.168.1.0/24",
            "Subnet": "192.168.0.0/16"
          },
          {
            "AuxiliaryAddresses": {
              "a": "192.170.1.5",
              "b": "192.170.1.6"
            },
            "Gateway": "192.170.0.100",
            "Subnet": "192.170.0.0/16"
          }
        ],
        "Driver": "default",
        "Options": {
        }
      },
      "Internal": false,
      "Labels": {
      },
      "Name": "my-multihost-network",
      "Options": {
      }
    }

After this change, the request looks
like this (all aux-addresses preserved);

    {
      "Attachable": false,
      "CheckDuplicate": true,
      "Driver": "overlay",
      "EnableIPv6": false,
      "IPAM": {
        "Config": [
          {
            "AuxiliaryAddresses": {
              "my-router": "192.168.1.5",
              "my-switch": "192.168.1.6"
            },
            "Gateway": "192.168.0.100",
            "IPRange": "192.168.1.0/24",
            "Subnet": "192.168.0.0/16"
          },
          {
            "AuxiliaryAddresses": {
              "my-printer": "192.170.1.5",
              "my-nas": "192.170.1.6"
            },
            "Gateway": "192.170.0.100",
            "Subnet": "192.170.0.0/16"
          }
        ],
        "Driver": "default",
        "Options": {
        }
      },
      "Internal": false,
      "Labels": {
      },
      "Name": "my-multihost-network",
      "Options": {
      }
    }

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit fd7161bb3061e2e2f56faed1a4ba1f7a887627bf)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:52 +02:00
Sebastiaan van Stijn
fc884da817 Add missing API docs for "privileged" and "user" exec
The "user" feature was added in docker 1.7.0, and
"privileged" feature was added in docker 1.9.0
only contained CLI docs.

This adds the missing API docs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit c53efdf4c1f0b2e7f1fe04294d9d64401b8b09b8)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:09 +02:00
Sebastiaan van Stijn
121cd6f9e6 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>
(cherry picked from commit 36a25bdbe4d973aef308fa11b450264dae1bc0b4)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:41 +02:00
yuexiao-wang
d4288a3212 Update on index refernce documentation
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
(cherry picked from commit 0483d776130aa6b7add845bdab3d1d8ee67f7480)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:34 +02:00
Sebastiaan van Stijn
cdda81146b Update API docs for "HostConfig.Binds"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 708892c4037e9eef6f6c25b5a3551f7779fb8868)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:27 +02:00
Sebastiaan van Stijn
7da3e5d0b2 Fix Markdown formatting and missing prompt in service create
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 533b00da8bed8336debf99a03f2fd2a0692fac6e)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:26:59 +02:00
yuexiao-wang
5508a82cac fix typo for docs reference
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
(cherry picked from commit 0f0b0db842e53c81191385395d6d040574eeb0d9)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:26:45 +02:00
Misty Stanley-Jones
0e29518469 Misty's edits and additions
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit 3de7d725137ee1620ae2050e65ace4990a3af87e)
(cherry picked from commit 5880d629533d9b8ad9889500fe841cb2e31a71c8)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:26:28 +02:00
Sebastiaan van Stijn
3bd4612aaf Add --mount syntax documentation to CLI reference
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit eb3a01eb432473beae968a0c9f3817af8b7a7d53)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:25:31 +02:00
Sebastiaan van Stijn
9a207a7eb7 Synchronize API docs
This synchronizes changes between API versions, and:

- applies e0a552504e64192946c86d3bdd517ae7b3af348f to
  older versions of the documentation
- applies a2a0a03e2b801545b2e3fb9e8476c76370da9175 to
  API version 1.25
- syncs some minor differences

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 53b1dcb25ca937c61bd47a29ba7be6e68abc25a5)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:25:09 +02:00
Sebastiaan van Stijn
ac1eb9edd0 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>
(cherry picked from commit d69409fd43e73829209315de79abf79000c4c720)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:25:02 +02:00
Alessandro Boch
e289fc155a Fix mtu option in documentation
Signed-off-by: Alessandro Boch <aboch@docker.com>
(cherry picked from commit e74a937b00af567b655c93224cc6a514f54e2b38)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:24:46 +02:00
Josh Bodah
bcc70e52eb Remove extra paren in run --link docs
Signed-off-by: Josh Bodah <jb3689@yahoo.com>
(cherry picked from commit 484fbe236dcab9fb5b8d48844a8cdc9d614e32e9)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:24:29 +02:00
Sebastiaan van Stijn
c84d8b8360 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>
(cherry picked from commit 87b174080bd8b1b9ea2bbfad8ef35a4c0dfe8ad4)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:23:30 +02:00
Sebastiaan van Stijn
ae9b46dbd0 Add link to logging drivers reference
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 7ca02f86de2ceef980cad98faefc15cbc628c91a)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:17:53 +02:00
Antonio Murdaca
7fad9da9f2 docs: reference: api: clarify pull all tags
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
(cherry picked from commit 03a8b6798d030a952e85f15208aeea1215e3f801)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:17:45 +02:00
Sebastiaan van Stijn
a8aaf5bfad Synchronize push reference with man page
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit dddea689ab45ce146e6ac3a1199235e1f36ffe29)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:17:37 +02:00
Sebastiaan van Stijn
c6ba6498b3 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>
(cherry picked from commit edbb8fb86d7d0b715adc15415f0cb187433092a5)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:17:29 +02:00
Sebastiaan van Stijn
c9ce561ac0 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>
(cherry picked from commit 86de72fef244b3fe209e5793deb40fb26f5b318e)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:17:14 +02:00
Victor Vieux
1ec9ca1ca6 Merge pull request #26866 from docker/cherry-picks-1.12.2
Cherry picks 1.12.2
2016-09-27 13:33:29 -07:00
Sebastiaan van Stijn
e9c655442a 1.12 Revert "Merge pull request #26030 from yongtang/08252016-doc-docker-create-rm"
This reverts commit 44180a48e9,
as `docker create --rm` is part of docker 1.13, so should
not be in the 1.12 branch

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-27 16:33:53 +02:00
Yong Tang
e892a54fa1 Fix incorrect help output in docker network ls
As is raised in 26312, in `docker network ls`, the help output was
mistaken to `volume names`:
```
-q, --quiet Only display volume names
```

This fix changes the help output to:
```
-q, --quiet Only display network IDs
```

This fix also updates the documentation in:
`docs/reference/commandline/network_ls.md`

This fix fixes 26312.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
(cherry picked from commit b9e46235fadc6b390e2c04c44b6a865e4ea97cb8)
Signed-off-by: Victor Vieux <vieux@docker.com>
2016-09-26 19:33:52 -07:00
Misty Stanley-Jones
24df982128 Clarify usage of --force when used on a swarm manager
Fixes #26125

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit 7b5c3d935a7a99b282f0f859101c887894a0b00e)
Signed-off-by: Victor Vieux <vieux@docker.com>
2016-09-26 19:33:45 -07:00
Misty Stanley-Jones
4da24ca1e3 Set docker_remote_api_v1.25.md to draft in 1.12.x branch
It does not apply to 1.12.x but we are leaving the file in place
to make future cherry-picks easier.

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-16 10:03:13 -07:00
Sebastiaan van Stijn
99ed95cb57 Merge pull request #26526 from lixiaobing10051267/masterSymble
fix some incorrect symbols before executing command
(cherry picked from commit 9e9ba1e1c1235c3bdb7a70a0a9d0c5932d5afe9e)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-16 10:03:13 -07:00
Brian Goff
9ec857ad5a Merge pull request #26472 from yongtang/09112016-docker-build-step-0
Fix documentation for `Step 0` to `Step 1` in `docker build`
(cherry picked from commit e41839e8a154f1336b3a995dba3f5912dde7e0fe)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-16 10:03:12 -07:00
Vincent Demeester
0183b3bf8c Merge pull request #26426 from sfsmithcha/carry_pry_25414
Carry pr 25414
(cherry picked from commit e6f76800f5880652382a6f9180bfdefe6aaad577)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-16 10:03:12 -07:00
Sven Dowideit
8f264db3f1 Merge pull request #26306 from deployable/patch-1
Remote API documentation consistancy
(cherry picked from commit 2cce7bf33a1af566670ec0fb2deeff8056b2798d)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-16 10:03:12 -07:00
Michael Crosby
b23bff1d9f Merge pull request #26224 from q384566678/test-zhou
Modify rename function use tips
(cherry picked from commit 061cc417591217c4bcf735267c2de18f2a8189c0)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-16 10:03:12 -07:00
Sebastiaan van Stijn
7c8dc9e6d5 Merge pull request #25817 from sfsmithcha/update_glossary
add swarm mode terms to the glossary
(cherry picked from commit 027e7be3482ff314f22dafcb7a4a2ab26b1a7ad7)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-14 09:48:29 -07:00
Vincent Demeester
c6e7fececb Merge pull request #25719 from eskaaren/master
You can force leave swarm
(cherry picked from commit daf454d8cd6146ef2cb644614301806ef59c58cc)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-14 09:48:23 -07:00
Misty Stanley-Jones
bf637439e7 Revert "Merge pull request #26236 from yuexiao-wang/remove-h-option"
This reverts commit eea99cd001.

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-12 11:02:09 -07:00
Vincent Demeester
eea99cd001 Merge pull request #26236 from yuexiao-wang/remove-h-option
Remove -h option for docker cli
(cherry picked from commit 01fe5639bc46ea6cc2efe7b9333bb4d1abb1894b)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-09 14:44:58 -07:00
Brian Goff
8a56561528 Merge pull request #26228 from lixiaobing10051267/masterPluginRm
check inconsistant command in docs/reference/commandline
(cherry picked from commit e96c0fafa0465e7d1a3a12fda820c16d0449f814)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-09 14:44:37 -07:00
Charles Smith
dc98c76772 Merge pull request #26156 from mstanleyjones/24905_swarm_noun_usage
Sanitize uses of Swarm as a proper and improper noun (Fixes #24905)
(cherry picked from commit 6f0502b89b29a7d23b02363d02104ec531a36e4a)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-09 14:44:29 -07:00
yuexiao-wang
0d800e9a37 clean up the run.md in reference
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
(cherry picked from commit dd02815a2673794cd94f3225c5517d9f30d09d56)
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-09 14:44:09 -07:00
Sven Dowideit
be71b62acf Merge pull request #26431 from mstanleyjones/2016.09.08-engine-docs-updates
2016.09.08 engine docs updates
2016-09-09 21:43:38 +10:00
Sven Dowideit
bf7d335513 Merge pull request #26218 from frosforever/fix_run_reference_typo
Correct typo in run reference docs that use the create command
(cherry picked from commit e73e37f11206a346d2a552c5d133112cd103d562)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-08 14:34:00 -07:00
Vincent Demeester
11330bf048 Merge pull request #26307 from AkihiroSuda/fix-doc-26291
fix docs about `sudo docker login`
(cherry picked from commit da763602afbb25ea4428e1d608af5ee017a0b94e)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 12:31:59 -07:00
Vincent Demeester
95bc4519d2 Merge pull request #26241 from YuPengZTE/devNote
The first letter of “docker“ is small
(cherry picked from commit b14f29dfbd527fd2dbd05e024f760939aba6642c)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 12:28:39 -07:00
Vincent Demeester
a42e2a0e42 Merge pull request #26192 from lixiaobing10051267/masterPluginInspect
make command "docker plugin inspect" complete
(cherry picked from commit cf699ad427084076c7ca1ea5fbab78cd77597f2a)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 12:18:44 -07:00
Vincent Demeester
1e9fb2f18e Merge pull request #26190 from lixiaobing10051267/masterNetworkCreate
provide actual command format for docker network create
(cherry picked from commit 37fd1416daac0b3963dc812a820b844e9e854e59)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 12:17:10 -07:00
Vincent Demeester
748f3ef8e3 Merge pull request #26185 from yuexiao-wang/update-docs
Update description for docker plugin inspect
(cherry picked from commit 0414a2c1a960832cc6d3df8641f23952c3700084)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 12:11:34 -07:00
Sven Dowideit
5c34d579dc Merge pull request #26302 from vdemeester/health_status-in-event-docs
Add health status as action on events documentations
(cherry picked from commit b468df9eac16d73c9b8e4853411df1fafea37d1f)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 12:04:23 -07:00
Vincent Demeester
7e2259bb63 Merge pull request #26271 from AkihiroSuda/fix-service-create-doc
update docs/reference/commandline/service_create.md
(cherry picked from commit 1a04d7b1e13ffe725a5310b55e83ae60b1ab7e55)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 12:03:07 -07:00
Vincent Demeester
b7e9344365 Merge pull request #26258 from mstanleyjones/25625_swarm_init_return_value
Add response to swarm/init example (fixes #25625
(cherry picked from commit d4e173fc347911999458eb82fe4c0fd1b3818218)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 12:02:00 -07:00
Justin Cormack
e773b059d1 Merge pull request #26139 from yuexiao-wang/fix-link
Modify link for hub and registry
(cherry picked from commit ad6f5a49d5f24f8b64def11176b6c8df162d839f)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 11:37:03 -07:00
Vincent Demeester
934d7b83ef Merge pull request #26135 from kmkr/master
Fix typo in builder.md
(cherry picked from commit 20869b5650bd059cd67969f9774fb4eb78b6dbfd)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 11:36:27 -07:00
Justin Cormack
9bef12dcfd Merge pull request #26096 from ohmystack/fix/docs-dockerd
Add docs for "--containerd" in dockerd
(cherry picked from commit 644cb53b41b49fd750fe9c86e922125ef8156259)

Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-09-06 11:31:55 -07:00