From d2e771fed6f48011d34181a2f133daab8167f479 Mon Sep 17 00:00:00 2001 From: Anda Xu Date: Mon, 27 Aug 2018 15:52:50 -0700 Subject: [PATCH 01/10] update docs with current supported features options Signed-off-by: Anda Xu (cherry picked from commit d6567066782c1003f6b7b444dcbb6cbbea0461d7) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/dockerd.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/reference/commandline/dockerd.md b/docs/reference/commandline/dockerd.md index d211fce5a6..3ce72bb44b 100644 --- a/docs/reference/commandline/dockerd.md +++ b/docs/reference/commandline/dockerd.md @@ -1424,6 +1424,16 @@ This is a full example of the allowed configuration options on Windows: } ``` +#### Feature options +The optional field `features` in `daemon.json` allows users to enable or disable specific +daemon features. For example, `{"features":{"buildkit": true}}` enables `buildkit` as the +default docker image builder. + +The list of currently supported feature options: +- `buildkit`: It enables `buildkit` as default builder when set to `true` or disables it by +`false`. Note that if this option is not explicitly set in the daemon config file, then it +is up to the cli to determine which builder to invoke. + #### Configuration reload behavior Some options can be reconfigured when the daemon is running without requiring From cb4cd04c64b10e78d1c4b87c5dfbd7334f4f93df Mon Sep 17 00:00:00 2001 From: Rui Cao Date: Wed, 12 Sep 2018 23:02:32 +0800 Subject: [PATCH 02/10] Typo fix: filesytem -> filesystem Signed-off-by: Rui Cao (cherry picked from commit 2eb95909ee6f9529e25be00ac798ca0b5d5ecc9c) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index 446d5d81ab..bef7c07631 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -85,7 +85,7 @@ Options: --memory-reservation string Memory soft limit --memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap --memory-swappiness int Tune container memory swappiness (0 to 100) (default -1) - --mount value Attach a filesytem mount to the container (default []) + --mount value Attach a filesystem mount to the container (default []) --name string Assign a name to the container --network-alias value Add network-scoped alias for the container (default []) --network string Connect a container to a network (default "default") From 0ee4693953be957013bbc35dcf7869bc9e4a02a8 Mon Sep 17 00:00:00 2001 From: Lihua Tang Date: Fri, 7 Sep 2018 13:25:58 +0800 Subject: [PATCH 03/10] Typo fix Signed-off-by: Lihua Tang (cherry picked from commit ca5e4531800bd08f88c5b4b1c382094edcdd5d5e) Signed-off-by: Sebastiaan van Stijn --- cli/command/trust/sign_test.go | 2 +- docs/reference/commandline/create.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cli/command/trust/sign_test.go b/cli/command/trust/sign_test.go index 5a7b6b5f37..bb8cacad9a 100644 --- a/cli/command/trust/sign_test.go +++ b/cli/command/trust/sign_test.go @@ -148,7 +148,7 @@ func TestAddStageSigners(t *testing.T) { assert.NilError(t, err) changeList := cl.List() assert.Check(t, is.Len(changeList, 4)) - // ordering is determinstic: + // ordering is deterministic: // first change is for targets/user key creation newSignerKeyChange := changeList[0] diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index bef7c07631..d585da40ae 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -256,5 +256,5 @@ docker create --device-cgroup-rule='c 42:* rmw' -name my-container my-image Then, a user could ask `udev` to execute a script that would `docker exec my-container mknod newDevX c 42 ` the required device when it is added. -NOTE: initially present devices still need to be explicitely added to +NOTE: initially present devices still need to be explicitly added to the create/run command From f8f230181e47c2c6a33feae9da5c2e83c9af107a Mon Sep 17 00:00:00 2001 From: Alex Mayer Date: Fri, 28 Sep 2018 17:40:22 -0400 Subject: [PATCH 04/10] Docs: Add Spaces Around Parenthesis Where Needed Signed-off-by: Alex Mayer (cherry picked from commit 2b0fdd0f17dba1ae16fbb19c061c4b81d3eb92d5) Signed-off-by: Sebastiaan van Stijn --- docs/deprecated.md | 2 +- docs/reference/builder.md | 2 +- docs/reference/commandline/run.md | 2 +- docs/reference/run.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/deprecated.md b/docs/deprecated.md index 0a6e359183..1ca390a897 100644 --- a/docs/deprecated.md +++ b/docs/deprecated.md @@ -198,7 +198,7 @@ The docker login command is removing the ability to automatically register for a **Target For Removal In Release: v17.06** -The flag `--security-opt` doesn't use the colon separator(`:`) anymore to divide keys and values, it uses the equal symbol(`=`) for consistency with other similar flags, like `--storage-opt`. +The flag `--security-opt` doesn't use the colon separator (`:`) anymore to divide keys and values, it uses the equal symbol (`=`) for consistency with other similar flags, like `--storage-opt`. ### `/containers/(id or name)/copy` endpoint diff --git a/docs/reference/builder.md b/docs/reference/builder.md index fbf71cd4d8..88a51fb59d 100644 --- a/docs/reference/builder.md +++ b/docs/reference/builder.md @@ -1379,7 +1379,7 @@ Keep the following things in mind about volumes in the `Dockerfile`. data within the volume after it has been declared, those changes will be discarded. - **JSON formatting**: The list is parsed as a JSON array. - You must enclose words with double quotes (`"`)rather than single quotes (`'`). + You must enclose words with double quotes (`"`) rather than single quotes (`'`). - **The host directory is declared at container run-time**: The host directory (the mountpoint) is, by its nature, host-dependent. This is to preserve image diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index 71d6c6348b..08b9f18d68 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -418,7 +418,7 @@ $ docker run -l my-label --label com.example.foo=bar ubuntu bash ``` The `my-label` key doesn't specify a value so the label defaults to an empty -string(`""`). To add multiple labels, repeat the label flag (`-l` or `--label`). +string (`""`). To add multiple labels, repeat the label flag (`-l` or `--label`). The `key=value` must be unique to avoid overwriting the label value. If you specify labels with identical keys but different values, each subsequent value diff --git a/docs/reference/run.md b/docs/reference/run.md index b7480682a6..a4889b892d 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -1085,7 +1085,7 @@ per second from `/dev/sda`: $ docker run -it --device-read-bps /dev/sda:1mb ubuntu -The `--device-write-bps` flag limits the write rate (bytes per second)to a device. +The `--device-write-bps` flag limits the write rate (bytes per second) to a device. For example, this command creates a container and limits the write rate to `1mb` per second for `/dev/sda`: From 2e7e529a18095db72c0a63a091ebe3e03f8b5a61 Mon Sep 17 00:00:00 2001 From: Thomas Riccardi Date: Wed, 3 Oct 2018 20:04:24 +0200 Subject: [PATCH 05/10] Fix login documentation layout ddadd3db494ce568a6b847932677f837802ea6b5 mass standardized the formatting, with some errors. This commit fixes errors on `login.md`: - revert wrong `Logging out` headline - restore correct level for some headlines (relative to parent headline level change) - re-add `Usage` headlines, with better name Also add `related commands` headline on `login` and `logout`. Signed-off-by: Thomas Riccardi (cherry picked from commit a0e3ec87909320e1d8214ded8f8b42cea3f3a829) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/login.md | 12 +++++++++--- docs/reference/commandline/logout.md | 4 ++++ 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/reference/commandline/login.md b/docs/reference/commandline/login.md index 3ebeec3d41..95d14d2b55 100644 --- a/docs/reference/commandline/login.md +++ b/docs/reference/commandline/login.md @@ -85,6 +85,8 @@ you can download them from: - Microsoft Windows Credential Manager: https://github.com/docker/docker-credential-helpers/releases - [pass](https://www.passwordstore.org/): https://github.com/docker/docker-credential-helpers/releases +#### Configure the credentials store + You need to specify the credentials store in `$HOME/.docker/config.json` to tell the docker engine to use it. The value of the config property should be the suffix of the program to use (i.e. everything after `docker-credential-`). @@ -99,7 +101,7 @@ For example, to use `docker-credential-osxkeychain`: If you are currently logged in, run `docker logout` to remove the credentials from the file and run `docker login` again. -### Default behavior +#### Default behavior By default, Docker looks for the native binary on each of the platforms, i.e. "osxkeychain" on macOS, "wincred" on windows, and "pass" on Linux. A special @@ -108,7 +110,7 @@ it cannot find the "pass" binary. If none of these binaries are present, it stores the credentials (i.e. password) in base64 encoding in the config files described above. -### Credential helper protocol +#### Credential helper protocol Credential helpers can be any program or script that follows a very simple protocol. This protocol is heavily inspired by Git, but it differs in the information shared. @@ -162,7 +164,7 @@ designated programs to handle credentials for *specific registries*. The default credential store (`credsStore` or the config file itself) will not be used for operations concerning credentials of the specified registries. -### Logging out +#### Configure credential helpers If you are currently logged in, run `docker logout` to remove the credentials from the default store. @@ -182,3 +184,7 @@ For example: } } ``` + +## Related commands + +* [logout](logout.md) diff --git a/docs/reference/commandline/logout.md b/docs/reference/commandline/logout.md index f930fe7b7c..19762b2a36 100644 --- a/docs/reference/commandline/logout.md +++ b/docs/reference/commandline/logout.md @@ -30,3 +30,7 @@ Options: ```bash $ docker logout localhost:8080 ``` + +## Related commands + +* [login](login.md) From 1df47ffb4da2dc47da2adc2059039ffbbcaeaded Mon Sep 17 00:00:00 2001 From: Jake Lambert <32850427+jake-lambert-volusion@users.noreply.github.com> Date: Thu, 4 Oct 2018 14:32:58 -0500 Subject: [PATCH 06/10] Clarify in docs that docker tag doesn't publish I am attempting to push a tag to a private repository. The documentation for `docker tag` has an explicit example to for how ["To push an image to a private registry"](https://docs.docker.com/engine/reference/commandline/tag/#tag-an-image-referenced-by-name). My colleague clarified that this command does not in fact push anything, so I thought this PR might save some future novice the same confusion. Signed-off-by: Jake Lambert (cherry picked from commit 4ed484bac42c7b9bf862490a4cb0fa5b5255228c) Signed-off-by: Sebastiaan van Stijn --- man/src/image/tag.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/src/image/tag.md b/man/src/image/tag.md index 16abd75290..2b5a45cc51 100644 --- a/man/src/image/tag.md +++ b/man/src/image/tag.md @@ -48,7 +48,7 @@ repository with "version1.0.test": ## Tagging an image for a private repository -To push an image to a private registry and not the central Docker +Before pushing an image to a private registry and not the central Docker registry you must tag it with the registry hostname and port (if needed). docker image tag 0e5574283393 myregistryhost:5000/fedora/httpd:version1.0 From 7c7fe26a6fefa892e7e9ce492aa7c100d95a78fe Mon Sep 17 00:00:00 2001 From: Scott Brenner Date: Wed, 10 Oct 2018 12:56:40 -0700 Subject: [PATCH 07/10] Minor typo fix in run documentation Quick syntax fix! Signed-off-by: Scott Brenner (cherry picked from commit 50143cff1213cb5d9db57bfabf22615e15baaeea) Signed-off-by: Sebastiaan van Stijn --- docs/reference/run.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/run.md b/docs/reference/run.md index a4889b892d..a59a305255 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -1555,7 +1555,7 @@ The example below mounts an empty tmpfs into the container with the `rw`, If neither 'rw' or 'ro' is specified then the volume is mounted in read-write mode. - The `nocopy` modes is used to disable automatic copying requested volume + The `nocopy` mode is used to disable automatically copying the requested volume path in the container to the volume storage location. For named volumes, `copy` is the default mode. Copy modes are not supported for bind-mounted volumes. From 135aa724760ace85a3d86741d1c5d6e53abf2f12 Mon Sep 17 00:00:00 2001 From: Brandon Mitchell Date: Sat, 13 Oct 2018 12:56:41 -0400 Subject: [PATCH 08/10] Updating rmi doc example to specify latest tag Signed-off-by: Brandon Mitchell (cherry picked from commit f913b73c81dfa8270a2d645f82b19764cb23017a) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/rmi.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/rmi.md index 98ca29a266..66f194aba7 100644 --- a/docs/reference/commandline/rmi.md +++ b/docs/reference/commandline/rmi.md @@ -46,11 +46,11 @@ $ docker rmi fd484f19954f Error: Conflict, cannot delete image fd484f19954f because it is tagged in multiple repositories, use -f to force 2013/12/11 05:47:16 Error: failed to remove one or more images -$ docker rmi test1 +$ docker rmi test1:latest Untagged: test1:latest -$ docker rmi test2 +$ docker rmi test2:latest Untagged: test2:latest @@ -60,7 +60,7 @@ $ docker images REPOSITORY TAG IMAGE ID CREATED SIZE test latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB) -$ docker rmi test +$ docker rmi test:latest Untagged: test:latest Deleted: fd484f19954f4920da7ff372b5067f5b7ddb2fd3830cecd17b96ea9e286ba5b8 From 72ddefbada287f2a8e730fe5254aff7cc7b6ca7a Mon Sep 17 00:00:00 2001 From: Brandon Mitchell Date: Sat, 13 Oct 2018 13:53:34 -0400 Subject: [PATCH 09/10] Documenting example default-ulimit in daemon.json Signed-off-by: Brandon Mitchell (cherry picked from commit 3f4f450941acf57b1a71e53bfcd78afcc079fce6) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/dockerd.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/reference/commandline/dockerd.md b/docs/reference/commandline/dockerd.md index 3ce72bb44b..9feb4e8afa 100644 --- a/docs/reference/commandline/dockerd.md +++ b/docs/reference/commandline/dockerd.md @@ -1327,7 +1327,13 @@ This is a full example of the allowed configuration options on Linux: "userns-remap": "", "group": "", "cgroup-parent": "", - "default-ulimits": {}, + "default-ulimits": { + "nofile": { + "Name": "nofile", + "Hard": 64000, + "Soft": 64000 + } + }, "init": false, "init-path": "/usr/libexec/docker-init", "ipv6": false, From 5e7f9d3c84967369165474efc393b4300e74592c Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Thu, 25 Oct 2018 16:02:26 +0900 Subject: [PATCH 10/10] docs, ssh: unsupport password auth explicitly The issue with password auth is tracked in #1476 and #1477 . Signed-off-by: Akihiro Suda (cherry picked from commit 16b014e062c3a95fc718140063e77af83d81af87) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/dockerd.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/reference/commandline/dockerd.md b/docs/reference/commandline/dockerd.md index 9feb4e8afa..4b50b78b19 100644 --- a/docs/reference/commandline/dockerd.md +++ b/docs/reference/commandline/dockerd.md @@ -191,7 +191,10 @@ $ docker -H ssh://example.com ps ``` To use SSH connection, you need to set up `ssh` so that it can reach the -remote host with public key authentication. +remote host with public key authentication. Password authentication is not +supported. If your key is protected with passphrase, you need to set up +`ssh-agent`. + Also, you need to have `docker` binary 18.09 or later on the daemon host. #### Bind Docker to another host/port or a Unix socket