prefect.deployments.runner
¶
Objects for creating and configuring deployments for flows using serve
functionality.
Example
import time
from prefect import flow, serve
@flow
def slow_flow(sleep: int = 60):
"Sleepy flow - sleeps the provided amount of time (in seconds)."
time.sleep(sleep)
@flow
def fast_flow():
"Fastest flow this side of the Mississippi."
return
if __name__ == "__main__":
# to_deployment creates RunnerDeployment instances
slow_deploy = slow_flow.to_deployment(name="sleeper", interval=45)
fast_deploy = fast_flow.to_deployment(name="fast")
serve(slow_deploy, fast_deploy)
DeploymentApplyError
¶
Bases: RuntimeError
Raised when an error occurs while applying a deployment.
Source code in prefect/deployments/runner.py
98 99 100 101 |
|
DeploymentImage
¶
Configuration used to build and push a Docker image for a deployment.
Attributes:
Name | Type | Description |
---|---|---|
name |
The name of the Docker image to build, including the registry and repository. |
|
tag |
The tag to apply to the built image. |
|
dockerfile |
The path to the Dockerfile to use for building the image. If not provided, a default Dockerfile will be generated. |
|
**build_kwargs |
Additional keyword arguments to pass to the Docker build request.
See the |
Source code in prefect/deployments/runner.py
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 |
|
EntrypointType
¶
Bases: Enum
Enum representing a entrypoint type.
File path entrypoints are in the format: path/to/file.py:function_name
.
Module path entrypoints are in the format: path.to.module.function_name
.
Source code in prefect/deployments/runner.py
104 105 106 107 108 109 110 111 112 113 |
|
RunnerDeployment
¶
Bases: BaseModel
A Prefect RunnerDeployment definition, used for specifying and building deployments.
Attributes:
Name | Type | Description |
---|---|---|
name |
str
|
A name for the deployment (required). |
version |
Optional[str]
|
An optional version for the deployment; defaults to the flow's version |
description |
Optional[str]
|
An optional description of the deployment; defaults to the flow's description |
tags |
List[str]
|
An optional list of tags to associate with this deployment; note that tags
are used only for organizational purposes. For delegating work to agents,
see |
schedule |
Optional[SCHEDULE_TYPES]
|
A schedule to run this deployment on, once registered |
is_schedule_active |
Optional[bool]
|
Whether or not the schedule is active |
parameters |
Dict[str, Any]
|
A dictionary of parameter values to pass to runs created from this deployment |
path |
Dict[str, Any]
|
The path to the working directory for the workflow, relative to remote storage or, if stored on a local filesystem, an absolute path |
entrypoint |
Optional[str]
|
The path to the entrypoint for the workflow, always relative to the
|
parameter_openapi_schema |
Optional[str]
|
The parameter schema of the flow, including defaults. |
enforce_parameter_schema |
bool
|
Whether or not the Prefect API should enforce the parameter schema for this deployment. |
work_pool_name |
Optional[str]
|
The name of the work pool to use for this deployment. |
work_queue_name |
Optional[str]
|
The name of the work queue to use for this deployment's scheduled runs. If not provided the default work queue for the work pool will be used. |
job_variables |
Dict[str, Any]
|
Settings used to override the values specified default base job template of the chosen work pool. Refer to the base job template of the chosen work pool for available settings. |
Source code in prefect/deployments/runner.py
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 |
|
apply
async
¶
Registers this deployment with the API and returns the deployment's ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
work_pool_name |
Optional[str]
|
The name of the work pool to use for this deployment. |
None
|
image |
Optional[str]
|
The registry, name, and tag of the Docker image to use for this deployment. Only used when the deployment is deployed to a work pool. |
None
|
Returns:
Type | Description |
---|---|
UUID
|
The ID of the created deployment. |
Source code in prefect/deployments/runner.py
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 |
|
from_entrypoint
classmethod
¶
Configure a deployment for a given flow located at a given entrypoint.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
entrypoint |
str
|
The path to a file containing a flow and the name of the flow function in
the format |
required |
name |
str
|
A name for the deployment |
required |
flow_name |
Optional[str]
|
The name of the flow to deploy |
None
|
interval |
Optional[Union[Iterable[Union[int, float, timedelta]], int, float, timedelta]]
|
An interval on which to execute the current flow. Accepts either a number or a timedelta object. If a number is given, it will be interpreted as seconds. |
None
|
cron |
Optional[Union[Iterable[str], str]]
|
A cron schedule of when to execute runs of this flow. |
None
|
rrule |
Optional[Union[Iterable[str], str]]
|
An rrule schedule of when to execute runs of this flow. |
None
|
paused |
Optional[bool]
|
Whether or not to set this deployment as paused. |
None
|
schedules |
Optional[FlexibleScheduleList]
|
A list of schedule objects defining when to execute runs of this deployment.
Used to define multiple schedules or additional scheduling options like |
None
|
schedule |
Optional[SCHEDULE_TYPES]
|
A schedule object of when to execute runs of this flow. Used for advanced scheduling options like timezone. |
None
|
is_schedule_active |
Optional[bool]
|
Whether or not to set the schedule for this deployment as active. If not provided when creating a deployment, the schedule will be set as active. If not provided when updating a deployment, the schedule's activation will not be changed. |
None
|
triggers |
Optional[List[Union[DeploymentTriggerTypes, TriggerTypes]]]
|
A list of triggers that should kick of a run of this flow. |
None
|
parameters |
Optional[dict]
|
A dictionary of default parameter values to pass to runs of this flow. |
None
|
description |
Optional[str]
|
A description for the created deployment. Defaults to the flow's description if not provided. |
None
|
tags |
Optional[List[str]]
|
A list of tags to associate with the created deployment for organizational purposes. |
None
|
version |
Optional[str]
|
A version for the created deployment. Defaults to the flow's version. |
None
|
enforce_parameter_schema |
bool
|
Whether or not the Prefect API should enforce the parameter schema for this deployment. |
False
|
work_pool_name |
Optional[str]
|
The name of the work pool to use for this deployment. |
None
|
work_queue_name |
Optional[str]
|
The name of the work queue to use for this deployment's scheduled runs. If not provided the default work queue for the work pool will be used. |
None
|
job_variables |
Optional[Dict[str, Any]]
|
Settings used to override the values specified default base job template of the chosen work pool. Refer to the base job template of the chosen work pool for available settings. |
None
|
Source code in prefect/deployments/runner.py
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 |
|
from_flow
classmethod
¶
Configure a deployment for a given flow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
flow |
Flow
|
A flow function to deploy |
required |
name |
str
|
A name for the deployment |
required |
interval |
Optional[Union[Iterable[Union[int, float, timedelta]], int, float, timedelta]]
|
An interval on which to execute the current flow. Accepts either a number or a timedelta object. If a number is given, it will be interpreted as seconds. |
None
|
cron |
Optional[Union[Iterable[str], str]]
|
A cron schedule of when to execute runs of this flow. |
None
|
rrule |
Optional[Union[Iterable[str], str]]
|
An rrule schedule of when to execute runs of this flow. |
None
|
paused |
Optional[bool]
|
Whether or not to set this deployment as paused. |
None
|
schedules |
Optional[FlexibleScheduleList]
|
A list of schedule objects defining when to execute runs of this deployment.
Used to define multiple schedules or additional scheduling options like |
None
|
schedule |
Optional[SCHEDULE_TYPES]
|
A schedule object of when to execute runs of this flow. Used for advanced scheduling options like timezone. |
None
|
is_schedule_active |
Optional[bool]
|
Whether or not to set the schedule for this deployment as active. If not provided when creating a deployment, the schedule will be set as active. If not provided when updating a deployment, the schedule's activation will not be changed. |
None
|
triggers |
Optional[List[Union[DeploymentTriggerTypes, TriggerTypes]]]
|
A list of triggers that should kick of a run of this flow. |
None
|
parameters |
Optional[dict]
|
A dictionary of default parameter values to pass to runs of this flow. |
None
|
description |
Optional[str]
|
A description for the created deployment. Defaults to the flow's description if not provided. |
None
|
tags |
Optional[List[str]]
|
A list of tags to associate with the created deployment for organizational purposes. |
None
|
version |
Optional[str]
|
A version for the created deployment. Defaults to the flow's version. |
None
|
enforce_parameter_schema |
bool
|
Whether or not the Prefect API should enforce the parameter schema for this deployment. |
False
|
work_pool_name |
Optional[str]
|
The name of the work pool to use for this deployment. |
None
|
work_queue_name |
Optional[str]
|
The name of the work queue to use for this deployment's scheduled runs. If not provided the default work queue for the work pool will be used. |
None
|
job_variables |
Optional[Dict[str, Any]]
|
Settings used to override the values specified default base job template of the chosen work pool. Refer to the base job template of the chosen work pool for available settings. |
None
|
Source code in prefect/deployments/runner.py
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 |
|
from_storage
async
classmethod
¶
Create a RunnerDeployment from a flow located at a given entrypoint and stored in a local storage location.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
entrypoint |
str
|
The path to a file containing a flow and the name of the flow function in
the format |
required |
name |
str
|
A name for the deployment |
required |
flow_name |
Optional[str]
|
The name of the flow to deploy |
None
|
storage |
RunnerStorage
|
A storage object to use for retrieving flow code. If not provided, a URL must be provided. |
required |
interval |
Optional[Union[Iterable[Union[int, float, timedelta]], int, float, timedelta]]
|
An interval on which to execute the current flow. Accepts either a number or a timedelta object. If a number is given, it will be interpreted as seconds. |
None
|
cron |
Optional[Union[Iterable[str], str]]
|
A cron schedule of when to execute runs of this flow. |
None
|
rrule |
Optional[Union[Iterable[str], str]]
|
An rrule schedule of when to execute runs of this flow. |
None
|
schedule |
Optional[SCHEDULE_TYPES]
|
A schedule object of when to execute runs of this flow. Used for advanced scheduling options like timezone. |
None
|
is_schedule_active |
Optional[bool]
|
Whether or not to set the schedule for this deployment as active. If not provided when creating a deployment, the schedule will be set as active. If not provided when updating a deployment, the schedule's activation will not be changed. |
None
|
triggers |
Optional[List[Union[DeploymentTriggerTypes, TriggerTypes]]]
|
A list of triggers that should kick of a run of this flow. |
None
|
parameters |
Optional[dict]
|
A dictionary of default parameter values to pass to runs of this flow. |
None
|
description |
Optional[str]
|
A description for the created deployment. Defaults to the flow's description if not provided. |
None
|
tags |
Optional[List[str]]
|
A list of tags to associate with the created deployment for organizational purposes. |
None
|
version |
Optional[str]
|
A version for the created deployment. Defaults to the flow's version. |
None
|
enforce_parameter_schema |
bool
|
Whether or not the Prefect API should enforce the parameter schema for this deployment. |
False
|
work_pool_name |
Optional[str]
|
The name of the work pool to use for this deployment. |
None
|
work_queue_name |
Optional[str]
|
The name of the work queue to use for this deployment's scheduled runs. If not provided the default work queue for the work pool will be used. |
None
|
job_variables |
Optional[Dict[str, Any]]
|
Settings used to override the values specified default base job template of the chosen work pool. Refer to the base job template of the chosen work pool for available settings. |
None
|
Source code in prefect/deployments/runner.py
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 |
|
validate_automation_names
¶
Ensure that each trigger has a name for its automation if none is provided.
Source code in prefect/deployments/runner.py
235 236 237 238 |
|
deploy
async
¶
Deploy the provided list of deployments to dynamic infrastructure via a work pool.
By default, calling this function will build a Docker image for the deployments, push it to a registry, and create each deployment via the Prefect API that will run the corresponding flow on the given schedule.
If you want to use an existing image, you can pass build=False
to skip building and pushing
an image.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
*deployments |
RunnerDeployment
|
A list of deployments to deploy. |
()
|
work_pool_name |
Optional[str]
|
The name of the work pool to use for these deployments. Defaults to
the value of |
None
|
image |
Optional[Union[str, DeploymentImage]]
|
The name of the Docker image to build, including the registry and repository. Pass a DeploymentImage instance to customize the Dockerfile used and build arguments. |
None
|
build |
bool
|
Whether or not to build a new image for the flow. If False, the provided image will be used as-is and pulled at runtime. |
True
|
push |
bool
|
Whether or not to skip pushing the built image to a registry. |
True
|
print_next_steps_message |
bool
|
Whether or not to print a message with next steps after deploying the deployments. |
True
|
Returns:
Type | Description |
---|---|
List[UUID]
|
A list of deployment IDs for the created/updated deployments. |
Examples:
Deploy a group of flows to a work pool:
from prefect import deploy, flow
@flow(log_prints=True)
def local_flow():
print("I'm a locally defined flow!")
if __name__ == "__main__":
deploy(
local_flow.to_deployment(name="example-deploy-local-flow"),
flow.from_source(
source="https://github.com/org/repo.git",
entrypoint="flows.py:my_flow",
).to_deployment(
name="example-deploy-remote-flow",
),
work_pool_name="my-work-pool",
image="my-registry/my-image:dev",
)
Source code in prefect/deployments/runner.py
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 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 |
|