Merge pull request docker#7753 from seemethere/update_yaml

Update commandline yaml docs

Author: ahh-docker

_data/engine-cli/docker.yaml

@@ -2,6 +2,7 @@ command: docker
 cname:
 - docker attach
 - docker build
+- docker builder
 - docker checkpoint
 - docker commit
 - docker config
@@ -10,6 +11,7 @@ cname:
 - docker create
 - docker deploy
 - docker diff
+- docker engine
 - docker events
 - docker exec
 - docker export
@@ -59,6 +61,7 @@ cname:
 clink:
 - docker_attach.yaml
 - docker_build.yaml
+- docker_builder.yaml
 - docker_checkpoint.yaml
 - docker_commit.yaml
 - docker_config.yaml
@@ -67,6 +70,7 @@ clink:
 - docker_create.yaml
 - docker_deploy.yaml
 - docker_diff.yaml
+- docker_engine.yaml
 - docker_events.yaml
 - docker_exec.yaml
 - docker_export.yaml

_data/engine-cli/docker_build.yaml

@@ -293,6 +293,16 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+- option: progress
+  value_type: string
+  default_value: auto
+  description: |
+    Set type of progress output (auto, plain, tty). Use plain to show container output
+  deprecated: false
+  experimental: false
+  experimentalcli: false
+  kubernetes: false
+  swarm: false
 - option: pull
   value_type: bool
   default_value: "false"
@@ -321,6 +331,17 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+- option: secret
+  value_type: stringArray
+  default_value: '[]'
+  description: |
+    Secret file to expose to the build (only if BuildKit enabled): id=mysecret,src=/local/secret
+  deprecated: false
+  min_api_version: "1.39"
+  experimental: false
+  experimentalcli: false
+  kubernetes: false
+  swarm: false
 - option: security-opt
   value_type: stringSlice
   default_value: '[]'
@@ -349,6 +370,17 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+- option: ssh
+  value_type: stringArray
+  default_value: '[]'
+  description: |
+    SSH agent socket or keys to expose to the build (only if BuildKit enabled) (format: default|<id>[=<socket>|<key>[,<key>]])
+  deprecated: false
+  min_api_version: "1.39"
+  experimental: false
+  experimentalcli: false
+  kubernetes: false
+  swarm: false
 - option: stream
   value_type: bool
   default_value: "false"
@@ -477,21 +509,27 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
   build an image on.\n\nA good example is `http_proxy` or source versions for pulling
   intermediate\nfiles. The `ARG` instruction lets Dockerfile authors define values
   that users\ncan set at build-time using the  `--build-arg` flag:\n\n```bash\n$ docker
-  build --build-arg HTTP_PROXY=http://10.20.30.2:1234 .\n```\n\nThis flag allows you
-  to pass the build-time variables that are\naccessed like regular environment variables
-  in the `RUN` instruction of the\nDockerfile. Also, these values don't persist in
-  the intermediate or final images\nlike `ENV` values do.\n\nUsing this flag will
-  not alter the output you see when the `ARG` lines from the\nDockerfile are echoed
-  during the build process.\n\nFor detailed information on using `ARG` and `ENV` instructions,
-  see the\n[Dockerfile reference](../builder.md).\n\n### Optional security options
-  (--security-opt)\n\nThis flag is only supported on a daemon running on Windows,
-  and only supports\nthe `credentialspec` option. The `credentialspec` must be in
-  the format\n`file://spec.txt` or `registry://keyname`.\n\n### Specify isolation
-  technology for container (--isolation)\n\nThis option is useful in situations where
-  you are running Docker containers on\nWindows. The `--isolation=<value>` option
-  sets a container's isolation\ntechnology. On Linux, the only supported is the `default`
-  option which uses\nLinux namespaces. On Microsoft Windows, you can specify these
-  values:\n\n\n| Value     | Description                                                                                                                                                   |\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|
+  build --build-arg HTTP_PROXY=http://10.20.30.2:1234 --build-arg FTP_PROXY=http://40.50.60.5:4567
+  .\n```\n\nThis flag allows you to pass the build-time variables that are\naccessed
+  like regular environment variables in the `RUN` instruction of the\nDockerfile.
+  Also, these values don't persist in the intermediate or final images\nlike `ENV`
+  values do.   You must add `--build-arg` for each build argument.  \n\nUsing this
+  flag will not alter the output you see when the `ARG` lines from the\nDockerfile
+  are echoed during the build process.\n\nFor detailed information on using `ARG`
+  and `ENV` instructions, see the\n[Dockerfile reference](../builder.md).\n\nYou may
+  also use the `--build-arg` flag without a value, in which case the value\nfrom the
+  local environment will be propagated into the Docker container being\nbuilt:\n\n```bash\n$
+  export HTTP_PROXY=http://10.20.30.2:1234\n$ docker build --build-arg HTTP_PROXY
+  .\n```\n\nThis is similar to how `docker run -e` works. Refer to the [`docker run`
+  documentation](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)\nfor
+  more information.\n\n### Optional security options (--security-opt)\n\nThis flag
+  is only supported on a daemon running on Windows, and only supports\nthe `credentialspec`
+  option. The `credentialspec` must be in the format\n`file://spec.txt` or `registry://keyname`.\n\n###
+  Specify isolation technology for container (--isolation)\n\nThis option is useful
+  in situations where you are running Docker containers on\nWindows. The `--isolation=<value>`
+  option sets a container's isolation\ntechnology. On Linux, the only supported is
+  the `default` option which uses\nLinux namespaces. On Microsoft Windows, you can
+  specify these values:\n\n\n| Value     | Description                                                                                                                                                   |\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|
   `default` | Use the value specified by the Docker daemon's `--exec-opt` . If the
   `daemon` does not specify an isolation technology, Microsoft Windows uses `process`
   as its default value.  |\n| `process` | Namespace isolation only.                                                                                                                                     |\n|
@@ -519,19 +557,18 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
   sharing layers between\nimages (saving space).\n\nFor most use cases, multi-stage
   are a better alternative, as they give more\nfine-grained control over your build,
   and can take advantage of future\noptimizations in the builder. Refer to the [use
-  multi-stage builds](https://docs.docker.com/engine/userguide/eng-image/multistage-build/)\nsection
+  multi-stage builds](https://docs.docker.com/develop/develop-images/multistage-build/)\nsection
   in the userguide for more information.\n\n\n#### Known limitations\n\nThe `--squash`
   option has a number of known limitations:\n\n- When squashing layers, the resulting
-  image cannot take advantage of layer \n  sharing with other images, and may use
-  significantly more space. Sharing the\n  base image is still supported.\n- When
-  using this option you may see significantly more space used due to\n  storing two
-  copies of the image, one for the build cache with all the cache\n  layers in tact,
-  and one for the squashed version.\n- While squashing layers may produce smaller
-  images, it may have a negative\n  impact on performance, as a single layer takes
-  longer to extract, and\n  downloading a single layer cannot be parallelized.\n-
-  When attempting to squash an image that does not make changes to the\n  filesystem
-  (for example, the Dockerfile only contains `ENV` instructions),\n  the squash step
-  will fail (see [issue #33823](https://github.com/moby/moby/issues/33823)\n\n####
+  image cannot take advantage of layer\n  sharing with other images, and may use significantly
+  more space. Sharing the\n  base image is still supported.\n- When using this option
+  you may see significantly more space used due to\n  storing two copies of the image,
+  one for the build cache with all the cache\n  layers in tact, and one for the squashed
+  version.\n- While squashing layers may produce smaller images, it may have a negative\n
+  \ impact on performance, as a single layer takes longer to extract, and\n  downloading
+  a single layer cannot be parallelized.\n- When attempting to squash an image that
+  does not make changes to the\n  filesystem (for example, the Dockerfile only contains
+  `ENV` instructions),\n  the squash step will fail (see [issue #33823](https://github.com/moby/moby/issues/33823)\n\n####
   Prerequisites\n\nThe example on this page is using experimental mode in Docker 1.13.\n\nExperimental
   mode can be enabled by using the `--experimental` flag when starting the Docker
   daemon or setting `experimental: true` in the `daemon.json` configuration file.\n\nBy
@@ -551,7 +588,7 @@ examples: "### Build with PATH\n\n```bash\n$ docker build .\n\nUploading context
   >> /hello\nRUN touch remove_me /remove_me\nENV HELLO world\nRUN rm /remove_me\n```\n\nAn
   image named `test` is built with `--squash` argument.\n\n```bash\n$ docker build
   --squash -t test .\n\n[...]\n```\n\nIf everything is right, the history will look
-  like this:\n\n```bash\n$ docker history test \n\nIMAGE               CREATED             CREATED
+  like this:\n\n```bash\n$ docker history test\n\nIMAGE               CREATED             CREATED
   BY                                      SIZE                COMMENT\n4e10cb5b4cac
   \       3 seconds ago                                                       12 B
   \               merge sha256:88a7b0112a41826885df0e7072698006ee8f621c6ab99fca7fe9151d7b599702

_data/engine-cli/docker_builder.yaml

@@ -0,0 +1,16 @@
+command: docker builder
+short: Manage builds
+long: Manage builds
+usage: docker builder
+pname: docker
+plink: docker.yaml
+cname:
+- docker builder prune
+clink:
+- docker_builder_prune.yaml
+deprecated: false
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+

_data/engine-cli/docker_builder_prune.yaml

@@ -0,0 +1,51 @@
+command: docker builder prune
+short: Remove build cache
+long: Remove build cache
+usage: docker builder prune
+pname: docker builder
+plink: docker_builder.yaml
+options:
+- option: all
+  shorthand: a
+  value_type: bool
+  default_value: "false"
+  description: Remove all unused images, not just dangling ones
+  deprecated: false
+  experimental: false
+  experimentalcli: false
+  kubernetes: false
+  swarm: false
+- option: filter
+  value_type: filter
+  description: Provide filter values (e.g. 'unused-for=24h')
+  deprecated: false
+  experimental: false
+  experimentalcli: false
+  kubernetes: false
+  swarm: false
+- option: force
+  shorthand: f
+  value_type: bool
+  default_value: "false"
+  description: Do not prompt for confirmation
+  deprecated: false
+  experimental: false
+  experimentalcli: false
+  kubernetes: false
+  swarm: false
+- option: keep-storage
+  value_type: bytes
+  default_value: "0"
+  description: Amount of disk space to keep for cache
+  deprecated: false
+  experimental: false
+  experimentalcli: false
+  kubernetes: false
+  swarm: false
+deprecated: false
+min_api_version: "1.39"
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+

_data/engine-cli/docker_checkpoint.yaml

@@ -18,4 +18,5 @@ experimental: true
 experimentalcli: false
 kubernetes: false
 swarm: false
+os_type: linux
 

_data/engine-cli/docker_checkpoint_create.yaml

@@ -28,4 +28,5 @@ experimental: true
 experimentalcli: false
 kubernetes: false
 swarm: false
+os_type: linux
 

_data/engine-cli/docker_checkpoint_ls.yaml

@@ -20,4 +20,5 @@ experimental: true
 experimentalcli: false
 kubernetes: false
 swarm: false
+os_type: linux
 

_data/engine-cli/docker_checkpoint_rm.yaml

@@ -20,4 +20,5 @@ experimental: true
 experimentalcli: false
 kubernetes: false
 swarm: false
+os_type: linux
 

_data/engine-cli/docker_container_create.yaml

@@ -82,6 +82,7 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+  os_type: windows
 - option: cpu-percent
   value_type: int64
   default_value: "0"
@@ -91,6 +92,7 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+  os_type: windows
 - option: cpu-period
   value_type: int64
   default_value: "0"
@@ -394,6 +396,7 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+  os_type: windows
 - option: io-maxiops
   value_type: uint64
   default_value: "0"
@@ -403,6 +406,7 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+  os_type: windows
 - option: ip
   value_type: string
   description: IPv4 address (e.g., 172.30.100.104)

_data/engine-cli/docker_container_run.yaml

@@ -82,6 +82,7 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+  os_type: windows
 - option: cpu-percent
   value_type: int64
   default_value: "0"
@@ -91,6 +92,7 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+  os_type: windows
 - option: cpu-period
   value_type: int64
   default_value: "0"
@@ -412,6 +414,7 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+  os_type: windows
 - option: io-maxiops
   value_type: uint64
   default_value: "0"
@@ -421,6 +424,7 @@ options:
   experimentalcli: false
   kubernetes: false
   swarm: false
+  os_type: windows
 - option: ip
   value_type: string
   description: IPv4 address (e.g., 172.30.100.104)