Skip to content

Commit 1dcccf6

Browse files
dvdksndvdksn
committed
buildx: generate v0.31.0-rc1 cli reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
1 parent b6f6660 commit 1dcccf6

9 files changed

Lines changed: 181 additions & 5 deletions

File tree

‎content/reference/cli/docker/buildx/policy/_index.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
datafolder: buildx
3+
datafile: docker_buildx_policy
4+
title: docker buildx policy
5+
layout: cli
6+
---
7+
8+
<!--
9+
This page is automatically generated from Docker's source code. If you want to
10+
suggest a change to the text that appears here, open a ticket or pull request
11+
in the source repository on GitHub:
12+
13+
https://github.com/docker/buildx
14+
-->

‎content/reference/cli/docker/buildx/policy/eval.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
datafolder: buildx
3+
datafile: docker_buildx_policy_eval
4+
title: docker buildx policy eval
5+
layout: cli
6+
---
7+
8+
<!--
9+
This page is automatically generated from Docker's source code. If you want to
10+
suggest a change to the text that appears here, open a ticket or pull request
11+
in the source repository on GitHub:
12+
13+
https://github.com/docker/buildx
14+
-->

‎data/buildx/docker_buildx.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ cname:
1616
- docker buildx imagetools
1717
- docker buildx inspect
1818
- docker buildx ls
19+
- docker buildx policy
1920
- docker buildx prune
2021
- docker buildx rm
2122
- docker buildx stop
@@ -33,6 +34,7 @@ clink:
3334
- docker_buildx_imagetools.yaml
3435
- docker_buildx_inspect.yaml
3536
- docker_buildx_ls.yaml
37+
- docker_buildx_policy.yaml
3638
- docker_buildx_prune.yaml
3739
- docker_buildx_rm.yaml
3840
- docker_buildx_stop.yaml

‎data/buildx/docker_buildx_bake.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -578,6 +578,7 @@ examples: |-
578578
$ docker buildx bake --set *.platform=linux/arm64 # overrides platform for all targets
579579
$ docker buildx bake --set foo*.no-cache # bypass caching only for targets starting with 'foo'
580580
$ docker buildx bake --set target.platform+=linux/arm64 # appends 'linux/arm64' to the platform list
581+
$ docker buildx bake --set target.contexts.bar=../bar # overrides 'bar' named context
581582
```
582583
583584
> [!NOTE]
@@ -596,6 +597,7 @@ examples: |-
596597
* `cache-to`
597598
* `call`
598599
* `context`
600+
* `contexts`
599601
* `dockerfile`
600602
* `entitlements`
601603
* `extra-hosts`

‎data/buildx/docker_buildx_build.yaml‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,17 @@ options:
332332
experimentalcli: false
333333
kubernetes: false
334334
swarm: false
335+
- option: policy
336+
value_type: stringArray
337+
default_value: '[]'
338+
description: |
339+
Policy configuration (format: `filename=path[,filename=path][,reset=true|false][,disabled=true|false][,strict=true|false][,log-level=level]`)
340+
deprecated: false
341+
hidden: false
342+
experimental: false
343+
experimentalcli: false
344+
kubernetes: false
345+
swarm: false
335346
- option: print
336347
value_type: string
337348
description: Print result of information request (e.g., outline, targets)
@@ -376,7 +387,7 @@ options:
376387
- option: push
377388
value_type: bool
378389
default_value: "false"
379-
description: Shorthand for `--output=type=registry`
390+
description: Shorthand for `--output=type=registry,unpack=false`
380391
details_url: '#push'
381392
deprecated: false
382393
hidden: false
@@ -704,8 +715,13 @@ examples: |-
704715
--build-context=name=VALUE
705716
```
706717
707-
Define additional build context with specified contents. In Dockerfile the context can be accessed when `FROM name` or `--from=name` is used.
708-
When Dockerfile defines a stage with the same name it is overwritten.
718+
Define additional build context with specified contents.
719+
720+
In a Dockerfile:
721+
722+
- the context can be accessed when `FROM name` or `--from=name` is used
723+
- the context overrides a stage called `name` when used as `FROM ... AS name`
724+
- the context overrides a `#syntax` directive when used as `#syntax=name`
709725
710726
The value can be a:
711727

‎data/buildx/docker_buildx_dap_build.yaml‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,17 @@ options:
321321
experimentalcli: false
322322
kubernetes: false
323323
swarm: false
324+
- option: policy
325+
value_type: stringArray
326+
default_value: '[]'
327+
description: |
328+
Policy configuration (format: `filename=path[,filename=path][,reset=true|false][,disabled=true|false][,strict=true|false][,log-level=level]`)
329+
deprecated: false
330+
hidden: false
331+
experimental: false
332+
experimentalcli: false
333+
kubernetes: false
334+
swarm: false
324335
- option: print
325336
value_type: string
326337
description: Print result of information request (e.g., outline, targets)
@@ -363,7 +374,7 @@ options:
363374
- option: push
364375
value_type: bool
365376
default_value: "false"
366-
description: Shorthand for `--output=type=registry`
377+
description: Shorthand for `--output=type=registry,unpack=false`
367378
deprecated: false
368379
hidden: false
369380
experimental: false

‎data/buildx/docker_buildx_debug_build.yaml‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,17 @@ options:
314314
experimentalcli: false
315315
kubernetes: false
316316
swarm: false
317+
- option: policy
318+
value_type: stringArray
319+
default_value: '[]'
320+
description: |
321+
Policy configuration (format: `filename=path[,filename=path][,reset=true|false][,disabled=true|false][,strict=true|false][,log-level=level]`)
322+
deprecated: false
323+
hidden: false
324+
experimental: false
325+
experimentalcli: false
326+
kubernetes: false
327+
swarm: false
317328
- option: print
318329
value_type: string
319330
description: Print result of information request (e.g., outline, targets)
@@ -356,7 +367,7 @@ options:
356367
- option: push
357368
value_type: bool
358369
default_value: "false"
359-
description: Shorthand for `--output=type=registry`
370+
description: Shorthand for `--output=type=registry,unpack=false`
360371
deprecated: false
361372
hidden: false
362373
experimental: false

‎data/buildx/docker_buildx_policy.yaml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
command: docker buildx policy
2+
short: Commands for working with build policies
3+
long: Commands for working with build policies
4+
pname: docker buildx
5+
plink: docker_buildx.yaml
6+
cname:
7+
- docker buildx policy eval
8+
- docker buildx policy json-schema
9+
- docker buildx policy test
10+
clink:
11+
- docker_buildx_policy_eval.yaml
12+
- docker_buildx_policy_json-schema.yaml
13+
- docker_buildx_policy_test.yaml
14+
inherited_options:
15+
- option: builder
16+
value_type: string
17+
description: Override the configured builder instance
18+
deprecated: false
19+
hidden: false
20+
experimental: false
21+
experimentalcli: false
22+
kubernetes: false
23+
swarm: false
24+
- option: debug
25+
shorthand: D
26+
value_type: bool
27+
default_value: "false"
28+
description: Enable debug logging
29+
deprecated: false
30+
hidden: false
31+
experimental: false
32+
experimentalcli: false
33+
kubernetes: false
34+
swarm: false
35+
deprecated: false
36+
hidden: false
37+
experimental: false
38+
experimentalcli: false
39+
kubernetes: false
40+
swarm: false
41+

‎data/buildx/docker_buildx_policy_eval.yaml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
command: docker buildx policy eval
2+
short: Evaluate policy for a source
3+
long: Evaluate policy for a source
4+
usage: docker buildx policy eval [OPTIONS] source
5+
pname: docker buildx policy
6+
plink: docker_buildx_policy.yaml
7+
options:
8+
- option: fields
9+
value_type: stringSlice
10+
default_value: '[]'
11+
description: Fields to evaluate
12+
deprecated: false
13+
hidden: false
14+
experimental: false
15+
experimentalcli: false
16+
kubernetes: false
17+
swarm: false
18+
- option: filename
19+
value_type: string
20+
default_value: Dockerfile
21+
description: Policy filename to evaluate
22+
deprecated: false
23+
hidden: false
24+
experimental: false
25+
experimentalcli: false
26+
kubernetes: false
27+
swarm: false
28+
- option: print
29+
value_type: bool
30+
default_value: "false"
31+
description: Print policy output
32+
deprecated: false
33+
hidden: false
34+
experimental: false
35+
experimentalcli: false
36+
kubernetes: false
37+
swarm: false
38+
inherited_options:
39+
- option: builder
40+
value_type: string
41+
description: Override the configured builder instance
42+
deprecated: false
43+
hidden: false
44+
experimental: false
45+
experimentalcli: false
46+
kubernetes: false
47+
swarm: false
48+
- option: debug
49+
shorthand: D
50+
value_type: bool
51+
default_value: "false"
52+
description: Enable debug logging
53+
deprecated: false
54+
hidden: false
55+
experimental: false
56+
experimentalcli: false
57+
kubernetes: false
58+
swarm: false
59+
deprecated: false
60+
hidden: false
61+
experimental: false
62+
experimentalcli: false
63+
kubernetes: false
64+
swarm: false
65+

0 commit comments

Comments
 (0)