Skip to content
This repository has been archived by the owner on Oct 13, 2023. It is now read-only.

Import man docs completion #23

Merged
merged 2,539 commits into from
Jun 5, 2017

Conversation

tiborvass
Copy link
Contributor

@tiborvass tiborvass commented Jun 3, 2017

This pulls docker/cli#147 to the 17.06 branch and allows us to have yaml docs and man pages generated (scripts coming in a separate PR)

This does not affect any engine or cli code.

yongtang and others added 30 commits June 2, 2017 00:10
…build` to use opts.MemBytes

This fix made several updates:
1. Update opts.MemBytes so that default value will not show up.
   The reason is that in case a default value is decided by daemon,
   instead of client, we actually want to not show default value.
2. Move `docker run/create/build` to use opts.MemBytes for `--shm-size`
   This is to bring consistency between daemon and docker run
3. docs updates.

Signed-off-by: Yong Tang <[email protected]>
Upstream-commit: d75f24fd9d0a1503625d21ad95cfd3d970146c71
Component: cli
Signed-off-by: Harald Albers <[email protected]>
Upstream-commit: a4ce26ba47fe656549efacc7f1452855706acd3f
Component: cli
Signed-off-by: Ma Shimiao <[email protected]>
Upstream-commit: e000321b1dff72e894eb87e2cf037bed4bf5da7e
Component: cli
This fix updates the markdown for man pages of `docker container ...`
so that they are consistent. The changes are based on feedback:
moby/moby#30645 (comment)
moby/moby#30645 (comment)

1. Use `H2 (##)` as needed
2. Use unrpiviledged prompt (`$`) instead of (`#`)

This PR convers files under man/src/container/*.md

Signed-off-by: Yong Tang <[email protected]>
Upstream-commit: b8b156f343060ced4cc638ab67d36a4fd071f20a
Component: cli
This fix tries to improve the display of `docker service ls`
and adds `--format` flag to `docker service ls`.

In addition to `--format` flag, several other improvement:
1. Updates `docker stacks service`.
2. Adds `servicesFormat` to config file.

Related docs has been updated.

Signed-off-by: Yong Tang <[email protected]>
Upstream-commit: 7d3b3fda0d193e4d198850944bdea873c78bf77f
Component: cli
This fix adds markdown for man page of `docker plugin ls`,
based on moby/moby#28627 (comment)

Signed-off-by: Yong Tang <[email protected]>
Upstream-commit: 6686179ff5d712a67d4a4119d33be2dc3fd4eea8
Component: cli
…ze|mode`

Signed-off-by: Harald Albers <[email protected]>
Upstream-commit: e49d13fc0260e539cb4625bbad5cb11169d5933b
Component: cli
Signed-off-by: allencloud <[email protected]>
Upstream-commit: 27260134231d8abc18fa7fcddc2b69c19b8cc736
Component: cli
Signed-off-by: John Howard <[email protected]>

Working directory processing was handled differently for Hyper-V and Windows-Server containers, as annotated in the builder documentation (updated in this PR). For Hyper-V containers, the working directory set by WORKDIR was not created. This PR makes Hyper-V containers work the same as Windows Server containers (and the same as Linux).

Example (only applies to Hyper-V containers, so not reproducible under CI environment)
Dockerfile:
FROM microsoft/nanoserver
WORKDIR c:\installer
ENV GOROOT=c:\installer
ADD go.exe .
RUN go --help
Running on Windows Server 2016, using docker master without this change, but with daemon set to --exec-opt isolation=hyperv as it would be for Client operating systems.
PS E:\go\src\github.com\docker\docker> dockerd -g c:\control --exec-opt isolation=hyperv
time="2017-02-01T15:48:09.657286100-08:00" level=info msg="Windows default isolation mode: hyperv"
time="2017-02-01T15:48:09.662720900-08:00" level=info msg="[graphdriver] using prior storage driver: windowsfilter"
time="2017-02-01T15:48:10.011588000-08:00" level=info msg="Graph migration to content-addressability took 0.00 seconds"
time="2017-02-01T15:48:10.016655800-08:00" level=info msg="Loading containers: start."
time="2017-02-01T15:48:10.460820000-08:00" level=info msg="Loading containers: done."
time="2017-02-01T15:48:10.509859600-08:00" level=info msg="Daemon has completed initialization"
time="2017-02-01T15:48:10.509859600-08:00" level=info msg="Docker daemon" commit=3c64061 graphdriver=windowsfilter version=1.14.0-dev
First with no explicit isolation:
PS E:\docker\build\unifyworkdir> docker build --no-cache .
Sending build context to Docker daemon  10.1 MB
Step 1/5 : FROM microsoft/nanoserver
 ---> 89b8556cb9ca
Step 2/5 : WORKDIR c:\installer
 ---> 7e0f41d08204
Removing intermediate container 236c7802042a
Step 3/5 : ENV GOROOT c:\installer
 ---> Running in 8ea5237183c1
 ---> 394b70435261
Removing intermediate container 8ea5237183c1
Step 4/5 : ADD go.exe .
 ---> e47401a1745c
Removing intermediate container 88dcc28e74b1
Step 5/5 : RUN go --help
 ---> Running in efe90e1b6b8b
container efe90e1b6b8b76586abc5c1dc0e2797b75adc26517c48733d90651e767c8463b encountered an error during CreateProcess: failure in a Windows system call: The directory name is invalid. (0x10b) extra info: {"ApplicationName":"","CommandLine":"cmd /S /C go --help","User":"","WorkingDirectory":"C:\\installer","Environment":{"GOROOT":"c:\\installer"},"EmulateConsole":false,"CreateStdInPipe":true,"CreateStdOutPipe":true,"CreateStdErrPipe":true,"ConsoleSize":[0,0]}
PS E:\docker\build\unifyworkdir>
Then forcing process isolation:
PS E:\docker\build\unifyworkdir> docker build --isolation=process --no-cache .
Sending build context to Docker daemon  10.1 MB
Step 1/5 : FROM microsoft/nanoserver
 ---> 89b8556cb9ca
Step 2/5 : WORKDIR c:\installer
 ---> 350c955980c8
Removing intermediate container 8339c1e9250c
Step 3/5 : ENV GOROOT c:\installer
 ---> Running in bde511c5e3e0
 ---> b8820063b5b6
Removing intermediate container bde511c5e3e0
Step 4/5 : ADD go.exe .
 ---> e4ac32f8902b
Removing intermediate container d586e8492eda
Step 5/5 : RUN go --help
 ---> Running in 9e1aa235af5f
Cannot mkdir: C:\installer is not a directory
PS E:\docker\build\unifyworkdir>
Now compare the same results after this PR. Again, first with no explicit isolation (defaulting to Hyper-V containers as that's what the daemon it set to) - note it now succeeds 😄
PS E:\docker\build\unifyworkdir> docker build --no-cache .
Sending build context to Docker daemon  10.1 MB
Step 1/5 : FROM microsoft/nanoserver
 ---> 89b8556cb9ca
Step 2/5 : WORKDIR c:\installer
 ---> 4f319f301c69
Removing intermediate container 61b9c0b1ff6f
Step 3/5 : ENV GOROOT c:\installer
 ---> Running in c464a1d612d8
 ---> 96a26ab9a7b5
Removing intermediate container c464a1d612d8
Step 4/5 : ADD go.exe .
 ---> 0290d61faf57
Removing intermediate container dc5a085fffe3
Step 5/5 : RUN go --help
 ---> Running in 60bd56042ff8
Go is a tool for managing Go source code.

Usage:

        go command [arguments]

The commands are:

        build       compile packages and dependencies
        clean       remove object files
        doc         show documentation for package or symbol
        env         print Go environment information
        fix         run go tool fix on packages
        fmt         run gofmt on package sources
        generate    generate Go files by processing source
        get         download and install packages and dependencies
        install     compile and install packages and dependencies
        list        list packages
        run         compile and run Go program
        test        test packages
        tool        run specified go tool
        version     print Go version
        vet         run go tool vet on packages

Use "go help [command]" for more information about a command.

Additional help topics:

        c           calling between Go and C
        buildmode   description of build modes
        filetype    file types
        gopath      GOPATH environment variable
        environment environment variables
        importpath  import path syntax
        packages    description of package lists
        testflag    description of testing flags
        testfunc    description of testing functions

Use "go help [topic]" for more information about that topic.

The command 'cmd /S /C go --help' returned a non-zero code: 2
And the same with forcing process isolation. Also works 😄
PS E:\docker\build\unifyworkdir> docker build --isolation=process --no-cache .
Sending build context to Docker daemon  10.1 MB
Step 1/5 : FROM microsoft/nanoserver
 ---> 89b8556cb9ca
Step 2/5 : WORKDIR c:\installer
 ---> f423b9cc3e78
Removing intermediate container 41330c88893d
Step 3/5 : ENV GOROOT c:\installer
 ---> Running in 0b99a2d7bf19
 ---> e051144bf8ec
Removing intermediate container 0b99a2d7bf19
Step 4/5 : ADD go.exe .
 ---> 7072e32b7c37
Removing intermediate container a7a97aa37fd1
Step 5/5 : RUN go --help
 ---> Running in 7097438a54e5
Go is a tool for managing Go source code.

Usage:

        go command [arguments]

The commands are:

        build       compile packages and dependencies
        clean       remove object files
        doc         show documentation for package or symbol
        env         print Go environment information
        fix         run go tool fix on packages
        fmt         run gofmt on package sources
        generate    generate Go files by processing source
        get         download and install packages and dependencies
        install     compile and install packages and dependencies
        list        list packages
        run         compile and run Go program
        test        test packages
        tool        run specified go tool
        version     print Go version
        vet         run go tool vet on packages

Use "go help [command]" for more information about a command.

Additional help topics:

        c           calling between Go and C
        buildmode   description of build modes
        filetype    file types
        gopath      GOPATH environment variable
        environment environment variables
        importpath  import path syntax
        packages    description of package lists
        testflag    description of testing flags
        testfunc    description of testing functions

Use "go help [topic]" for more information about that topic.

The command 'cmd /S /C go --help' returned a non-zero code: 2
PS E:\docker\build\unifyworkdir>
Upstream-commit: 93a4f8899162f829c1ff48b1babd9a53c3cb58a9
Component: cli
Signed-off-by: Harald Albers <[email protected]>
Upstream-commit: 5288b7e7fd9d818b1b2cd68199a190834bf014bb
Component: cli
Signed-off-by: Harald Albers <[email protected]>
Upstream-commit: 1d032d8b1e48ec6057b6503ee389c565ae72394f
Component: cli
This allows a plugin to be upgraded without requiring to
uninstall/reinstall a plugin.
Since plugin resources (e.g. volumes) are tied to a plugin ID, this is
important to ensure resources aren't lost.

The plugin must be disabled while upgrading (errors out if enabled).
This does not add any convenience flags for automatically
disabling/re-enabling the plugin during before/after upgrade.

Since an upgrade may change requested permissions, the user is required
to accept permissions just like `docker plugin install`.

Signed-off-by: Brian Goff <[email protected]>
Upstream-commit: 02677bc06e34d475fa8966f851fee291f639c96c
Component: cli
This persists the "propagated mount" for plugins outside the main
rootfs. This enables `docker plugin upgrade` to not remove potentially
important data during upgrade rather than forcing plugin authors to hard
code a host path to persist data to.

Also migrates old plugins that have a propagated mount which is in the
rootfs on daemon startup.

Signed-off-by: Brian Goff <[email protected]>
Upstream-commit: df4e570ff4af9fb69fce7512b0f0acac8bf6db70
Component: cli
Signed-off-by: Lewis Daly <[email protected]>

Updated uid/gid reference to be more canonical - and signed commit

Signed-off-by: Lewis Daly <[email protected]>

Editorial suggestion

I tried my hand at rewriting this a bit for readability. Can you please verify that the facts are correct, especially about the permission changes? You can feel free to squash my commit with yours so that it's signed. You'll need to pull the change from your fork to work on it locally.

Editorial suggestion

I tried my hand at rewriting this a bit for readability. Can you please verify that the facts are correct, especially about the permission changes? You can feel free to squash my commit with yours so that it's signed. You'll need to pull the change from your fork to work on it locally.
Upstream-commit: 50d1d4ecba154fc4866668bfd46cf11fdc35bfe8
Component: cli
Signed-off-by: Harald Albers <[email protected]>
Upstream-commit: f7e0aa39fab691ce9fda0fdd59dd44839298304b
Component: cli
Signed-off-by: Andrew Hsu <[email protected]>
Upstream-commit: 6d4b51d1a944edbb9fe3e592ecabd65d87a30362
Component: cli
Signed-off-by: Andrew Hsu <[email protected]>
Upstream-commit: a39f753e5635d6dd1ac27cb415f66cf794bc615d
Component: cli
Signed-off-by: Andrew Hsu <[email protected]>
Upstream-commit: ff9b736d5288e50c2dad5cf19ea516f28ad86a6e
Component: cli
Correct this sentence so it reads correctly. "to on a manager" should be
"on a manager".

Signed-off-by: Aaron Lehmann <[email protected]>
Upstream-commit: e6889bf41b23ebf442bf43d9317cbde69cc797e4
Component: cli
Fixes manpages for p and z by downloading a specific version
of go instead of relying on the distro version.

Signed-off-by: Christopher Jones <[email protected]>
Upstream-commit: d39215cbaa54290537d9a2bdcfa48cb479c53b30
Component: cli
Update command usage and help.

Signed-off-by: Vincent Demeester <[email protected]>
Upstream-commit: 705f7ad7d2b77b1f3051d44d38b8041cb360cbc5
Component: cli
Signed-off-by: Nathan LeClaire <[email protected]>
Upstream-commit: f571b363e6ea9cbc159514ba2314dfca8e73484b
Component: cli
Signed-off-by: Nathan LeClaire <[email protected]>
Upstream-commit: b380c2eb63ea7d5b3eebeaee13399ba5c7be3d37
Component: cli
Signed-off-by: Harald Albers <[email protected]>
Upstream-commit: f26c735282ed2adae2e1b9d440d6c06e25bd28b2
Component: cli
Signed-off-by: Harald Albers <[email protected]>
Upstream-commit: f1cef9c7ab4847bd46da6a65694537c4ff9e7000
Component: cli
This fix updates API history and man page for
`docker ps --filter expose/publish`, from the feedback:
moby/moby#27557 (comment)

Signed-off-by: Yong Tang <[email protected]>
Upstream-commit: d77db0bd9ac80a3a2e7ad4d90b6aa33fe4fc0462
Component: cli
Signed-off-by: Harald Albers <[email protected]>
Upstream-commit: 221d15877dd068360e34dc92c9609f9cd65a7943
Component: cli
Doc fix for #30761

Signed-off-by: Anusha Ragunathan <[email protected]>
Upstream-commit: c76dcd33f772866d7b4cb5bad21b3b1505cf7b03
Component: cli
Signed-off-by: allencloud <[email protected]>
Upstream-commit: d84da237bf889a8c4fdce2b7ca5f4c5351d9a221
Component: cli
Signed-off-by: Misty Stanley-Jones <[email protected]>
Upstream-commit: c2893a6e1cf27b4353166562d2fc1c1f46eae5a9
Component: cli
aaronlehmann and others added 16 commits June 2, 2017 00:11
Signed-off-by: Aaron Lehmann <[email protected]>
Upstream-commit: cf95e198c5c856673428fccad9426cfaac3b2a72
Component: cli
Signed-off-by: Harald Albers <[email protected]>
Upstream-commit: 4c0d6698d11adf28beff7bcc5fbbec123f4aa6bc
Component: cli
Allows for a plugin type that can be used to scrape metrics.
This is useful because metrics are not neccessarily at a standard
location... `--metrics-addr` must be set, and must currently be a TCP
socket.
Even if metrics are done via a unix socket, there's no guarentee where
the socket may be located on the system, making bind-mounting such a
socket into a container difficult (and racey, failure-prone on daemon
restart).

Metrics plugins side-step this issue by always listening on a unix
socket and then bind-mounting that into a known path in the plugin
container.

Note there has been similar work in the past (and ultimately punted at
the time) for consistent access to the Docker API from within a
container.

Why not add metrics to the Docker API and just provide a plugin with
access to the Docker API? Certainly this can be useful, but gives a lot
of control/access to a plugin that may only need the metrics. We can
look at supporting API plugins separately for this reason.

Signed-off-by: Brian Goff <[email protected]>
Upstream-commit: d8e04f68d3cba0a65f6b624db0dff40db9f6ca15
Component: cli
Signed-off-by: Daniel Nephin <[email protected]>
Upstream-commit: c6e78b9c5f915bc0d717cc4949e32fcfbbe85f55
Component: cli
Also changes so that shallow fetch is performed
even when a specific ref is specified.

Signed-off-by: Tonis Tiigi <[email protected]>
Upstream-commit: 48ba755c3bd7fd99d060f793d8ec7a811a0a38c5
Component: cli
Signed-off-by: Tonis Tiigi <[email protected]>
Upstream-commit: d50472f52bb5b8d3e0a63f236b6714c26e7a1edf
Component: cli
Signed-off-by: Tonis Tiigi <[email protected]>
Upstream-commit: bc5fca913b673d2caf04316806e000da9493a761
Component: cli
when viewing system info, and TLS info when displaying node info.

Signed-off-by: Ying Li <[email protected]>
Upstream-commit: 42ec86ae9b070b0dacadee63c7bbfcf8cae3eea3
Component: cli
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 <[email protected]>
Upstream-commit: 981055449460b36ba5606fd93be0e1e181b1caec
Component: cli
Signed-off-by: Ying Li <[email protected]>
Upstream-commit: e1cd83f28a3bc3080ba834553aee50d03a3bb49d
Component: cli
This patch adds the untilRemoved option to the ContainerWait API which
allows the client to wait until the container is not only exited but
also removed.

This patch also adds some more CLI integration tests for waiting for a
created container and waiting with the new --until-removed flag.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)

Handle detach sequence in CLI

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)

Update Container Wait Conditions

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)

Apply container wait changes to API 1.30

The set of changes to the containerWait API missed the cut for the
Docker 17.05 release (API version 1.29). This patch bumps the version
checks to use 1.30 instead.

This patch also makes a minor update to a testfile which was added to
the builder/dockerfile package.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)

Remove wait changes from CLI

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)

Address minor nits on wait changes

- Changed the name of the tty Proxy wrapper to `escapeProxy`
- Removed the unnecessary Error() method on container.State
- Fixes a typo in comment (repeated word)

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)

Use router.WithCancel in the containerWait handler

This handler previously added this functionality manually but now uses
the existing wrapper which does it for us.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)

Add WaitCondition constants to api/types/container

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)

Address more ContainerWait review comments

- Update ContainerWait backend interface to not return pointer values
  for container.StateStatus type.
- Updated container state's Wait() method comments to clarify that a
  context MUST be used for cancelling the request, setting timeouts,
  and to avoid goroutine leaks.
- Removed unnecessary buffering when making channels in the client's
  ContainerWait methods.
- Renamed result and error channels in client's ContainerWait methods
  to clarify that only a single result or error value would be sent
  on the channel.

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)

Move container.WaitCondition type to separate file

... to avoid conflict with swagger-generated code for API response

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)

Address more ContainerWait review comments

Docker-DCO-1.1-Signed-off-by: Josh Hawn <[email protected]> (github: jlhawn)
Upstream-commit: a49573e5fb7936975e4f4e6f074ab9495ac6dd33
Component: cli
- for service create on node-local networks

Signed-off-by: Alessandro Boch <[email protected]>
Upstream-commit: cccd6379b7f97feb09e84aa77b2c1c30d023e277
Component: cli
Upstream-commit: ca8303e325756977fc96d61910d7b979341b4a41
Component: cli
This reverts commit 3e911ff82583e49c22def56488ddcf448adb183b.
Upstream-commit: d2cb97e76d581f4a9c2fa9df9649a7d59d9474e3
Component: cli
Signed-off-by: Daniel Nephin <[email protected]>
Upstream-commit: 875daf0130e01528f5e681b5f68dcfe8bb7e2681
Component: cli
Signed-off-by: Daniel Nephin <[email protected]>
Upstream-commit: d2976d599f4c3027843e5c5f589c5334ef28df17
Component: cli
Copy link
Contributor

@mlaventure mlaventure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tiborvass
Copy link
Contributor Author

Would love to get an approval by @mstanleyjones too before merging.

@mdlinville
Copy link
Contributor

LGTM

1 similar comment
@andrewhsu
Copy link
Contributor

LGTM

@andrewhsu andrewhsu merged commit 8ce2c28 into docker-archive:17.06 Jun 5, 2017
andrewhsu added a commit that referenced this pull request Jun 24, 2017
bump Version to 17.06.0-ce-rc5
Upstream-commit: 3f1a023
Component: packaging
@andrewhsu andrewhsu modified the milestone: 17.06.0 Jul 12, 2017
silvin-lubecki pushed a commit to silvin-lubecki/docker-ce that referenced this pull request Jan 29, 2020
silvin-lubecki pushed a commit to silvin-lubecki/docker-ce that referenced this pull request Jan 30, 2020
bump Version to 17.06.0-ce-rc5
Upstream-commit: 3f1a023
Component: packaging
silvin-lubecki pushed a commit to silvin-lubecki/docker-ce that referenced this pull request Jan 30, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.