prefect_kubernetes.jobs
¶
Module to define tasks for interacting with Kubernetes jobs.
KubernetesJob
¶
Bases: JobBlock
A block representing a Kubernetes job configuration.
Source code in prefect_kubernetes/jobs.py
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 |
|
from_yaml_file
classmethod
¶
Create a KubernetesJob
from a YAML file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
manifest_path |
Union[Path, str]
|
The YAML file to create the |
required |
Returns:
Type | Description |
---|---|
Self
|
A KubernetesJob object. |
Source code in prefect_kubernetes/jobs.py
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 |
|
trigger
async
¶
Create a Kubernetes job and return a KubernetesJobRun
object.
Source code in prefect_kubernetes/jobs.py
540 541 542 543 544 545 546 547 548 549 550 551 |
|
KubernetesJobRun
¶
Bases: JobRun[Dict[str, Any]]
A container representing a run of a Kubernetes job.
Source code in prefect_kubernetes/jobs.py
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
|
fetch_result
async
¶
Fetch the results of the job.
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
The logs from each of the pods in the job. |
Raises:
Type | Description |
---|---|
ValueError
|
If this method is called when the job has a non-terminal state. |
Source code in prefect_kubernetes/jobs.py
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
|
wait_for_completion
async
¶
Waits for the job to complete.
If the job has delete_after_completion
set to True
,
the job will be deleted if it is observed by this method
to enter a completed state.
Raises:
Type | Description |
---|---|
RuntimeError
|
If the Kubernetes job fails. |
KubernetesJobTimeoutError
|
If the Kubernetes job times out. |
ValueError
|
If |
Source code in prefect_kubernetes/jobs.py
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
|
create_namespaced_job
async
¶
Task for creating a namespaced Kubernetes job.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
new_job |
Union[V1Job, Dict[str, Any]]
|
A Kubernetes |
required |
namespace |
Optional[str]
|
The Kubernetes namespace to create this job in. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Returns:
Type | Description |
---|---|
V1Job
|
A Kubernetes |
Example
Create a job in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.jobs import create_namespaced_job
from kubernetes_asyncio.client.models import V1Job
@flow
def kubernetes_orchestrator():
v1_job_metadata = create_namespaced_job(
new_job=V1Job(metadata={"labels": {"foo": "bar"}}),
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
)
Source code in prefect_kubernetes/jobs.py
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 |
|
delete_namespaced_job
async
¶
Task for deleting a namespaced Kubernetes job.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
job_name |
str
|
The name of a job to delete. |
required |
delete_options |
Optional[V1DeleteOptions]
|
A Kubernetes |
None
|
namespace |
Optional[str]
|
The Kubernetes namespace to delete this job in. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Returns:
Type | Description |
---|---|
V1Status
|
A Kubernetes |
Example
Delete "my-job" in the default namespace:
from kubernetes_asyncio.client.models import V1DeleteOptions
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.jobs import delete_namespaced_job
@flow
def kubernetes_orchestrator():
v1_job_status = delete_namespaced_job(
job_name="my-job",
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
delete_options=V1DeleteOptions(propagation_policy="Foreground"),
)
Source code in prefect_kubernetes/jobs.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 115 116 117 118 119 120 121 |
|
list_namespaced_job
async
¶
Task for listing namespaced Kubernetes jobs.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
namespace |
Optional[str]
|
The Kubernetes namespace to list jobs from. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Returns:
Type | Description |
---|---|
V1JobList
|
A Kubernetes |
Example
List jobs in "my-namespace":
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.jobs import list_namespaced_job
@flow
def kubernetes_orchestrator():
namespaced_job_list = list_namespaced_job(
namespace="my-namespace",
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
)
Source code in prefect_kubernetes/jobs.py
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 |
|
patch_namespaced_job
async
¶
Task for patching a namespaced Kubernetes job.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
KubernetesCredentials block holding authentication needed to generate the required API client. |
required |
job_name |
str
|
The name of a job to patch. |
required |
job_updates |
V1Job
|
A Kubernetes |
required |
namespace |
Optional[str]
|
The Kubernetes namespace to patch this job in. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Raises:
Type | Description |
---|---|
ValueError
|
if |
Returns:
Type | Description |
---|---|
V1Job
|
A Kubernetes |
Example
Patch "my-job" in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.jobs import patch_namespaced_job
from kubernetes_asyncio.client.models import V1Job
@flow
def kubernetes_orchestrator():
v1_job_metadata = patch_namespaced_job(
job_name="my-job",
job_updates=V1Job(metadata={"labels": {"foo": "bar"}}}),
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
)
Source code in prefect_kubernetes/jobs.py
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 |
|
read_namespaced_job
async
¶
Task for reading a namespaced Kubernetes job.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
job_name |
str
|
The name of a job to read. |
required |
namespace |
Optional[str]
|
The Kubernetes namespace to read this job in. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Raises:
Type | Description |
---|---|
ValueError
|
if |
Returns:
Type | Description |
---|---|
V1Job
|
A Kubernetes |
Example
Read "my-job" in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.jobs import read_namespaced_job
@flow
def kubernetes_orchestrator():
v1_job_metadata = read_namespaced_job(
job_name="my-job",
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
)
Source code in prefect_kubernetes/jobs.py
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 |
|
read_namespaced_job_status
async
¶
Task for fetching status of a namespaced Kubernetes job.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
job_name |
str
|
The name of a job to fetch status for. |
required |
namespace |
Optional[str]
|
The Kubernetes namespace to fetch status of job in. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Returns:
Type | Description |
---|---|
V1Job
|
A Kubernetes |
Example
Fetch status of a job in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.jobs import read_namespaced_job_status
@flow
def kubernetes_orchestrator():
v1_job_status = read_namespaced_job_status(
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
job_name="my-job",
)
Source code in prefect_kubernetes/jobs.py
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 |
|
replace_namespaced_job
async
¶
Task for replacing a namespaced Kubernetes job.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
job_name |
str
|
The name of a job to replace. |
required |
new_job |
V1Job
|
A Kubernetes |
required |
namespace |
Optional[str]
|
The Kubernetes namespace to replace this job in. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Returns:
Type | Description |
---|---|
V1Job
|
A Kubernetes |
Example
Replace "my-job" in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.jobs import replace_namespaced_job
@flow
def kubernetes_orchestrator():
v1_job_metadata = replace_namespaced_job(
new_job=V1Job(metadata={"labels": {"foo": "bar"}}),
job_name="my-job",
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
)
Source code in prefect_kubernetes/jobs.py
263 264 265 266 267 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 |
|