Commit Graph

123 Commits

Author SHA1 Message Date
Benjamin Böhmke 64776dd72f added ip6tables to daemon CLI and config file doc
Signed-off-by: Benjamin Böhmke <benjamin@boehmke.net>
2020-11-18 22:02:06 +01:00
Tianon Gravi 8258fc9059 Add "--containerd-namespace" daemon flags in completion and docs
This also adds the missing `containerd` key in the example daemon configuration files.

Signed-off-by: Tianon Gravi <admwiggin@gmail.com>
2020-11-06 12:34:10 -08:00
Tianon Gravi 184e5feb72 Use consistent formatting and sorted keys in all JSON examples for dockerd reference
To create this, I ran every JSON document through `jq -S` (which sorts the keys and consistently pretty-prints the result in a format which matches the majority of documents in this file).

Signed-off-by: Tianon Gravi <admwiggin@gmail.com>
2020-11-06 11:52:06 -08:00
Sebastiaan van Stijn 6a02a51c99
docs: remove some references to obsolete docker versions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-26 18:30:01 +01:00
Akihiro Suda beb23c9963
docs: update for cgroup v2 and rootless
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2020-06-24 19:24:54 +09:00
Silvin Lubecki a03873828b
Merge pull request #2574 from thaJeztah/carry_environment_variables
Environment variable changes (carry #806)
2020-06-17 16:29:57 +02:00
Sargun Dhillon e1148e2c70
Add MOBY_DISABLE_PIGZ to dockerd environment variable docs
This reflects a Moby change to add documentation around
disabling a new feature -- to use pgzip to decompress
layers, rather than the built-in go gzip.

Signed-off-by: Sargun Dhillon <sargun@sargun.me>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-06-11 13:57:23 +02:00
Sargun Dhillon ad301e7410
Split up environment variable documentation between cli and dockerd
This creates a new section of environment variables in the CLI docs
which documents environment variables that can both be used on dockerd
and on docker cli.

In addition, it moves some of the environment variable documentation
from the docker cli documentation to the dockerd documentation, as
these environment variables are dockerd-specific.

Signed-off-by: Sargun Dhillon <sargun@sargun.me>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-06-11 13:54:39 +02:00
Sebastiaan van Stijn 98a3d6a48a
docs: fix broken link in dockerd.md
The Engine API docs are not available in this GitHub repository,
so linking to the docs.docker.com website instead.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-05-25 11:07:10 +02:00
Sebastiaan van Stijn 4d948e468b
docs: more Markdown touch-ups
- replace the "none" code-hint with "console"
- some changes in the "experimental" instructions
- reformat some notes
- reformat / re-indent JSON output to use 2 spaces (for consistency)
- split JSON outputs to separate code-block so that it can be highlighted

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-05-11 17:32:52 +02:00
Sebastiaan van Stijn e23a1fca92
docs: update dockerd usage
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-05-04 16:22:24 +02:00
Sebastiaan van Stijn d096339f41
docs: update usage output for dockerd (19.03)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-05-04 12:59:18 +02:00
Sebastiaan van Stijn 9a58504d33
docs: fix order of flags in usage, and fix missing quote
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-05-04 12:35:25 +02:00
Sebastiaan van Stijn 6ae5df423a
reference docs: reformat notes
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-19 17:52:26 +02:00
Sebastiaan van Stijn f912deeec7
Fix whitespace that caused short-format in generated YAML
If the markdown contains trailing spaces, or has tabs included,
the YAML generator uses a compact format for the text (using `\n`
and `\t`, instead of plain newlines).

The compact format makes it difficult to review changes in the
yaml docs when vendoring in the documentation repository.

This patch:

- removes trailing whitespace
- replaces tabs for spaces
- fixes some minor formatting and markdown issues

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-15 15:37:23 +01:00
Sebastiaan van Stijn 4cd4305b31
docs: add redirect for old location of daemon reference
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-21 14:55:23 +01:00
Rob Gulewich 5ad1d4d4c8 docker run: specify cgroup namespace mode with --cgroupns
Signed-off-by: Rob Gulewich <rgulewich@netflix.com>
2020-01-29 22:50:37 +00:00
Lukas Heeren 86281a7b4b
daemon: document --max-download-attempts option
update docs based on PR 39949

Signed-off-by: Lukas Heeren <lukas-heeren@hotmail.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-10-15 12:06:58 +02:00
Sebastiaan van Stijn 5331358d3e
Fix PowerShell codehint for rouge
Rouge is case-sensitive, and only works with powershell
all lowercase.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-05-13 16:37:30 -07:00
stevejr 04f88005c9 Corrected max-file option - was incorrectly spelt as max-files
Signed-off-by: Steve Richards <steve.richards@docker.com>
2019-02-13 12:29:34 +00:00
Frederic Hemberger 89aa2cf9f6 docs(metrics-addr): Use port 9323, allocated for Docker in prometheus
Signed-off-by: Frederic Hemberger <mail@frederic-hemberger.de>
2018-12-21 19:31:54 +01:00
Anne Henmi 4aecd8bda1 Fixed typo.
Signed-off-by: Anne Henmi <anne.henmi@docker.com>
2018-12-12 08:41:11 -07:00
Sebastiaan van Stijn fd33e0d933
Update daemon.json example to show that log-opts must be a string
log-opts are passed to logging-drivers as-is, so the daemon is not
aware what value-type each option takes.

For this reason, all options must be provided as a string, even if
they are used as numeric values by the logging driver.

For example, to pass the "max-file" option to the default (json-file)
logging driver, this value has to be passed as a string;

```json
{
  "log-driver": "json-file",
  "log-opts": {
    "max-size": "10m",
    "max-file": "3"
  }
}
```

When passed as a _number_ (`"max-file": 3`), the daemon will invalidate
the configuration file, and fail to start;

    unable to configure the Docker daemon with file /etc/docker/daemon.json: json: cannot unmarshal number into Go value of type string

This patch adds an example to the daemon.json to show these  values
have to be passed as strings.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-11-21 13:26:08 +01:00
Akihiro Suda 16b014e062 docs, ssh: unsupport password auth explicitly
The issue with password auth is tracked in #1476 and #1477 .

Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2018-10-25 16:02:26 +09:00
Sebastiaan van Stijn 3eaae8391b
Merge pull request #1447 from sudo-bmitch/pr-daemon-json-formatting
Adjust formatting on daemon.json documentation
2018-10-18 17:52:08 +02:00
Brandon Mitchell 1c3aa2ea7a Adjust formatting on daemon.json documentation
Signed-off-by: Brandon Mitchell <git@bmitch.net>
2018-10-13 14:07:47 -04:00
Brandon Mitchell 3f4f450941 Documenting example default-ulimit in daemon.json
Signed-off-by: Brandon Mitchell <git@bmitch.net>
2018-10-13 13:53:34 -04:00
Anda Xu d656706678 update docs with current supported features options
Signed-off-by: Anda Xu <anda.xu@docker.com>
2018-08-30 16:49:37 -07:00
Anda Xu 3e0b0a6692 update docs with the new features option in daemon.json
Signed-off-by: Anda Xu <anda.xu@docker.com>
2018-08-23 13:46:29 -07:00
Akihiro Suda 6f61cf053a support SSH connection
e.g. docker -H ssh://me@server

The `docker` CLI also needs to be installed on the remote host to
provide `docker system dial-stdio`, which proxies the daemon socket to stdio.

Please refer to docs/reference/commandline/dockerd.md .

Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2018-08-02 13:10:06 +09:00
Vimal Raghubir a205aecb80 Add: Add missing option
Signed-off-by: Vimal-Raghubir <vraghubir0418@gmail.com>
2018-06-26 22:20:01 -04:00
wanglei b6def77c55 Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Signed-off-by: nkwangleiGIT <nkwanglei@126.com>
2018-05-16 20:16:08 +08:00
selansen 75c7b95e7a Allow user to specify default address pools for docker networks
This is separate commit for CLI files to address PR 36054

Signed-off-by: selansen <elango.siva@docker.com>
2018-05-05 19:46:28 -04:00
Sebastiaan van Stijn 6a2b9d0267
Merge pull request #748 from thaJeztah/fix-storage-driver-anchors
Fix anchors to "Storage driver options"
2017-12-13 09:53:05 -08:00
Sebastiaan van Stijn 630f8b1254
Fix anchors to "Storage driver options"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-12-12 17:27:05 -08:00
Sebastiaan van Stijn a119e39f0c
Update docs and completion-scripts for deprecated features
- the `--disable-legacy-registry` daemon flag was removed
- duplicate keys with conflicting values for engine labels
  now produce an error instead of a warning.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-12-12 17:09:38 -08:00
Renaud Gaubert fe07ca70d6 Added docs for dockerd
Signed-off-by: Renaud Gaubert <renaud.gaubert@gmail.com>
2017-11-28 18:03:10 +01:00
Abdur Rehman c3fe9d85ef fix a number of minor typos
Fix 19 typos, grammatical errors and duplicated words.

These fixes have minimal impact on the code as these are either in the
doc files or in comments inside the code files.

Signed-off-by: Abdur Rehman <abdur_rehman@mentor.com>
2017-10-31 15:21:51 +05:00
Sebastiaan van Stijn 1e5d013064
Fix daemon.json runtime example
The example in the documentation used "runc", which is a
reserved runtime name (as it's the default).

This patch updates the example, and uses a different name.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-10-26 02:15:49 +02:00
BastianHofmann c7867f5cc6 Fix json formatting in dockerd docs
Fix another json formatiing error.

Signed-off-by: Bastian Hofmann <bastianhofmann@me.com>
2017-10-25 08:50:34 +02:00
Sebastiaan van Stijn 1649af8129 Merge pull request #598 from thaJeztah/fix-dockerd-heading-levels
Fix dockerd reference heading levels
2017-10-06 01:51:19 +02:00
Frieder Bluemle 45c9b9b6c1
Fix GitHub spelling
Signed-off-by: Frieder Bluemle <frieder.bluemle@gmail.com>
2017-10-05 01:14:31 +08:00
Sebastiaan van Stijn aca0421eb8
Fix dockerd reference heading levels
Commit ddadd3db49 changed
the heading levels of various sections, but as a result,
the "daemon configuration file" section (and other sections)
changed from a H2 to a H4, therefore no longer showing
up in the page's TOC / navigation bar.

This patch changes the heading level to a H3 for
sections that should show up in the page navigation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-10-04 18:09:12 +02:00
John Howard c848f9acb6 Docs for Windows daemon graphdriver options
Signed-off-by: John Howard <jhoward@microsoft.com>
2017-08-15 10:20:15 -07:00
Kir Kolyshkin 6d85a4f5f8 Fix repo references in docs
Since CLI was moved to a separate repo, these references are incorrect.
Fixed with the help of sed script, verified manually.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
2017-07-28 10:32:42 -07:00
Aleksa Sarai c7710819a5
docs: add documentation for dm.libdm_log_level
This is a new option added specifically to allow for debugging of bugs
in Docker's storage drivers or libdm itself.

Signed-off-by: Aleksa Sarai <asarai@suse.de>
2017-07-14 16:52:33 +10:00
Dhawal Yogesh Bhanushali ff2552f7a1 Adding docs for "overlay2.size" storage-opt
Signed-off-by: Dhawal Yogesh Bhanushali <dbhanushali@vmware.com>
2017-06-27 23:58:57 -07:00
Misty Stanley-Jones 8222baf263 Remove specific config info about userns-remap
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-06-22 15:09:14 -07:00
Sebastiaan van Stijn ee1bbab620 Update docs, completion scripts for disable-legacy-registry
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 2b8f0eef7338f37104464154ba65aef7db3b9703)
Signed-off-by: Tibor Vass <tibor@docker.com>
2017-06-14 02:48:46 +00:00
Noah Treuhaft 9810554494 Add daemon option to push foreign layers
The --allow-nondistributable-artifacts daemon option specifies
registries to which foreign layers should be pushed.  (By default,
foreign layers are not pushed to registries.)

Additionally, to make this option effective, foreign layers are now
pulled from the registry if possible, falling back to the URLs in the
image manifest otherwise.

This option is useful when pushing images containing foreign layers to a
registry on an air-gapped network so hosts on that network can pull the
images without connecting to another server.

Signed-off-by: Noah Treuhaft <noah.treuhaft@docker.com>
2017-06-02 00:11:05 +00:00