prefect_docker.containers
Integrations with Docker Containers.
Classes
Functions
create_docker_container
async
Create a container without starting it. Similar to docker create.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
image |
str
|
The image to run. |
required |
command |
Optional[Union[str, List[str]]]
|
The command(s) to run in the container. |
None
|
name |
Optional[str]
|
The name for this container. |
None
|
detach |
Optional[bool]
|
Run container in the background. |
None
|
docker_host |
Optional[DockerHost]
|
Settings for interacting with a Docker host. |
None
|
entrypoint |
Optional[Union[str, List[str]]]
|
The entrypoint for the container. |
None
|
environment |
Optional[Union[Dict[str, str], List[str]]]
|
Environment variables to set inside the container, as a dictionary or a list of strings in the format ["SOMEVARIABLE=xxx"]. |
None
|
**create_kwargs |
Dict[str, Any]
|
Additional keyword arguments to pass to
|
{}
|
Returns:
Type | Description |
---|---|
Container
|
A Docker Container object. |
Examples:
Create a container with the Prefect image.
from prefect import flow
from prefect_docker.containers import create_docker_container
@flow
def create_docker_container_flow():
container = create_docker_container(
image="prefecthq/prefect",
command="echo 'hello world!'"
)
create_docker_container_flow()
Source code in prefect_docker/containers.py
12 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 |
|
get_docker_container_logs
async
Get logs from this container. Similar to the docker logs command.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
container_id |
str
|
The container ID to pull logs from. |
required |
docker_host |
Optional[DockerHost]
|
Settings for interacting with a Docker host. |
None
|
**logs_kwargs |
Dict[str, Any]
|
Additional keyword arguments to pass to
|
{}
|
Returns:
Type | Description |
---|---|
str
|
The Container's logs. |
Examples:
Gets logs from a container with an ID that starts with "c157".
from prefect import flow
from prefect_docker.containers import get_docker_container_logs
@flow
def get_docker_container_logs_flow():
logs = get_docker_container_logs(container_id="c157")
return logs
get_docker_container_logs_flow()
Source code in prefect_docker/containers.py
74 75 76 77 78 79 80 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 |
|
remove_docker_container
async
Remove this container. Similar to the docker rm command.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
container_id |
str
|
The container ID to remove. |
required |
docker_host |
Optional[DockerHost]
|
Settings for interacting with a Docker host. |
None
|
**remove_kwargs |
Dict[str, Any]
|
Additional keyword arguments to pass to
|
{}
|
Returns:
Type | Description |
---|---|
Container
|
The Docker Container object. |
Examples:
Removes a container with an ID that starts wtih "c157".
from prefect import flow
from prefect_docker.containers import remove_docker_container
@flow
def remove_docker_container_flow():
container = remove_docker_container(container_id="c157")
return container
remove_docker_container()
Source code in prefect_docker/containers.py
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 |
|
start_docker_container
async
Start this container. Similar to the docker start command.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
container_id |
str
|
The container ID to start. |
required |
docker_host |
Optional[DockerHost]
|
Settings for interacting with a Docker host. |
None
|
**start_kwargs |
Dict[str, Any]
|
Additional keyword arguments to pass to
|
{}
|
Returns:
Type | Description |
---|---|
Container
|
The Docker Container object. |
Examples:
Start a container with an ID that starts wtih "c157".
from prefect import flow
from prefect_docker.containers import start_docker_container
@flow
def start_docker_container_flow():
container = start_docker_container(container_id="c157")
return container
start_docker_container_flow()
Source code in prefect_docker/containers.py
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 |
|
stop_docker_container
async
Stops a container. Similar to the docker stop command.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
container_id |
str
|
The container ID to stop. |
required |
docker_host |
Optional[DockerHost]
|
Settings for interacting with a Docker host. |
None
|
**stop_kwargs |
Dict[str, Any]
|
Additional keyword arguments to pass to
|
{}
|
Returns:
Type | Description |
---|---|
Container
|
The Docker Container object. |
Examples:
Stop a container with an ID that starts wtih "c157".
from prefect import flow
from prefect_docker.containers import stop_docker_container
@flow
def stop_docker_container_flow():
container = stop_docker_container(container_id="c157")
return container
stop_docker_container_flow()
Source code in prefect_docker/containers.py
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 |
|