prefect_docker.deployments.steps
Prefect deployment steps for building and pushing Docker images.
These steps can be used in a prefect.yaml
file to define the default
build steps for a group of deployments, or they can be used to define
the build step for a specific deployment.
Example
Build a Docker image before deploying a flow:
build:
- prefect_docker.deployments.steps.build_docker_image:
id: build-image
requires: prefect-docker
image_name: repo-name/image-name
tag: dev
push:
- prefect_docker.deployments.steps.push_docker_image:
requires: prefect-docker
image_name: "{{ build-image.image_name }}"
tag: "{{ build-image.tag }}"
Classes
BuildDockerImageResult
Bases: TypedDict
The result of a build_docker_image
step.
Attributes:
Name | Type | Description |
---|---|---|
image_name |
str
|
The name of the built image. |
tag |
str
|
The tag of the built image. |
image |
str
|
The name and tag of the built image. |
image_id |
str
|
The ID of the built image. |
additional_tags |
Optional[str]
|
The additional tags on the image, in addition to |
Source code in prefect_docker/deployments/steps.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
|
PushDockerImageResult
Bases: TypedDict
The result of a push_docker_image
step.
Attributes:
Name | Type | Description |
---|---|---|
image_name |
str
|
The name of the pushed image. |
tag |
str
|
The tag of the pushed image. |
image |
str
|
The name and tag of the pushed image. |
additional_tags |
Optional[str]
|
The additional tags on the image, in addition to |
Source code in prefect_docker/deployments/steps.py
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
|
Functions
build_docker_image
Builds a Docker image for a Prefect deployment.
Can be used within a prefect.yaml
file to build a Docker
image prior to creating or updating a deployment.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
image_name |
str
|
The name of the Docker image to build, including the registry and repository. |
required |
dockerfile |
str
|
The path to the Dockerfile used to build the image. If "auto" is passed, a temporary Dockerfile will be created to build the image. |
'Dockerfile'
|
tag |
Optional[str]
|
The tag to apply to the built image. |
None
|
push |
bool
|
|
False
|
credentials |
Optional[Dict]
|
A dictionary containing the username, password, and URL for the registry to push the image to. |
None
|
additional_tags |
Optional[List[str]]
|
Additional tags on the image, in addition to |
None
|
**build_kwargs |
Additional keyword arguments to pass to Docker when building
the image. Available options can be found in the |
{}
|
Returns:
Type | Description |
---|---|
BuildDockerImageResult
|
A dictionary containing the image name and tag of the built image. |
Example
Build and push a Docker image prior to creating a deployment:
build:
- prefect_docker.deployments.steps.build_docker_image:
requires: prefect-docker
image_name: repo-name/image-name
tag: dev
Build and push a Docker image with multiple tags:
build:
- prefect_docker.deployments.steps.build_docker_image:
requires: prefect-docker
image_name: repo-name/image-name
tag: dev
additional_tags:
- v0.1.0,
- dac9ccccedaa55a17916eef14f95cc7bdd3c8199
Build a Docker image using an auto-generated Dockerfile:
build:
- prefect_docker.deployments.steps.build_docker_image:
requires: prefect-docker
image_name: repo-name/image-name
tag: dev
dockerfile: auto
push: false
Build a Docker image for a different platform:
build:
- prefect_docker.deployments.steps.build_docker_image:
requires: prefect-docker
image_name: repo-name/image-name
tag: dev
dockerfile: Dockerfile
push: false
platform: amd64
Source code in prefect_docker/deployments/steps.py
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
|
push_docker_image
Push a Docker image to a remote registry.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
image_name |
str
|
The name of the Docker image to push, including the registry and repository. |
required |
tag |
Optional[str]
|
The tag of the Docker image to push. |
None
|
credentials |
Optional[Dict]
|
A dictionary containing the username, password, and URL for the registry to push the image to. |
None
|
additional_tags |
Optional[List[str]]
|
Additional tags on the image, in addition to |
None
|
Returns:
Type | Description |
---|---|
PushDockerImageResult
|
A dictionary containing the image name and tag of the pushed image. |
Examples:
Build and push a Docker image to a private repository:
build:
- prefect_docker.deployments.steps.build_docker_image:
id: build-image
requires: prefect-docker
image_name: repo-name/image-name
tag: dev
dockerfile: auto
push:
- prefect_docker.deployments.steps.push_docker_image:
requires: prefect-docker
image_name: "{{ build-image.image_name }}"
tag: "{{ build-image.tag }}"
credentials: "{{ prefect.blocks.docker-registry-credentials.dev-registry }}"
Build and push a Docker image to a private repository with multiple tags
build:
- prefect_docker.deployments.steps.build_docker_image:
id: build-image
requires: prefect-docker
image_name: repo-name/image-name
tag: dev
dockerfile: auto
additional_tags: [
v0.1.0,
dac9ccccedaa55a17916eef14f95cc7bdd3c8199
]
push:
- prefect_docker.deployments.steps.push_docker_image:
requires: prefect-docker
image_name: "{{ build-image.image_name }}"
tag: "{{ build-image.tag }}"
credentials: "{{ prefect.blocks.docker-registry-credentials.dev-registry }}"
additional_tags: "{{ build-image.additional_tags }}"
Source code in prefect_docker/deployments/steps.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 |
|