prefect_docker.images
¶
Integrations with Docker Images.
pull_docker_image
async
¶
Pull an image of the given name and return it. Similar to the docker pull command.
If all_tags is set, the tag parameter is ignored and all image tags will be pulled.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
repository |
str
|
The repository to pull. |
required |
tag |
Optional[str]
|
The tag to pull; if not provided, it is set to latest. |
None
|
platform |
Optional[str]
|
Platform in the format os[/arch[/variant]]. |
None
|
all_tags |
bool
|
Pull all image tags which will return a list of Images. |
False
|
docker_host |
Optional[DockerHost]
|
Settings for interacting with a Docker host; if not
provided, will automatically instantiate a |
None
|
docker_registry_credentials |
Optional[DockerRegistryCredentials]
|
Docker credentials used to log in to a registry before pulling the image. |
None
|
**pull_kwargs |
Dict[str, Any]
|
Additional keyword arguments to pass to |
{}
|
Returns:
Type | Description |
---|---|
Union[Image, List[Image]]
|
The image that has been pulled, or a list of images if |
Examples:
Pull prefecthq/prefect image with the tag latest-python3.10.
from prefect import flow
from prefect_docker.images import pull_docker_image
@flow
def pull_docker_image_flow():
image = pull_docker_image(
repository="prefecthq/prefect",
tag="latest-python3.10"
)
return image
pull_docker_image_flow()
Source code in prefect_docker/images.py
13 14 15 16 17 18 19 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 83 84 85 |
|