Commit graph

5721 commits

Author SHA1 Message Date
Ding Fei
46cc5c05aa
Fix typos in docs/reference/builder.md.
Signed-off-by: Ding Fei <dingfei@stars.org.cn>
(cherry picked from commit 9ccb1f159e)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 19:09:19 +01:00
Sebastiaan van Stijn
06b34e507d
Improve API format examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 8e02b29d24)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 19:09:08 +01:00
Sebastiaan van Stijn
554400b75b
Add KernelMemory to API changelog
Commit 9bd8a9b66b
added KernelMemory to the API, but forgot
to include this in the API changelog.

This adds the missing entry in the API
changelog.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit f988a9ce5e)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 19:08:58 +01:00
Sebastiaan van Stijn
6d972ff0f7
Improve example for env vars in API docs
This was added in e41de3e631,
but can be a bit confusing due to the "outer" brackets
being for JSON, and the "inner" brackets to indicate
optional values.

During review of that change, this alternative
format was suggested.

Updating the example to use the format that was discussed
during review :)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 441c9411e3)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 19:08:48 +01:00
Alicia Lauerman
39466e3144 add documentation for docker stack ps
also updates related stack docs and removes stack_tasks.md

Signed-off-by: Alicia Lauerman <allydevour@me.com>
(cherry picked from commit 970ab9a224)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 19:07:57 +01:00
milindchawre
073515574d
Fixes #27095 : Removing registrytoken field from doc as it is deprecated by identitytoken field
Signed-off-by: milindchawre <milindchawre@gmail.com>
(cherry picked from commit 72dd684c88)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 18:55:40 +01:00
Yong Tang
3707a30459 Update docs for node filter of docker service ps
As is specified in 26964, it is possible to specify
a filter based on the node name or node ID.

This fix updates the related docs for that.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
(cherry picked from commit c326e0afe3)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 18:55:03 +01:00
Sebastiaan van Stijn
5dab892618
docs: add missing IPAM options to API docs
Commit dd28ded711
brought in new networking features and API, but
did not document the available IPAM options.

This adds a description of those options.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit d69fce79f9)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-12-12 18:48:36 +01:00
GuyTempleton
1d7418f212 Add missing quote mark and fix grammar in inspect docs
Signed-off-by: GuyTempleton <Guy.Templeton@skyscanner.net>
2016-11-21 09:10:28 +00:00
Misty Stanley-Jones
438d8fa3db Change metadata for plugin ref docs and deprecation doc
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-11-10 13:49:13 -08:00
Misty Stanley-Jones
cf60af87f9 Formatting changes to make 1.12.x ref docs buildable in Jekyll
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-11-09 13:07:24 -08:00
allencloud
180d122c5b make remove network return 204
Signed-off-by: allencloud <allen.sun@daocloud.io>
(cherry picked from commit ea07ef7a7c)
Signed-off-by: Victor Vieux <vieux@docker.com>
2016-09-30 22:49:20 -07:00
Sebastiaan van Stijn
d49c31e3c1
Hide API v1.25 docs
API v1.25 is for Docker 1.13. Commit
4da24ca1e3 was meant
to put it in draft mode, but added this
option in the "menu" section.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 23:18:12 +02:00
Misty Stanley-Jones
a114655b56 Merge pull request #27036 from mstanleyjones/fix_labels_nav
Fix menu position of the labels-custom-metadata.md topic
(cherry picked from commit a3286783bc)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-29 11:05:34 -07:00
Sebastiaan van Stijn
ed69445474 Merge pull request #27031 from mstanleyjones/fix_broken_image_link
Revert "Add direct link to event chart image"
(cherry picked from commit 6f07a4a69b)

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-09-29 10:23:10 -07:00
Misty Stanley-Jones
68aca71637
Fix link to non-existent file
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit ca04f02d76)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:29:07 +02:00
Victoria Bialas
735622fdf4
added better Docker Machine links to Swarm tutorial d4mac, d4win, copyedits
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
(cherry picked from commit 0a76a4cb5b)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:29:00 +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 fd7161bb30)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:52 +02:00
allencloud
c93303b8d7
move mcvlan out of experimental docs
Signed-off-by: allencloud <allen.sun@daocloud.io>
(cherry picked from commit 6e4ec046f4)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:35 +02:00
yuexiao-wang
96b5ec8f50
Fix the broken link
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
(cherry picked from commit cfb07e642d)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:29 +02:00
yuexiao-wang
394ce0c9c1
Fix typo for how pki works
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
(cherry picked from commit bf9c6d3115)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:22 +02:00
lixiaobing10051267
729717568b
the network id is not consistant with the real id created
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
(cherry picked from commit 392aae44fd)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:16 +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 c53efdf4c1)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:09 +02:00
Hans Kristian Flaatten
9363b42e59
docs: add missing 'on' in Oracle installation guide
Signed-off-by: Hans Kristian Flaatten <hans.flaatten@evry.com>
(cherry picked from commit 838fe65e53)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:28:02 +02:00
Jeff Silberman
2659333a27
Add Portworx Volume Plugin Description
Signed-off-by: Jeff Silberman <jsilberm@gmail.com>
(cherry picked from commit da2159ea1c)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:55 +02:00
Misty Stanley-Jones
67610e9dea
Restructure content about Docker object labels
A few points of work:

- Took the topic out of the left-hand nav and made it
  reachable from the User guide intro

- Condensed the topic's contents, presenting only conceptual
  info and pointing instead to the command-line references
  for each type of object

- Added brief information about the `LABELS` keyword to the
  Dockerfile reference

A big part of the point is to establish a pattern of
thinking and use around how Docker uses labels and what they
mean in different contexts.

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
(cherry picked from commit 5c4c062ffc)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:48 +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 36a25bdbe4)
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 0483d77613)
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 708892c403)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:27 +02:00
Steven Erenst
ddc58225f3
Fix regex for the json-file logger opts in overview.md
The regex used to describe the max-file and max-size logging options for
the json-file logger were incorrect. The regexes would only match a
single character (a digit or a literal +). Instead the regexes should
match 1 or more digits.

The character class for the units of the max-size also included a pipe
which meant that the regex would match 1| instead of only matching 1m,
1k, and 1g.

Signed-off-by: Steven Erenst <stevenerenst@gmail.com>
(cherry picked from commit e9a9015e38)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:21 +02:00
Sebastiaan van Stijn
22a3332325
Cleanup / sync RHEL, CentOS, Fedora installation docs
These installation procedures are very similar, so
synchronized these docs and removed some differences.

Also;

- updated markdown, added language-hints where possible
- replaced "service docker start" with "systemctl start"
- replaced "chkconfig docker on" with "systemctl enable"
- added "systemctl enable" to the list of steps for
  installation, because most people want to have docker
  started automatically (and overlooked this step).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit b2bb4e11aa)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:14 +02:00
Alex Olshansky
7df1b6a962
Fix typos in installation doc for Mac
Signed-off-by: Alex Olshansky <i@creagenics.com>
(cherry picked from commit f7af5cc780)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:27:06 +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 533b00da8b)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:26:59 +02:00
Sebastiaan van Stijn
03a4e9a397
Update sshd example to use ubuntu 16.04
Although the example is just for illustrational
purposes, many users are now switching to
Ubuntu 16.04 as the "default" version for Ubuntu,
so updating the example for those that use
this example as a starting point.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit b81d12e7a1)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:26:52 +02:00
yuexiao-wang
5508a82cac
fix typo for docs reference
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
(cherry picked from commit 0f0b0db842)
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 5880d62953)
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 eb3a01eb43)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:25:31 +02:00
YuPengZTE
f81e4e8d57
The hit is missed
Signed-off-by: YuPengZTE <yu.peng36@zte.com.cn>
(cherry picked from commit ced2729841)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:25:24 +02:00
pestophagous
1edf705917
Fix typo in docs. s/methodoligies/methodologies/
Signed-off-by: K Heller <pestophagous@gmail.com>
(cherry picked from commit 191adcfb63)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:25:15 +02:00
Sebastiaan van Stijn
9a207a7eb7
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>
(cherry picked from commit 53b1dcb25c)
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 d69409fd43)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:25:02 +02:00
lixiaobing10051267
f9f6145003
add bash symbol for docker network inspect
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
(cherry picked from commit 7c3a26db16)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:24:55 +02:00
Alessandro Boch
e289fc155a
Fix mtu option in documentation
Signed-off-by: Alessandro Boch <aboch@docker.com>
(cherry picked from commit e74a937b00)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:24:46 +02:00
YuPengZTE
8ae21d6d4d
The etc and dot is seprated
Signed-off-by: YuPengZTE <yu.peng36@zte.com.cn>
(cherry picked from commit bd914ff5a3)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:24:38 +02:00
Josh Bodah
bcc70e52eb
Remove extra paren in run --link docs
Signed-off-by: Josh Bodah <jb3689@yahoo.com>
(cherry picked from commit 484fbe236d)
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 87b174080b)
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 7ca02f86de)
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 03a8b6798d)
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 dddea689ab)
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 edbb8fb86d)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-09-29 14:17:29 +02:00