Uh oh!
There was an error while loading. Please reload this page.
Docs: update run reference - #3837
Conversation
vvoland
commented
Oct 31, 2022
Might be good to do squash before merge though 😄 |
Signed-off-by: Djordje Lukic <djordje.lukic@docker.com> Signed-off-by: David Karlsson <david.karlsson@docker.com>
8cf1023 to
bfcadabComparecodecov-commenter
commented
Oct 31, 2022
Codecov Report
Additional details and impacted files@@ Coverage Diff @@## master #3837 +/- ##
=======================================
Coverage 59.21% 59.21% =======================================
Files 288 288 Lines 24605 24605 =======================================
Hits 14571 14571 Misses 9159 9159 Partials 875 875 |
dvdksn
commented
Oct 31, 2022
rdy for merge (I lack permissions) |
| --io-maxbandwidth string Maximum IO bandwidth limit for the system drive (Windows only) | ||
| (Windows only). The format is `<number><unit>`. | ||
| Unit is optional and can be `b` (bytes per second), | ||
| `k` (kilobytes per second), `m` (megabytes per second), | ||
| or `g` (gigabytes per second). If you omit the unit, | ||
| the system uses bytes per second. | ||
| --io-maxbandwidth and --io-maxiops are mutually exclusive options. | ||
| --io-maxiops uint Maximum IOps limit for the system drive (Windows only) |
There was a problem hiding this comment.
Looks like we lost the --io-maxbandwidth and --io-maxiops options (as they're only available on Windows)
| --network string Connect a container to a network | ||
| 'bridge': create a network stack on the default Docker bridge | ||
| 'none': no networking | ||
| 'container:<name|id>': reuse another container's network stack | ||
| 'host': use the Docker host network stack | ||
| '<network-name>|<network-id>': connect to a user-defined network |
There was a problem hiding this comment.
Looks like there were some manually written additions here (describing the different network modes) that are not printed on the CLI itself. Those were removed now (should we make the cli itself print these?)
| -q, --quiet Suppress the pull output | ||
| --read-only Mount the container's root filesystem as read only | ||
| --restart string Restart policy to apply when a container exits (default "no") | ||
| Possible values are : no, on-failure[:max-retry], always, unless-stopped |
There was a problem hiding this comment.
Same here ("Possible values are...")
| The format is `<number><unit>`. `number` must be greater than `0`. | ||
| Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), | ||
| or `g` (gigabytes). If you omit the unit, the system uses bytes. |
| 'host': Use the Docker host user namespace | ||
| '': Use the Docker daemon user namespace specified by `--userns-remap` option. |
There was a problem hiding this comment.
Here as well (wonder if we had these in the past or if they were always docs-only)
| -v, --volume value Bind mount a volume (default []). The format | ||
| is `[host-src:]container-dest[:<options>]`. | ||
| The comma-delimited `options` are [rw|ro], | ||
| [z|Z], [[r]shared|[r]slave|[r]private], | ||
| [delegated|cached|consistent], and | ||
| [nocopy]. The 'host-src' is an absolute path | ||
| or a name value. |
| useful if you need to pipe a file or something else into a container and | ||
| retrieve the container's ID once the container has finished running. | ||
| See also [the `docker cp` command](/engine/reference/commandline/cp/). |
There was a problem hiding this comment.
We may need to either use a full (docs.docker.com/....) URL for this if we want the link to work on GitHub, or a relative URL (cp.md)
- What I did
Updated the
docker runCLI reference page.- How I did it
w/ input from @rumpl
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)