pulumi-docker-build 0.1.0a1744404167__py3-none-any.whl → 0.1.0a1745259997__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of pulumi-docker-build might be problematic. Click here for more details.
- pulumi_docker_build/__init__.py +1 -0
- pulumi_docker_build/_enums.py +6 -4
- pulumi_docker_build/_inputs.py +527 -526
- pulumi_docker_build/config/__init__.py +1 -0
- pulumi_docker_build/config/__init__.pyi +1 -0
- pulumi_docker_build/config/vars.py +1 -0
- pulumi_docker_build/image.py +103 -99
- pulumi_docker_build/index.py +29 -25
- pulumi_docker_build/outputs.py +319 -318
- pulumi_docker_build/provider.py +12 -8
- pulumi_docker_build/pulumi-plugin.json +1 -1
- {pulumi_docker_build-0.1.0a1744404167.dist-info → pulumi_docker_build-0.1.0a1745259997.dist-info}/METADATA +1 -1
- pulumi_docker_build-0.1.0a1745259997.dist-info/RECORD +17 -0
- {pulumi_docker_build-0.1.0a1744404167.dist-info → pulumi_docker_build-0.1.0a1745259997.dist-info}/WHEEL +1 -1
- pulumi_docker_build-0.1.0a1744404167.dist-info/RECORD +0 -17
- {pulumi_docker_build-0.1.0a1744404167.dist-info → pulumi_docker_build-0.1.0a1745259997.dist-info}/top_level.txt +0 -0
pulumi_docker_build/image.py
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
+
import builtins
|
|
5
6
|
import copy
|
|
6
7
|
import warnings
|
|
7
8
|
import sys
|
|
@@ -22,39 +23,39 @@ __all__ = ['ImageArgs', 'Image']
|
|
|
22
23
|
@pulumi.input_type
|
|
23
24
|
class ImageArgs:
|
|
24
25
|
def __init__(__self__, *,
|
|
25
|
-
push: pulumi.Input[bool],
|
|
26
|
-
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
27
|
-
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
28
|
-
build_on_preview: Optional[pulumi.Input[bool]] = None,
|
|
26
|
+
push: pulumi.Input[builtins.bool],
|
|
27
|
+
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
|
|
28
|
+
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
|
|
29
|
+
build_on_preview: Optional[pulumi.Input[builtins.bool]] = None,
|
|
29
30
|
builder: Optional[pulumi.Input['BuilderConfigArgs']] = None,
|
|
30
31
|
cache_from: Optional[pulumi.Input[Sequence[pulumi.Input['CacheFromArgs']]]] = None,
|
|
31
32
|
cache_to: Optional[pulumi.Input[Sequence[pulumi.Input['CacheToArgs']]]] = None,
|
|
32
33
|
context: Optional[pulumi.Input['BuildContextArgs']] = None,
|
|
33
34
|
dockerfile: Optional[pulumi.Input['DockerfileArgs']] = None,
|
|
34
|
-
exec_: Optional[pulumi.Input[bool]] = None,
|
|
35
|
+
exec_: Optional[pulumi.Input[builtins.bool]] = None,
|
|
35
36
|
exports: Optional[pulumi.Input[Sequence[pulumi.Input['ExportArgs']]]] = None,
|
|
36
|
-
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
37
|
-
load: Optional[pulumi.Input[bool]] = None,
|
|
37
|
+
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
|
|
38
|
+
load: Optional[pulumi.Input[builtins.bool]] = None,
|
|
38
39
|
network: Optional[pulumi.Input['NetworkMode']] = None,
|
|
39
|
-
no_cache: Optional[pulumi.Input[bool]] = None,
|
|
40
|
+
no_cache: Optional[pulumi.Input[builtins.bool]] = None,
|
|
40
41
|
platforms: Optional[pulumi.Input[Sequence[pulumi.Input['Platform']]]] = None,
|
|
41
|
-
pull: Optional[pulumi.Input[bool]] = None,
|
|
42
|
+
pull: Optional[pulumi.Input[builtins.bool]] = None,
|
|
42
43
|
registries: Optional[pulumi.Input[Sequence[pulumi.Input['RegistryArgs']]]] = None,
|
|
43
|
-
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
44
|
+
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
|
|
44
45
|
ssh: Optional[pulumi.Input[Sequence[pulumi.Input['SSHArgs']]]] = None,
|
|
45
|
-
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
46
|
-
target: Optional[pulumi.Input[str]] = None):
|
|
46
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
|
|
47
|
+
target: Optional[pulumi.Input[builtins.str]] = None):
|
|
47
48
|
"""
|
|
48
49
|
The set of arguments for constructing a Image resource.
|
|
49
|
-
:param pulumi.Input[bool] push: When `true` the build will automatically include a `registry` export.
|
|
50
|
+
:param pulumi.Input[builtins.bool] push: When `true` the build will automatically include a `registry` export.
|
|
50
51
|
|
|
51
52
|
Defaults to `false`.
|
|
52
53
|
|
|
53
54
|
Equivalent to Docker's `--push` flag.
|
|
54
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] add_hosts: Custom `host:ip` mappings to use during the build.
|
|
55
|
+
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] add_hosts: Custom `host:ip` mappings to use during the build.
|
|
55
56
|
|
|
56
57
|
Equivalent to Docker's `--add-host` flag.
|
|
57
|
-
:param pulumi.Input[Mapping[str, pulumi.Input[str]]] build_args: `ARG` names and values to set during the build.
|
|
58
|
+
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] build_args: `ARG` names and values to set during the build.
|
|
58
59
|
|
|
59
60
|
These variables are accessed like environment variables inside `RUN`
|
|
60
61
|
instructions.
|
|
@@ -63,7 +64,7 @@ class ImageArgs:
|
|
|
63
64
|
if these arguments are sensitive.
|
|
64
65
|
|
|
65
66
|
Equivalent to Docker's `--build-arg` flag.
|
|
66
|
-
:param pulumi.Input[bool] build_on_preview: Setting this to `false` will always skip image builds during previews,
|
|
67
|
+
:param pulumi.Input[builtins.bool] build_on_preview: Setting this to `false` will always skip image builds during previews,
|
|
67
68
|
and setting it to `true` will always build images during previews.
|
|
68
69
|
|
|
69
70
|
Images built during previews are never exported to registries, however
|
|
@@ -87,7 +88,7 @@ class ImageArgs:
|
|
|
87
88
|
:param pulumi.Input['DockerfileArgs'] dockerfile: Dockerfile settings.
|
|
88
89
|
|
|
89
90
|
Equivalent to Docker's `--file` flag.
|
|
90
|
-
:param pulumi.Input[bool] exec_: Use `exec` mode to build this image.
|
|
91
|
+
:param pulumi.Input[builtins.bool] exec_: Use `exec` mode to build this image.
|
|
91
92
|
|
|
92
93
|
By default the provider embeds a v25 Docker client with v0.12 buildx
|
|
93
94
|
support. This helps ensure consistent behavior across environments and
|
|
@@ -116,10 +117,10 @@ class ImageArgs:
|
|
|
116
117
|
0.13 or later.
|
|
117
118
|
|
|
118
119
|
Equivalent to Docker's `--output` flag.
|
|
119
|
-
:param pulumi.Input[Mapping[str, pulumi.Input[str]]] labels: Attach arbitrary key/value metadata to the image.
|
|
120
|
+
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] labels: Attach arbitrary key/value metadata to the image.
|
|
120
121
|
|
|
121
122
|
Equivalent to Docker's `--label` flag.
|
|
122
|
-
:param pulumi.Input[bool] load: When `true` the build will automatically include a `docker` export.
|
|
123
|
+
:param pulumi.Input[builtins.bool] load: When `true` the build will automatically include a `docker` export.
|
|
123
124
|
|
|
124
125
|
Defaults to `false`.
|
|
125
126
|
|
|
@@ -129,13 +130,13 @@ class ImageArgs:
|
|
|
129
130
|
For custom networks, configure your builder with `--driver-opt network=...`.
|
|
130
131
|
|
|
131
132
|
Equivalent to Docker's `--network` flag.
|
|
132
|
-
:param pulumi.Input[bool] no_cache: Do not import cache manifests when building the image.
|
|
133
|
+
:param pulumi.Input[builtins.bool] no_cache: Do not import cache manifests when building the image.
|
|
133
134
|
|
|
134
135
|
Equivalent to Docker's `--no-cache` flag.
|
|
135
136
|
:param pulumi.Input[Sequence[pulumi.Input['Platform']]] platforms: Set target platform(s) for the build. Defaults to the host's platform.
|
|
136
137
|
|
|
137
138
|
Equivalent to Docker's `--platform` flag.
|
|
138
|
-
:param pulumi.Input[bool] pull: Always pull referenced images.
|
|
139
|
+
:param pulumi.Input[builtins.bool] pull: Always pull referenced images.
|
|
139
140
|
|
|
140
141
|
Equivalent to Docker's `--pull` flag.
|
|
141
142
|
:param pulumi.Input[Sequence[pulumi.Input['RegistryArgs']]] registries: Registry credentials. Required if reading or exporting to private
|
|
@@ -145,7 +146,7 @@ class ImageArgs:
|
|
|
145
146
|
credentials on the host.
|
|
146
147
|
|
|
147
148
|
Similar to `docker login`.
|
|
148
|
-
:param pulumi.Input[Mapping[str, pulumi.Input[str]]] secrets: A mapping of secret names to their corresponding values.
|
|
149
|
+
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] secrets: A mapping of secret names to their corresponding values.
|
|
149
150
|
|
|
150
151
|
Unlike the Docker CLI, these can be passed by value and do not need to
|
|
151
152
|
exist on-disk or in environment variables.
|
|
@@ -157,13 +158,13 @@ class ImageArgs:
|
|
|
157
158
|
:param pulumi.Input[Sequence[pulumi.Input['SSHArgs']]] ssh: SSH agent socket or keys to expose to the build.
|
|
158
159
|
|
|
159
160
|
Equivalent to Docker's `--ssh` flag.
|
|
160
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: Name and optionally a tag (format: `name:tag`).
|
|
161
|
+
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] tags: Name and optionally a tag (format: `name:tag`).
|
|
161
162
|
|
|
162
163
|
If exporting to a registry, the name should include the fully qualified
|
|
163
164
|
registry address (e.g. `docker.io/pulumi/pulumi:latest`).
|
|
164
165
|
|
|
165
166
|
Equivalent to Docker's `--tag` flag.
|
|
166
|
-
:param pulumi.Input[str] target: Set the target build stage(s) to build.
|
|
167
|
+
:param pulumi.Input[builtins.str] target: Set the target build stage(s) to build.
|
|
167
168
|
|
|
168
169
|
If not specified all targets will be built by default.
|
|
169
170
|
|
|
@@ -219,7 +220,7 @@ class ImageArgs:
|
|
|
219
220
|
|
|
220
221
|
@property
|
|
221
222
|
@pulumi.getter
|
|
222
|
-
def push(self) -> pulumi.Input[bool]:
|
|
223
|
+
def push(self) -> pulumi.Input[builtins.bool]:
|
|
223
224
|
"""
|
|
224
225
|
When `true` the build will automatically include a `registry` export.
|
|
225
226
|
|
|
@@ -230,12 +231,12 @@ class ImageArgs:
|
|
|
230
231
|
return pulumi.get(self, "push")
|
|
231
232
|
|
|
232
233
|
@push.setter
|
|
233
|
-
def push(self, value: pulumi.Input[bool]):
|
|
234
|
+
def push(self, value: pulumi.Input[builtins.bool]):
|
|
234
235
|
pulumi.set(self, "push", value)
|
|
235
236
|
|
|
236
237
|
@property
|
|
237
238
|
@pulumi.getter(name="addHosts")
|
|
238
|
-
def add_hosts(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
239
|
+
def add_hosts(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]]:
|
|
239
240
|
"""
|
|
240
241
|
Custom `host:ip` mappings to use during the build.
|
|
241
242
|
|
|
@@ -244,12 +245,12 @@ class ImageArgs:
|
|
|
244
245
|
return pulumi.get(self, "add_hosts")
|
|
245
246
|
|
|
246
247
|
@add_hosts.setter
|
|
247
|
-
def add_hosts(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
|
248
|
+
def add_hosts(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]]):
|
|
248
249
|
pulumi.set(self, "add_hosts", value)
|
|
249
250
|
|
|
250
251
|
@property
|
|
251
252
|
@pulumi.getter(name="buildArgs")
|
|
252
|
-
def build_args(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
|
|
253
|
+
def build_args(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]:
|
|
253
254
|
"""
|
|
254
255
|
`ARG` names and values to set during the build.
|
|
255
256
|
|
|
@@ -264,12 +265,12 @@ class ImageArgs:
|
|
|
264
265
|
return pulumi.get(self, "build_args")
|
|
265
266
|
|
|
266
267
|
@build_args.setter
|
|
267
|
-
def build_args(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
|
|
268
|
+
def build_args(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]):
|
|
268
269
|
pulumi.set(self, "build_args", value)
|
|
269
270
|
|
|
270
271
|
@property
|
|
271
272
|
@pulumi.getter(name="buildOnPreview")
|
|
272
|
-
def build_on_preview(self) -> Optional[pulumi.Input[bool]]:
|
|
273
|
+
def build_on_preview(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
273
274
|
"""
|
|
274
275
|
Setting this to `false` will always skip image builds during previews,
|
|
275
276
|
and setting it to `true` will always build images during previews.
|
|
@@ -286,7 +287,7 @@ class ImageArgs:
|
|
|
286
287
|
return pulumi.get(self, "build_on_preview")
|
|
287
288
|
|
|
288
289
|
@build_on_preview.setter
|
|
289
|
-
def build_on_preview(self, value: Optional[pulumi.Input[bool]]):
|
|
290
|
+
def build_on_preview(self, value: Optional[pulumi.Input[builtins.bool]]):
|
|
290
291
|
pulumi.set(self, "build_on_preview", value)
|
|
291
292
|
|
|
292
293
|
@property
|
|
@@ -359,7 +360,7 @@ class ImageArgs:
|
|
|
359
360
|
|
|
360
361
|
@property
|
|
361
362
|
@pulumi.getter(name="exec")
|
|
362
|
-
def exec_(self) -> Optional[pulumi.Input[bool]]:
|
|
363
|
+
def exec_(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
363
364
|
"""
|
|
364
365
|
Use `exec` mode to build this image.
|
|
365
366
|
|
|
@@ -385,7 +386,7 @@ class ImageArgs:
|
|
|
385
386
|
return pulumi.get(self, "exec_")
|
|
386
387
|
|
|
387
388
|
@exec_.setter
|
|
388
|
-
def exec_(self, value: Optional[pulumi.Input[bool]]):
|
|
389
|
+
def exec_(self, value: Optional[pulumi.Input[builtins.bool]]):
|
|
389
390
|
pulumi.set(self, "exec_", value)
|
|
390
391
|
|
|
391
392
|
@property
|
|
@@ -410,7 +411,7 @@ class ImageArgs:
|
|
|
410
411
|
|
|
411
412
|
@property
|
|
412
413
|
@pulumi.getter
|
|
413
|
-
def labels(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
|
|
414
|
+
def labels(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]:
|
|
414
415
|
"""
|
|
415
416
|
Attach arbitrary key/value metadata to the image.
|
|
416
417
|
|
|
@@ -419,12 +420,12 @@ class ImageArgs:
|
|
|
419
420
|
return pulumi.get(self, "labels")
|
|
420
421
|
|
|
421
422
|
@labels.setter
|
|
422
|
-
def labels(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
|
|
423
|
+
def labels(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]):
|
|
423
424
|
pulumi.set(self, "labels", value)
|
|
424
425
|
|
|
425
426
|
@property
|
|
426
427
|
@pulumi.getter
|
|
427
|
-
def load(self) -> Optional[pulumi.Input[bool]]:
|
|
428
|
+
def load(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
428
429
|
"""
|
|
429
430
|
When `true` the build will automatically include a `docker` export.
|
|
430
431
|
|
|
@@ -435,7 +436,7 @@ class ImageArgs:
|
|
|
435
436
|
return pulumi.get(self, "load")
|
|
436
437
|
|
|
437
438
|
@load.setter
|
|
438
|
-
def load(self, value: Optional[pulumi.Input[bool]]):
|
|
439
|
+
def load(self, value: Optional[pulumi.Input[builtins.bool]]):
|
|
439
440
|
pulumi.set(self, "load", value)
|
|
440
441
|
|
|
441
442
|
@property
|
|
@@ -456,7 +457,7 @@ class ImageArgs:
|
|
|
456
457
|
|
|
457
458
|
@property
|
|
458
459
|
@pulumi.getter(name="noCache")
|
|
459
|
-
def no_cache(self) -> Optional[pulumi.Input[bool]]:
|
|
460
|
+
def no_cache(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
460
461
|
"""
|
|
461
462
|
Do not import cache manifests when building the image.
|
|
462
463
|
|
|
@@ -465,7 +466,7 @@ class ImageArgs:
|
|
|
465
466
|
return pulumi.get(self, "no_cache")
|
|
466
467
|
|
|
467
468
|
@no_cache.setter
|
|
468
|
-
def no_cache(self, value: Optional[pulumi.Input[bool]]):
|
|
469
|
+
def no_cache(self, value: Optional[pulumi.Input[builtins.bool]]):
|
|
469
470
|
pulumi.set(self, "no_cache", value)
|
|
470
471
|
|
|
471
472
|
@property
|
|
@@ -484,7 +485,7 @@ class ImageArgs:
|
|
|
484
485
|
|
|
485
486
|
@property
|
|
486
487
|
@pulumi.getter
|
|
487
|
-
def pull(self) -> Optional[pulumi.Input[bool]]:
|
|
488
|
+
def pull(self) -> Optional[pulumi.Input[builtins.bool]]:
|
|
488
489
|
"""
|
|
489
490
|
Always pull referenced images.
|
|
490
491
|
|
|
@@ -493,7 +494,7 @@ class ImageArgs:
|
|
|
493
494
|
return pulumi.get(self, "pull")
|
|
494
495
|
|
|
495
496
|
@pull.setter
|
|
496
|
-
def pull(self, value: Optional[pulumi.Input[bool]]):
|
|
497
|
+
def pull(self, value: Optional[pulumi.Input[builtins.bool]]):
|
|
497
498
|
pulumi.set(self, "pull", value)
|
|
498
499
|
|
|
499
500
|
@property
|
|
@@ -516,7 +517,7 @@ class ImageArgs:
|
|
|
516
517
|
|
|
517
518
|
@property
|
|
518
519
|
@pulumi.getter
|
|
519
|
-
def secrets(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
|
|
520
|
+
def secrets(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]:
|
|
520
521
|
"""
|
|
521
522
|
A mapping of secret names to their corresponding values.
|
|
522
523
|
|
|
@@ -531,7 +532,7 @@ class ImageArgs:
|
|
|
531
532
|
return pulumi.get(self, "secrets")
|
|
532
533
|
|
|
533
534
|
@secrets.setter
|
|
534
|
-
def secrets(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
|
|
535
|
+
def secrets(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]):
|
|
535
536
|
pulumi.set(self, "secrets", value)
|
|
536
537
|
|
|
537
538
|
@property
|
|
@@ -550,7 +551,7 @@ class ImageArgs:
|
|
|
550
551
|
|
|
551
552
|
@property
|
|
552
553
|
@pulumi.getter
|
|
553
|
-
def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
554
|
+
def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]]:
|
|
554
555
|
"""
|
|
555
556
|
Name and optionally a tag (format: `name:tag`).
|
|
556
557
|
|
|
@@ -562,12 +563,12 @@ class ImageArgs:
|
|
|
562
563
|
return pulumi.get(self, "tags")
|
|
563
564
|
|
|
564
565
|
@tags.setter
|
|
565
|
-
def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]):
|
|
566
|
+
def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]]):
|
|
566
567
|
pulumi.set(self, "tags", value)
|
|
567
568
|
|
|
568
569
|
@property
|
|
569
570
|
@pulumi.getter
|
|
570
|
-
def target(self) -> Optional[pulumi.Input[str]]:
|
|
571
|
+
def target(self) -> Optional[pulumi.Input[builtins.str]]:
|
|
571
572
|
"""
|
|
572
573
|
Set the target build stage(s) to build.
|
|
573
574
|
|
|
@@ -578,37 +579,40 @@ class ImageArgs:
|
|
|
578
579
|
return pulumi.get(self, "target")
|
|
579
580
|
|
|
580
581
|
@target.setter
|
|
581
|
-
def target(self, value: Optional[pulumi.Input[str]]):
|
|
582
|
+
def target(self, value: Optional[pulumi.Input[builtins.str]]):
|
|
582
583
|
pulumi.set(self, "target", value)
|
|
583
584
|
|
|
584
585
|
|
|
585
586
|
class Image(pulumi.CustomResource):
|
|
587
|
+
|
|
588
|
+
pulumi_type = "docker-build:index:Image"
|
|
589
|
+
|
|
586
590
|
@overload
|
|
587
591
|
def __init__(__self__,
|
|
588
592
|
resource_name: str,
|
|
589
593
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
590
|
-
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
591
|
-
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
592
|
-
build_on_preview: Optional[pulumi.Input[bool]] = None,
|
|
594
|
+
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
|
|
595
|
+
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
|
|
596
|
+
build_on_preview: Optional[pulumi.Input[builtins.bool]] = None,
|
|
593
597
|
builder: Optional[pulumi.Input[Union['BuilderConfigArgs', 'BuilderConfigArgsDict']]] = None,
|
|
594
598
|
cache_from: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CacheFromArgs', 'CacheFromArgsDict']]]]] = None,
|
|
595
599
|
cache_to: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CacheToArgs', 'CacheToArgsDict']]]]] = None,
|
|
596
600
|
context: Optional[pulumi.Input[Union['BuildContextArgs', 'BuildContextArgsDict']]] = None,
|
|
597
601
|
dockerfile: Optional[pulumi.Input[Union['DockerfileArgs', 'DockerfileArgsDict']]] = None,
|
|
598
|
-
exec_: Optional[pulumi.Input[bool]] = None,
|
|
602
|
+
exec_: Optional[pulumi.Input[builtins.bool]] = None,
|
|
599
603
|
exports: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExportArgs', 'ExportArgsDict']]]]] = None,
|
|
600
|
-
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
601
|
-
load: Optional[pulumi.Input[bool]] = None,
|
|
604
|
+
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
|
|
605
|
+
load: Optional[pulumi.Input[builtins.bool]] = None,
|
|
602
606
|
network: Optional[pulumi.Input['NetworkMode']] = None,
|
|
603
|
-
no_cache: Optional[pulumi.Input[bool]] = None,
|
|
607
|
+
no_cache: Optional[pulumi.Input[builtins.bool]] = None,
|
|
604
608
|
platforms: Optional[pulumi.Input[Sequence[pulumi.Input['Platform']]]] = None,
|
|
605
|
-
pull: Optional[pulumi.Input[bool]] = None,
|
|
606
|
-
push: Optional[pulumi.Input[bool]] = None,
|
|
609
|
+
pull: Optional[pulumi.Input[builtins.bool]] = None,
|
|
610
|
+
push: Optional[pulumi.Input[builtins.bool]] = None,
|
|
607
611
|
registries: Optional[pulumi.Input[Sequence[pulumi.Input[Union['RegistryArgs', 'RegistryArgsDict']]]]] = None,
|
|
608
|
-
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
612
|
+
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
|
|
609
613
|
ssh: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SSHArgs', 'SSHArgsDict']]]]] = None,
|
|
610
|
-
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
611
|
-
target: Optional[pulumi.Input[str]] = None,
|
|
614
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
|
|
615
|
+
target: Optional[pulumi.Input[builtins.str]] = None,
|
|
612
616
|
__props__=None):
|
|
613
617
|
"""
|
|
614
618
|
A Docker image built using buildx -- Docker's interface to the improved
|
|
@@ -919,10 +923,10 @@ class Image(pulumi.CustomResource):
|
|
|
919
923
|
|
|
920
924
|
:param str resource_name: The name of the resource.
|
|
921
925
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
922
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] add_hosts: Custom `host:ip` mappings to use during the build.
|
|
926
|
+
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] add_hosts: Custom `host:ip` mappings to use during the build.
|
|
923
927
|
|
|
924
928
|
Equivalent to Docker's `--add-host` flag.
|
|
925
|
-
:param pulumi.Input[Mapping[str, pulumi.Input[str]]] build_args: `ARG` names and values to set during the build.
|
|
929
|
+
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] build_args: `ARG` names and values to set during the build.
|
|
926
930
|
|
|
927
931
|
These variables are accessed like environment variables inside `RUN`
|
|
928
932
|
instructions.
|
|
@@ -931,7 +935,7 @@ class Image(pulumi.CustomResource):
|
|
|
931
935
|
if these arguments are sensitive.
|
|
932
936
|
|
|
933
937
|
Equivalent to Docker's `--build-arg` flag.
|
|
934
|
-
:param pulumi.Input[bool] build_on_preview: Setting this to `false` will always skip image builds during previews,
|
|
938
|
+
:param pulumi.Input[builtins.bool] build_on_preview: Setting this to `false` will always skip image builds during previews,
|
|
935
939
|
and setting it to `true` will always build images during previews.
|
|
936
940
|
|
|
937
941
|
Images built during previews are never exported to registries, however
|
|
@@ -955,7 +959,7 @@ class Image(pulumi.CustomResource):
|
|
|
955
959
|
:param pulumi.Input[Union['DockerfileArgs', 'DockerfileArgsDict']] dockerfile: Dockerfile settings.
|
|
956
960
|
|
|
957
961
|
Equivalent to Docker's `--file` flag.
|
|
958
|
-
:param pulumi.Input[bool] exec_: Use `exec` mode to build this image.
|
|
962
|
+
:param pulumi.Input[builtins.bool] exec_: Use `exec` mode to build this image.
|
|
959
963
|
|
|
960
964
|
By default the provider embeds a v25 Docker client with v0.12 buildx
|
|
961
965
|
support. This helps ensure consistent behavior across environments and
|
|
@@ -984,10 +988,10 @@ class Image(pulumi.CustomResource):
|
|
|
984
988
|
0.13 or later.
|
|
985
989
|
|
|
986
990
|
Equivalent to Docker's `--output` flag.
|
|
987
|
-
:param pulumi.Input[Mapping[str, pulumi.Input[str]]] labels: Attach arbitrary key/value metadata to the image.
|
|
991
|
+
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] labels: Attach arbitrary key/value metadata to the image.
|
|
988
992
|
|
|
989
993
|
Equivalent to Docker's `--label` flag.
|
|
990
|
-
:param pulumi.Input[bool] load: When `true` the build will automatically include a `docker` export.
|
|
994
|
+
:param pulumi.Input[builtins.bool] load: When `true` the build will automatically include a `docker` export.
|
|
991
995
|
|
|
992
996
|
Defaults to `false`.
|
|
993
997
|
|
|
@@ -997,16 +1001,16 @@ class Image(pulumi.CustomResource):
|
|
|
997
1001
|
For custom networks, configure your builder with `--driver-opt network=...`.
|
|
998
1002
|
|
|
999
1003
|
Equivalent to Docker's `--network` flag.
|
|
1000
|
-
:param pulumi.Input[bool] no_cache: Do not import cache manifests when building the image.
|
|
1004
|
+
:param pulumi.Input[builtins.bool] no_cache: Do not import cache manifests when building the image.
|
|
1001
1005
|
|
|
1002
1006
|
Equivalent to Docker's `--no-cache` flag.
|
|
1003
1007
|
:param pulumi.Input[Sequence[pulumi.Input['Platform']]] platforms: Set target platform(s) for the build. Defaults to the host's platform.
|
|
1004
1008
|
|
|
1005
1009
|
Equivalent to Docker's `--platform` flag.
|
|
1006
|
-
:param pulumi.Input[bool] pull: Always pull referenced images.
|
|
1010
|
+
:param pulumi.Input[builtins.bool] pull: Always pull referenced images.
|
|
1007
1011
|
|
|
1008
1012
|
Equivalent to Docker's `--pull` flag.
|
|
1009
|
-
:param pulumi.Input[bool] push: When `true` the build will automatically include a `registry` export.
|
|
1013
|
+
:param pulumi.Input[builtins.bool] push: When `true` the build will automatically include a `registry` export.
|
|
1010
1014
|
|
|
1011
1015
|
Defaults to `false`.
|
|
1012
1016
|
|
|
@@ -1018,7 +1022,7 @@ class Image(pulumi.CustomResource):
|
|
|
1018
1022
|
credentials on the host.
|
|
1019
1023
|
|
|
1020
1024
|
Similar to `docker login`.
|
|
1021
|
-
:param pulumi.Input[Mapping[str, pulumi.Input[str]]] secrets: A mapping of secret names to their corresponding values.
|
|
1025
|
+
:param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] secrets: A mapping of secret names to their corresponding values.
|
|
1022
1026
|
|
|
1023
1027
|
Unlike the Docker CLI, these can be passed by value and do not need to
|
|
1024
1028
|
exist on-disk or in environment variables.
|
|
@@ -1030,13 +1034,13 @@ class Image(pulumi.CustomResource):
|
|
|
1030
1034
|
:param pulumi.Input[Sequence[pulumi.Input[Union['SSHArgs', 'SSHArgsDict']]]] ssh: SSH agent socket or keys to expose to the build.
|
|
1031
1035
|
|
|
1032
1036
|
Equivalent to Docker's `--ssh` flag.
|
|
1033
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: Name and optionally a tag (format: `name:tag`).
|
|
1037
|
+
:param pulumi.Input[Sequence[pulumi.Input[builtins.str]]] tags: Name and optionally a tag (format: `name:tag`).
|
|
1034
1038
|
|
|
1035
1039
|
If exporting to a registry, the name should include the fully qualified
|
|
1036
1040
|
registry address (e.g. `docker.io/pulumi/pulumi:latest`).
|
|
1037
1041
|
|
|
1038
1042
|
Equivalent to Docker's `--tag` flag.
|
|
1039
|
-
:param pulumi.Input[str] target: Set the target build stage(s) to build.
|
|
1043
|
+
:param pulumi.Input[builtins.str] target: Set the target build stage(s) to build.
|
|
1040
1044
|
|
|
1041
1045
|
If not specified all targets will be built by default.
|
|
1042
1046
|
|
|
@@ -1370,28 +1374,28 @@ class Image(pulumi.CustomResource):
|
|
|
1370
1374
|
def _internal_init(__self__,
|
|
1371
1375
|
resource_name: str,
|
|
1372
1376
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
1373
|
-
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1374
|
-
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
1375
|
-
build_on_preview: Optional[pulumi.Input[bool]] = None,
|
|
1377
|
+
add_hosts: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
|
|
1378
|
+
build_args: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
|
|
1379
|
+
build_on_preview: Optional[pulumi.Input[builtins.bool]] = None,
|
|
1376
1380
|
builder: Optional[pulumi.Input[Union['BuilderConfigArgs', 'BuilderConfigArgsDict']]] = None,
|
|
1377
1381
|
cache_from: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CacheFromArgs', 'CacheFromArgsDict']]]]] = None,
|
|
1378
1382
|
cache_to: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CacheToArgs', 'CacheToArgsDict']]]]] = None,
|
|
1379
1383
|
context: Optional[pulumi.Input[Union['BuildContextArgs', 'BuildContextArgsDict']]] = None,
|
|
1380
1384
|
dockerfile: Optional[pulumi.Input[Union['DockerfileArgs', 'DockerfileArgsDict']]] = None,
|
|
1381
|
-
exec_: Optional[pulumi.Input[bool]] = None,
|
|
1385
|
+
exec_: Optional[pulumi.Input[builtins.bool]] = None,
|
|
1382
1386
|
exports: Optional[pulumi.Input[Sequence[pulumi.Input[Union['ExportArgs', 'ExportArgsDict']]]]] = None,
|
|
1383
|
-
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
1384
|
-
load: Optional[pulumi.Input[bool]] = None,
|
|
1387
|
+
labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
|
|
1388
|
+
load: Optional[pulumi.Input[builtins.bool]] = None,
|
|
1385
1389
|
network: Optional[pulumi.Input['NetworkMode']] = None,
|
|
1386
|
-
no_cache: Optional[pulumi.Input[bool]] = None,
|
|
1390
|
+
no_cache: Optional[pulumi.Input[builtins.bool]] = None,
|
|
1387
1391
|
platforms: Optional[pulumi.Input[Sequence[pulumi.Input['Platform']]]] = None,
|
|
1388
|
-
pull: Optional[pulumi.Input[bool]] = None,
|
|
1389
|
-
push: Optional[pulumi.Input[bool]] = None,
|
|
1392
|
+
pull: Optional[pulumi.Input[builtins.bool]] = None,
|
|
1393
|
+
push: Optional[pulumi.Input[builtins.bool]] = None,
|
|
1390
1394
|
registries: Optional[pulumi.Input[Sequence[pulumi.Input[Union['RegistryArgs', 'RegistryArgsDict']]]]] = None,
|
|
1391
|
-
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
|
|
1395
|
+
secrets: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
|
|
1392
1396
|
ssh: Optional[pulumi.Input[Sequence[pulumi.Input[Union['SSHArgs', 'SSHArgsDict']]]]] = None,
|
|
1393
|
-
tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1394
|
-
target: Optional[pulumi.Input[str]] = None,
|
|
1397
|
+
tags: Optional[pulumi.Input[Sequence[pulumi.Input[builtins.str]]]] = None,
|
|
1398
|
+
target: Optional[pulumi.Input[builtins.str]] = None,
|
|
1395
1399
|
__props__=None):
|
|
1396
1400
|
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
1397
1401
|
if not isinstance(opts, pulumi.ResourceOptions):
|
|
@@ -1483,7 +1487,7 @@ class Image(pulumi.CustomResource):
|
|
|
1483
1487
|
|
|
1484
1488
|
@property
|
|
1485
1489
|
@pulumi.getter(name="addHosts")
|
|
1486
|
-
def add_hosts(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
|
1490
|
+
def add_hosts(self) -> pulumi.Output[Optional[Sequence[builtins.str]]]:
|
|
1487
1491
|
"""
|
|
1488
1492
|
Custom `host:ip` mappings to use during the build.
|
|
1489
1493
|
|
|
@@ -1493,7 +1497,7 @@ class Image(pulumi.CustomResource):
|
|
|
1493
1497
|
|
|
1494
1498
|
@property
|
|
1495
1499
|
@pulumi.getter(name="buildArgs")
|
|
1496
|
-
def build_args(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
|
|
1500
|
+
def build_args(self) -> pulumi.Output[Optional[Mapping[str, builtins.str]]]:
|
|
1497
1501
|
"""
|
|
1498
1502
|
`ARG` names and values to set during the build.
|
|
1499
1503
|
|
|
@@ -1509,7 +1513,7 @@ class Image(pulumi.CustomResource):
|
|
|
1509
1513
|
|
|
1510
1514
|
@property
|
|
1511
1515
|
@pulumi.getter(name="buildOnPreview")
|
|
1512
|
-
def build_on_preview(self) -> pulumi.Output[Optional[bool]]:
|
|
1516
|
+
def build_on_preview(self) -> pulumi.Output[Optional[builtins.bool]]:
|
|
1513
1517
|
"""
|
|
1514
1518
|
Setting this to `false` will always skip image builds during previews,
|
|
1515
1519
|
and setting it to `true` will always build images during previews.
|
|
@@ -1565,7 +1569,7 @@ class Image(pulumi.CustomResource):
|
|
|
1565
1569
|
|
|
1566
1570
|
@property
|
|
1567
1571
|
@pulumi.getter(name="contextHash")
|
|
1568
|
-
def context_hash(self) -> pulumi.Output[str]:
|
|
1572
|
+
def context_hash(self) -> pulumi.Output[builtins.str]:
|
|
1569
1573
|
"""
|
|
1570
1574
|
A preliminary hash of the image's build context.
|
|
1571
1575
|
|
|
@@ -1575,7 +1579,7 @@ class Image(pulumi.CustomResource):
|
|
|
1575
1579
|
|
|
1576
1580
|
@property
|
|
1577
1581
|
@pulumi.getter
|
|
1578
|
-
def digest(self) -> pulumi.Output[str]:
|
|
1582
|
+
def digest(self) -> pulumi.Output[builtins.str]:
|
|
1579
1583
|
"""
|
|
1580
1584
|
A SHA256 digest of the image if it was exported to a registry or
|
|
1581
1585
|
elsewhere.
|
|
@@ -1599,7 +1603,7 @@ class Image(pulumi.CustomResource):
|
|
|
1599
1603
|
|
|
1600
1604
|
@property
|
|
1601
1605
|
@pulumi.getter(name="exec")
|
|
1602
|
-
def exec_(self) -> pulumi.Output[Optional[bool]]:
|
|
1606
|
+
def exec_(self) -> pulumi.Output[Optional[builtins.bool]]:
|
|
1603
1607
|
"""
|
|
1604
1608
|
Use `exec` mode to build this image.
|
|
1605
1609
|
|
|
@@ -1642,7 +1646,7 @@ class Image(pulumi.CustomResource):
|
|
|
1642
1646
|
|
|
1643
1647
|
@property
|
|
1644
1648
|
@pulumi.getter
|
|
1645
|
-
def labels(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
|
|
1649
|
+
def labels(self) -> pulumi.Output[Optional[Mapping[str, builtins.str]]]:
|
|
1646
1650
|
"""
|
|
1647
1651
|
Attach arbitrary key/value metadata to the image.
|
|
1648
1652
|
|
|
@@ -1652,7 +1656,7 @@ class Image(pulumi.CustomResource):
|
|
|
1652
1656
|
|
|
1653
1657
|
@property
|
|
1654
1658
|
@pulumi.getter
|
|
1655
|
-
def load(self) -> pulumi.Output[Optional[bool]]:
|
|
1659
|
+
def load(self) -> pulumi.Output[Optional[builtins.bool]]:
|
|
1656
1660
|
"""
|
|
1657
1661
|
When `true` the build will automatically include a `docker` export.
|
|
1658
1662
|
|
|
@@ -1676,7 +1680,7 @@ class Image(pulumi.CustomResource):
|
|
|
1676
1680
|
|
|
1677
1681
|
@property
|
|
1678
1682
|
@pulumi.getter(name="noCache")
|
|
1679
|
-
def no_cache(self) -> pulumi.Output[Optional[bool]]:
|
|
1683
|
+
def no_cache(self) -> pulumi.Output[Optional[builtins.bool]]:
|
|
1680
1684
|
"""
|
|
1681
1685
|
Do not import cache manifests when building the image.
|
|
1682
1686
|
|
|
@@ -1696,7 +1700,7 @@ class Image(pulumi.CustomResource):
|
|
|
1696
1700
|
|
|
1697
1701
|
@property
|
|
1698
1702
|
@pulumi.getter
|
|
1699
|
-
def pull(self) -> pulumi.Output[Optional[bool]]:
|
|
1703
|
+
def pull(self) -> pulumi.Output[Optional[builtins.bool]]:
|
|
1700
1704
|
"""
|
|
1701
1705
|
Always pull referenced images.
|
|
1702
1706
|
|
|
@@ -1706,7 +1710,7 @@ class Image(pulumi.CustomResource):
|
|
|
1706
1710
|
|
|
1707
1711
|
@property
|
|
1708
1712
|
@pulumi.getter
|
|
1709
|
-
def push(self) -> pulumi.Output[bool]:
|
|
1713
|
+
def push(self) -> pulumi.Output[builtins.bool]:
|
|
1710
1714
|
"""
|
|
1711
1715
|
When `true` the build will automatically include a `registry` export.
|
|
1712
1716
|
|
|
@@ -1718,7 +1722,7 @@ class Image(pulumi.CustomResource):
|
|
|
1718
1722
|
|
|
1719
1723
|
@property
|
|
1720
1724
|
@pulumi.getter
|
|
1721
|
-
def ref(self) -> pulumi.Output[str]:
|
|
1725
|
+
def ref(self) -> pulumi.Output[builtins.str]:
|
|
1722
1726
|
"""
|
|
1723
1727
|
If the image was pushed to any registries then this will contain a
|
|
1724
1728
|
single fully-qualified tag including the build's digest.
|
|
@@ -1753,7 +1757,7 @@ class Image(pulumi.CustomResource):
|
|
|
1753
1757
|
|
|
1754
1758
|
@property
|
|
1755
1759
|
@pulumi.getter
|
|
1756
|
-
def secrets(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
|
|
1760
|
+
def secrets(self) -> pulumi.Output[Optional[Mapping[str, builtins.str]]]:
|
|
1757
1761
|
"""
|
|
1758
1762
|
A mapping of secret names to their corresponding values.
|
|
1759
1763
|
|
|
@@ -1779,7 +1783,7 @@ class Image(pulumi.CustomResource):
|
|
|
1779
1783
|
|
|
1780
1784
|
@property
|
|
1781
1785
|
@pulumi.getter
|
|
1782
|
-
def tags(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
|
1786
|
+
def tags(self) -> pulumi.Output[Optional[Sequence[builtins.str]]]:
|
|
1783
1787
|
"""
|
|
1784
1788
|
Name and optionally a tag (format: `name:tag`).
|
|
1785
1789
|
|
|
@@ -1792,7 +1796,7 @@ class Image(pulumi.CustomResource):
|
|
|
1792
1796
|
|
|
1793
1797
|
@property
|
|
1794
1798
|
@pulumi.getter
|
|
1795
|
-
def target(self) -> pulumi.Output[Optional[str]]:
|
|
1799
|
+
def target(self) -> pulumi.Output[Optional[builtins.str]]:
|
|
1796
1800
|
"""
|
|
1797
1801
|
Set the target build stage(s) to build.
|
|
1798
1802
|
|