prefect.infrastructure
¶
DockerContainer
¶
Bases: Infrastructure
Runs a command in a container.
Requires a Docker Engine to be connectable. Docker settings will be retrieved from the environment.
Click here to see a tutorial.
Attributes:
Name | Type | Description |
---|---|---|
auto_remove |
bool
|
If set, the container will be removed on completion. Otherwise, the container will remain after exit for inspection. |
command |
bool
|
A list of strings specifying the command to run in the container to start the flow run. In most cases you should not override this. |
env |
bool
|
Environment variables to set for the container. |
image |
str
|
An optional string specifying the tag of a Docker image to use. Defaults to the Prefect image. |
image_pull_policy |
Optional[ImagePullPolicy]
|
Specifies if the image should be pulled. One of 'ALWAYS', 'NEVER', 'IF_NOT_PRESENT'. |
image_registry |
Optional[DockerRegistry]
|
A |
labels |
Optional[DockerRegistry]
|
An optional dictionary of labels, mapping name to value. |
name |
Optional[DockerRegistry]
|
An optional name for the container. |
network_mode |
Optional[str]
|
Set the network mode for the created container. Defaults to 'host' if a local API url is detected, otherwise the Docker default of 'bridge' is used. If 'networks' is set, this cannot be set. |
networks |
List[str]
|
An optional list of strings specifying Docker networks to connect the container to. |
stream_output |
bool
|
If set, stream output from the container to local standard output. |
volumes |
List[str]
|
An optional list of volume mount strings in the format of "local_path:container_path". |
memswap_limit |
Union[int, str]
|
Total memory (memory + swap), -1 to disable swap. Should only be
set if |
mem_limit |
Union[float, str]
|
Memory limit of the created container. Accepts float values to enforce a limit in bytes or a string with a unit e.g. 100000b, 1000k, 128m, 1g. If a string is given without a unit, bytes are assumed. |
privileged |
bool
|
Give extended privileges to this container. |
Connecting to a locally hosted Prefect API¶
If using a local API URL on Linux, we will update the network mode default to 'host' to enable connectivity. If using another OS or an alternative network mode is used, we will replace 'localhost' in the API URL with 'host.docker.internal'. Generally, this will enable connectivity, but the API URL can be provided as an environment variable to override inference in more complex use-cases.
Note, if using 'host.docker.internal' in the API URL on Linux, the API must be bound to 0.0.0.0 or the Docker IP address to allow connectivity. On macOS, this is not necessary and the API is connectable while bound to localhost.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/container.py
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 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 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 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 496 497 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 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 |
|
DockerContainerResult
¶
Bases: InfrastructureResult
Contains information about a completed Docker container
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/container.py
161 162 |
|
Infrastructure
¶
Bases: Block
, ABC
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/base.py
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 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 |
|
prepare_for_flow_run
¶
Return an infrastructure block that is prepared to execute a flow run.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/base.py
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 |
|
preview
abstractmethod
¶
View a preview of the infrastructure that would be run.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/base.py
69 70 71 72 73 |
|
run
abstractmethod
async
¶
Run the infrastructure.
If provided a task_status
, the status will be reported as started when the
infrastructure is successfully created. The status return value will be an
identifier for the infrastructure.
The call will then monitor the created infrastructure, returning a result at the end containing a status code indicating if the infrastructure exited cleanly or encountered an error.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/base.py
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
|
KubernetesClusterConfig
¶
Bases: Block
Stores configuration for interaction with Kubernetes clusters.
See from_file
for creation.
Attributes:
Name | Type | Description |
---|---|---|
config |
Dict
|
The entire loaded YAML contents of a kubectl config file |
context_name |
str
|
The name of the kubectl context to use |
Example
Load a saved Kubernetes cluster config:
from prefect.blocks.kubernetes import KubernetesClusterConfig
cluster_config_block = KubernetesClusterConfig.load("BLOCK_NAME")
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/blocks/kubernetes.py
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 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
|
configure_client
¶
Activates this cluster configuration by loading the configuration into the Kubernetes Python client. After calling this, Kubernetes API clients can use this config's context.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/blocks/kubernetes.py
100 101 102 103 104 105 106 107 108 |
|
from_file
classmethod
¶
Create a cluster config from the a Kubernetes config file.
By default, the current context in the default Kubernetes config file will be used.
An alternative file or context may be specified.
The entire config file will be loaded and stored.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/blocks/kubernetes.py
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 86 87 88 89 90 |
|
get_api_client
¶
Returns a Kubernetes API client for this cluster config.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/blocks/kubernetes.py
92 93 94 95 96 97 98 |
|
KubernetesJob
¶
Bases: Infrastructure
Runs a command as a Kubernetes Job.
For a guided tutorial, see How to use Kubernetes with Prefect.
For more information, including examples for customizing the resulting manifest, see KubernetesJob
infrastructure concepts.
Attributes:
Name | Type | Description |
---|---|---|
cluster_config |
Optional[KubernetesClusterConfig]
|
An optional Kubernetes cluster config to use for this job. |
command |
Optional[KubernetesClusterConfig]
|
A list of strings specifying the command to run in the container to start the flow run. In most cases you should not override this. |
customizations |
JsonPatch
|
A list of JSON 6902 patches to apply to the base Job manifest. |
env |
JsonPatch
|
Environment variables to set for the container. |
finished_job_ttl |
Optional[int]
|
The number of seconds to retain jobs after completion. If set, finished jobs will be cleaned up by Kubernetes after the given delay. If None (default), jobs will need to be manually removed. |
image |
Optional[str]
|
An optional string specifying the image reference of a container image to use for the job, for example, docker.io/prefecthq/prefect:2-latest. The behavior is as described in https://kubernetes.io/docs/concepts/containers/images/#image-names. Defaults to the Prefect image. |
image_pull_policy |
Optional[KubernetesImagePullPolicy]
|
The Kubernetes image pull policy to use for job containers. |
job |
KubernetesManifest
|
The base manifest for the Kubernetes Job. |
job_watch_timeout_seconds |
Optional[int]
|
Number of seconds to wait for the job to complete
before marking it as crashed. Defaults to |
labels |
Optional[int]
|
An optional dictionary of labels to add to the job. |
name |
Optional[int]
|
An optional name for the job. |
namespace |
Optional[str]
|
An optional string signifying the Kubernetes namespace to use. |
pod_watch_timeout_seconds |
int
|
Number of seconds to watch for pod creation before timing out (default 60). |
service_account_name |
Optional[str]
|
An optional string specifying which Kubernetes service account to use. |
stream_output |
bool
|
If set, stream output from the job to local standard output. |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/kubernetes.py
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 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 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 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 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 496 497 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 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 |
|
base_job_manifest
classmethod
¶
Produces the bare minimum allowed Job manifest
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/kubernetes.py
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
|
build_job
¶
Builds the Kubernetes Job Manifest
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/kubernetes.py
355 356 357 358 359 360 |
|
customize_from_file
classmethod
¶
Load an RFC 6902 JSON patch from a YAML or JSON file.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/kubernetes.py
284 285 286 287 288 |
|
job_from_file
classmethod
¶
Load a Kubernetes Job manifest from a YAML or JSON file.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/kubernetes.py
278 279 280 281 282 |
|
KubernetesJobResult
¶
Bases: InfrastructureResult
Contains information about the final state of a completed Kubernetes Job
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/kubernetes.py
49 50 |
|
Process
¶
Bases: Infrastructure
Run a command in a new process.
Current environment variables and Prefect settings will be included in the created process. Configured environment variables will override any current environment variables.
Attributes:
Name | Type | Description |
---|---|---|
command |
A list of strings specifying the command to run in the container to start the flow run. In most cases you should not override this. |
|
env |
Environment variables to set for the new process. |
|
labels |
Labels for the process. Labels are for metadata purposes only and cannot be attached to the process itself. |
|
name |
A name for the process. For display purposes only. |
|
stream_output |
bool
|
Whether to stream output to local stdout. |
working_dir |
Union[str, Path, None]
|
Working directory where the process should be opened. If not set, a tmp directory will be used. |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/process.py
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 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 |
|
ProcessResult
¶
Bases: InfrastructureResult
Contains information about the final state of a completed process
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/infrastructure/process.py
244 245 |
|