Configuration used to build and push a Docker image for a deployment.
Attributes:
| Name |
Type |
Description |
name |
|
The name of the Docker image to build, including the registry and
repository.
|
tag |
|
The tag to apply to the built image.
|
dockerfile |
|
The path to the Dockerfile to use for building the image. If
not provided, a default Dockerfile will be generated.
|
**build_kwargs |
|
Additional keyword arguments to pass to the Docker build request.
See the docker-py documentation
for more information.
|
Source code in src/prefect/docker/docker_image.py
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82 | class DockerImage:
"""
Configuration used to build and push a Docker image for a deployment.
Attributes:
name: The name of the Docker image to build, including the registry and
repository.
tag: The tag to apply to the built image.
dockerfile: The path to the Dockerfile to use for building the image. If
not provided, a default Dockerfile will be generated.
**build_kwargs: Additional keyword arguments to pass to the Docker build request.
See the [`docker-py` documentation](https://docker-py.readthedocs.io/en/stable/images.html#docker.models.images.ImageCollection.build)
for more information.
"""
def __init__(
self, name: str, tag: Optional[str] = None, dockerfile="auto", **build_kwargs
):
image_name, image_tag = parse_image_tag(name)
if tag and image_tag:
raise ValueError(
f"Only one tag can be provided - both {image_tag!r} and {tag!r} were"
" provided as tags."
)
namespace, repository = split_repository_path(image_name)
# if the provided image name does not include a namespace (registry URL or user/org name),
# use the default namespace
if not namespace:
namespace = PREFECT_DEFAULT_DOCKER_BUILD_NAMESPACE.value()
# join the namespace and repository to create the full image name
# ignore namespace if it is None
self.name = "/".join(filter(None, [namespace, repository]))
self.tag = tag or image_tag or slugify(pendulum_now("utc").isoformat())
self.dockerfile = dockerfile
self.build_kwargs = build_kwargs
@property
def reference(self):
return f"{self.name}:{self.tag}"
def build(self):
full_image_name = self.reference
build_kwargs = self.build_kwargs.copy()
build_kwargs["context"] = Path.cwd()
build_kwargs["tag"] = full_image_name
build_kwargs["pull"] = build_kwargs.get("pull", True)
if self.dockerfile == "auto":
with generate_default_dockerfile():
build_image(**build_kwargs)
else:
build_kwargs["dockerfile"] = self.dockerfile
build_image(**build_kwargs)
def push(self):
with docker_client() as client:
events = client.api.push(
repository=self.name, tag=self.tag, stream=True, decode=True
)
for event in events:
if "error" in event:
raise PushError(event["error"])
|