From c485685d74113b64b741fafdee1f69c93e79ae79 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Tue, 29 Sep 2020 22:44:44 +0200 Subject: [PATCH] reference: update buildx reference docs for v0.4.2 Signed-off-by: Sebastiaan van Stijn --- _data/buildx/docker_buildx.yaml | 13 ++++ _data/buildx/docker_buildx_bake.yaml | 29 +++++++- _data/buildx/docker_buildx_build.yaml | 19 ++++++ _data/buildx/docker_buildx_create.yaml | 34 ++++++++++ _data/buildx/docker_buildx_du.yaml | 39 +++++++++++ _data/buildx/docker_buildx_imagetools.yaml | 9 +++ .../docker_buildx_imagetools_create.yaml | 9 +++ .../docker_buildx_imagetools_inspect.yaml | 9 +++ _data/buildx/docker_buildx_inspect.yaml | 9 +++ _data/buildx/docker_buildx_ls.yaml | 9 +++ _data/buildx/docker_buildx_prune.yaml | 68 +++++++++++++++++++ _data/buildx/docker_buildx_rm.yaml | 9 +++ _data/buildx/docker_buildx_stop.yaml | 9 +++ _data/buildx/docker_buildx_use.yaml | 9 +++ _data/buildx/docker_buildx_version.yaml | 9 +++ _data/toc.yaml | 4 ++ engine/reference/commandline/buildx_du.md | 14 ++++ engine/reference/commandline/buildx_prune.md | 14 ++++ 18 files changed, 314 insertions(+), 1 deletion(-) create mode 100644 _data/buildx/docker_buildx_du.yaml create mode 100644 _data/buildx/docker_buildx_prune.yaml create mode 100644 engine/reference/commandline/buildx_du.md create mode 100644 engine/reference/commandline/buildx_prune.md diff --git a/_data/buildx/docker_buildx.yaml b/_data/buildx/docker_buildx.yaml index 18ad394a59..0232829f11 100644 --- a/_data/buildx/docker_buildx.yaml +++ b/_data/buildx/docker_buildx.yaml @@ -7,9 +7,11 @@ cname: - docker buildx bake - docker buildx build - docker buildx create +- docker buildx du - docker buildx imagetools - docker buildx inspect - docker buildx ls +- docker buildx prune - docker buildx rm - docker buildx stop - docker buildx use @@ -18,13 +20,24 @@ clink: - docker_buildx_bake.yaml - docker_buildx_build.yaml - docker_buildx_create.yaml +- docker_buildx_du.yaml - docker_buildx_imagetools.yaml - docker_buildx_inspect.yaml - docker_buildx_ls.yaml +- docker_buildx_prune.yaml - docker_buildx_rm.yaml - docker_buildx_stop.yaml - docker_buildx_use.yaml - docker_buildx_version.yaml +options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_bake.yaml b/_data/buildx/docker_buildx_bake.yaml index 294239d148..46ed303089 100644 --- a/_data/buildx/docker_buildx_bake.yaml +++ b/_data/buildx/docker_buildx_bake.yaml @@ -16,6 +16,15 @@ options: experimentalcli: false kubernetes: false swarm: false +- option: load + value_type: bool + default_value: "false" + description: Shorthand for --set=*.output=type=docker + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: no-cache value_type: bool default_value: "false" @@ -53,10 +62,28 @@ options: experimentalcli: false kubernetes: false swarm: false +- option: push + value_type: bool + default_value: "false" + description: Shorthand for --set=*.output=type=registry + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: set value_type: stringArray default_value: '[]' - description: 'Override target value (eg: target.key=value)' + description: 'Override target value (eg: targetpattern.key=value)' + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance deprecated: false experimental: false experimentalcli: false diff --git a/_data/buildx/docker_buildx_build.yaml b/_data/buildx/docker_buildx_build.yaml index 94c98f9a69..da47926eba 100644 --- a/_data/buildx/docker_buildx_build.yaml +++ b/_data/buildx/docker_buildx_build.yaml @@ -15,6 +15,16 @@ options: experimentalcli: false kubernetes: false swarm: false +- option: allow + value_type: stringSlice + default_value: '[]' + description: | + Allow extra privileged entitlement, e.g. network.host, security.insecure + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: build-arg value_type: stringArray default_value: '[]' @@ -332,6 +342,15 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_create.yaml b/_data/buildx/docker_buildx_create.yaml index 832195e92b..80e1342063 100644 --- a/_data/buildx/docker_buildx_create.yaml +++ b/_data/buildx/docker_buildx_create.yaml @@ -14,6 +14,22 @@ options: experimentalcli: false kubernetes: false swarm: false +- option: buildkitd-flags + value_type: string + description: Flags for buildkitd daemon + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: config + value_type: string + description: BuildKit config file + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: driver value_type: string description: 'Driver to use (available: [])' @@ -22,6 +38,15 @@ options: experimentalcli: false kubernetes: false swarm: false +- option: driver-opt + value_type: stringArray + default_value: '[]' + description: Options for the driver + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false - option: leave value_type: bool default_value: "false" @@ -65,6 +90,15 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_du.yaml b/_data/buildx/docker_buildx_du.yaml new file mode 100644 index 0000000000..630f2dd7c0 --- /dev/null +++ b/_data/buildx/docker_buildx_du.yaml @@ -0,0 +1,39 @@ +command: docker buildx du +short: Disk usage +long: Disk usage +usage: docker buildx du +pname: docker buildx +plink: docker_buildx.yaml +options: +- option: filter + value_type: filter + description: Provide filter values + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: verbose + value_type: bool + default_value: "false" + description: Provide a more verbose output + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: true +kubernetes: false +swarm: false + diff --git a/_data/buildx/docker_buildx_imagetools.yaml b/_data/buildx/docker_buildx_imagetools.yaml index 9804b8bf77..cbfeb81e60 100644 --- a/_data/buildx/docker_buildx_imagetools.yaml +++ b/_data/buildx/docker_buildx_imagetools.yaml @@ -9,6 +9,15 @@ cname: clink: - docker_buildx_imagetools_create.yaml - docker_buildx_imagetools_inspect.yaml +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_imagetools_create.yaml b/_data/buildx/docker_buildx_imagetools_create.yaml index ca17e43a81..41332a64f5 100644 --- a/_data/buildx/docker_buildx_imagetools_create.yaml +++ b/_data/buildx/docker_buildx_imagetools_create.yaml @@ -43,6 +43,15 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_imagetools_inspect.yaml b/_data/buildx/docker_buildx_imagetools_inspect.yaml index 189d028937..2c0ab8bbc3 100644 --- a/_data/buildx/docker_buildx_imagetools_inspect.yaml +++ b/_data/buildx/docker_buildx_imagetools_inspect.yaml @@ -14,6 +14,15 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_inspect.yaml b/_data/buildx/docker_buildx_inspect.yaml index bc93fc8242..b9fa151fe0 100644 --- a/_data/buildx/docker_buildx_inspect.yaml +++ b/_data/buildx/docker_buildx_inspect.yaml @@ -14,6 +14,15 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_ls.yaml b/_data/buildx/docker_buildx_ls.yaml index 3c4af2cafe..ae79deb459 100644 --- a/_data/buildx/docker_buildx_ls.yaml +++ b/_data/buildx/docker_buildx_ls.yaml @@ -4,6 +4,15 @@ long: List builder instances usage: docker buildx ls pname: docker buildx plink: docker_buildx.yaml +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_prune.yaml b/_data/buildx/docker_buildx_prune.yaml new file mode 100644 index 0000000000..19aa5f268f --- /dev/null +++ b/_data/buildx/docker_buildx_prune.yaml @@ -0,0 +1,68 @@ +command: docker buildx prune +short: 'Remove build cache ' +long: 'Remove build cache ' +usage: docker buildx prune +pname: docker buildx +plink: docker_buildx.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. 'until=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 +- option: verbose + value_type: bool + default_value: "false" + description: Provide a more verbose output + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: true +kubernetes: false +swarm: false + diff --git a/_data/buildx/docker_buildx_rm.yaml b/_data/buildx/docker_buildx_rm.yaml index a55a7f8d41..e3fd65f1c6 100644 --- a/_data/buildx/docker_buildx_rm.yaml +++ b/_data/buildx/docker_buildx_rm.yaml @@ -4,6 +4,15 @@ long: Remove a builder instance usage: docker buildx rm [NAME] pname: docker buildx plink: docker_buildx.yaml +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_stop.yaml b/_data/buildx/docker_buildx_stop.yaml index 95e15d0b3a..6a495d52f6 100644 --- a/_data/buildx/docker_buildx_stop.yaml +++ b/_data/buildx/docker_buildx_stop.yaml @@ -4,6 +4,15 @@ long: Stop builder instance usage: docker buildx stop [NAME] pname: docker buildx plink: docker_buildx.yaml +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_use.yaml b/_data/buildx/docker_buildx_use.yaml index c3fb0cde1f..cf93219d0a 100644 --- a/_data/buildx/docker_buildx_use.yaml +++ b/_data/buildx/docker_buildx_use.yaml @@ -23,6 +23,15 @@ options: experimentalcli: false kubernetes: false swarm: false +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/buildx/docker_buildx_version.yaml b/_data/buildx/docker_buildx_version.yaml index d9d07797a6..e0a05506e5 100644 --- a/_data/buildx/docker_buildx_version.yaml +++ b/_data/buildx/docker_buildx_version.yaml @@ -4,6 +4,15 @@ long: 'Show buildx version information ' usage: docker buildx version pname: docker buildx plink: docker_buildx.yaml +inherited_options: +- option: builder + value_type: string + description: Override the configured builder instance + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false deprecated: false experimental: false experimentalcli: true diff --git a/_data/toc.yaml b/_data/toc.yaml index 02cf7d6a23..04f4f7727f 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -392,6 +392,8 @@ reference: title: docker buildx build - path: /engine/reference/commandline/buildx_create/ title: docker buildx create + - path: /engine/reference/commandline/buildx_du/ + title: docker buildx du - path: /engine/reference/commandline/buildx_imagetools/ title: docker buildx imagetools - path: /engine/reference/commandline/buildx_imagetools_create/ @@ -402,6 +404,8 @@ reference: title: docker buildx inspect - path: /engine/reference/commandline/buildx_ls/ title: docker buildx ls + - path: /engine/reference/commandline/buildx_prune/ + title: docker buildx prune - path: /engine/reference/commandline/buildx_rm/ title: docker buildx rm - path: /engine/reference/commandline/buildx_stop/ diff --git a/engine/reference/commandline/buildx_du.md b/engine/reference/commandline/buildx_du.md new file mode 100644 index 0000000000..ef285f0f35 --- /dev/null +++ b/engine/reference/commandline/buildx_du.md @@ -0,0 +1,14 @@ +--- +datafolder: buildx +datafile: docker_buildx_du +title: docker buildx du +skip_read_time: true +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/buildx_prune.md b/engine/reference/commandline/buildx_prune.md new file mode 100644 index 0000000000..a09d7330bc --- /dev/null +++ b/engine/reference/commandline/buildx_prune.md @@ -0,0 +1,14 @@ +--- +datafolder: buildx +datafile: docker_buildx_prune +title: docker buildx prune +skip_read_time: true +--- + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %}