prefect.deployments.deployments
¶
Objects for specifying deployments and utilities for loading flows from deployments.
Deployment
¶
Bases: DeprecatedInfraOverridesField
, BaseModel
DEPRECATION WARNING:
This class is deprecated as of March 2024 and will not be available after September 2024.
It has been replaced by flow.deploy
, which offers enhanced functionality and better a better user experience.
For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.
A Prefect Deployment definition, used for specifying and building deployments.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
A name for the deployment (required). |
required | |
version |
An optional version for the deployment; defaults to the flow's version |
required | |
description |
An optional description of the deployment; defaults to the flow's description |
required | |
tags |
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 |
required | |
schedule |
A schedule to run this deployment on, once registered (deprecated) |
required | |
is_schedule_active |
Whether or not the schedule is active (deprecated) |
required | |
schedules |
A list of schedules to run this deployment on |
required | |
work_queue_name |
The work queue that will handle this deployment's runs |
required | |
work_pool_name |
The work pool for the deployment |
required | |
flow_name |
The name of the flow this deployment encapsulates |
required | |
parameters |
A dictionary of parameter values to pass to runs created from this deployment |
required | |
infrastructure |
An optional infrastructure block used to configure infrastructure for runs; if not provided, will default to running this deployment in Agent subprocesses |
required | |
job_variables |
A dictionary of dot delimited infrastructure overrides that
will be applied at runtime; for example |
required | |
storage |
An optional remote storage block used to store and retrieve this workflow; if not provided, will default to referencing this flow by its local path |
required | |
path |
The path to the working directory for the workflow, relative to remote storage or, if stored on a local filesystem, an absolute path |
required | |
entrypoint |
The path to the entrypoint for the workflow, always relative to the
|
required | |
parameter_openapi_schema |
The parameter schema of the flow, including defaults. |
required | |
enforce_parameter_schema |
Whether or not the Prefect API should enforce the parameter schema for this deployment. |
required |
Create a new deployment using configuration defaults for an imported flow:
>>> from my_project.flows import my_flow
>>> from prefect.deployments import Deployment
>>>
>>> deployment = Deployment.build_from_flow(
... flow=my_flow,
... name="example",
... version="1",
... tags=["demo"],
>>> )
>>> deployment.apply()
Create a new deployment with custom storage and an infrastructure override:
>>> from my_project.flows import my_flow
>>> from prefect.deployments import Deployment
>>> from prefect.filesystems import S3
>>> storage = S3.load("dev-bucket") # load a pre-defined block
>>> deployment = Deployment.build_from_flow(
... flow=my_flow,
... name="s3-example",
... version="2",
... tags=["aws"],
... storage=storage,
... job_variables=dict("env.PREFECT_LOGGING_LEVEL"="DEBUG"),
>>> )
>>> deployment.apply()
Source code in prefect/deployments/deployments.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 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 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 |
|
location: str
property
¶
The 'location' that this deployment points to is given by path
alone
in the case of no remote storage, and otherwise by storage.basepath / path
.
The underlying flow entrypoint is interpreted relative to this location.
apply
async
¶
Registers this deployment with the API and returns the deployment's ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
upload |
bool
|
if True, deployment files are automatically uploaded to remote storage |
False
|
work_queue_concurrency |
int
|
If provided, sets the concurrency limit on the deployment's work queue |
None
|
Source code in prefect/deployments/deployments.py
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 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 |
|
build_from_flow
async
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 |
output |
optional
|
if provided, the full deployment specification will be
written as a YAML file in the location specified by |
None
|
skip_upload |
bool
|
if True, deployment files are not automatically uploaded to remote storage |
False
|
ignore_file |
str
|
an optional path to a |
'.prefectignore'
|
apply |
bool
|
if True, the deployment is automatically registered with the API |
False
|
load_existing |
bool
|
if True, load any settings that may already be configured for the named deployment server-side (e.g., schedules, default parameter values, etc.) |
True
|
schedules |
Optional[FlexibleScheduleList]
|
An optional list of schedules. Each item in the list can be:
- An instance of |
None
|
**kwargs |
other keyword arguments to pass to the constructor for the
|
{}
|
Source code in prefect/deployments/deployments.py
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 |
|
load
async
¶
Queries the API for a deployment with this name for this flow, and if found, prepopulates any settings that were not set at initialization.
Returns a boolean specifying whether a load was successful or not.
Raises:
Type | Description |
---|---|
-ValueError
|
if both name and flow name are not set |
Source code in prefect/deployments/deployments.py
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 |
|
update
async
¶
Performs an in-place update with the provided settings.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ignore_none |
bool
|
if True, all |
False
|
Source code in prefect/deployments/deployments.py
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 |
|
upload_to_storage
async
¶
Uploads the workflow this deployment represents using a provided storage block; if no block is provided, defaults to configuring self for local storage.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
storage_block |
str
|
a string reference a remote storage block slug |
None
|
ignore_file |
str
|
an optional path to a |
'.prefectignore'
|
Source code in prefect/deployments/deployments.py
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 |
|
load_deployments_from_yaml
¶
Load deployments from a yaml file.
Source code in prefect/deployments/deployments.py
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
|
load_flow_from_flow_run
async
¶
Load a flow from the location/script provided in a deployment's storage document.
If ignore_storage=True
is provided, no pull from remote storage occurs. This flag
is largely for testing, and assumes the flow is already available locally.
Source code in prefect/deployments/deployments.py
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 |
|
run_deployment
async
¶
Create a flow run for a deployment and return it after completion or a timeout.
By default, this function blocks until the flow run finishes executing.
Specify a timeout (in seconds) to wait for the flow run to execute before
returning flow run metadata. To return immediately, without waiting for the
flow run to execute, set timeout=0
.
Note that if you specify a timeout, this function will return the flow run metadata whether or not the flow run finished executing.
If called within a flow or task, the flow run this function creates will
be linked to the current flow run as a subflow. Disable this behavior by
passing as_subflow=False
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
Union[str, UUID]
|
The deployment id or deployment name in the form:
|
required |
parameters |
Optional[dict]
|
Parameter overrides for this flow run. Merged with the deployment defaults. |
None
|
scheduled_time |
Optional[datetime]
|
The time to schedule the flow run for, defaults to scheduling the flow run to start now. |
None
|
flow_run_name |
Optional[str]
|
A name for the created flow run |
None
|
timeout |
Optional[float]
|
The amount of time to wait (in seconds) for the flow run to
complete before returning. Setting |
None
|
poll_interval |
Optional[float]
|
The number of seconds between polls |
5
|
tags |
Optional[Iterable[str]]
|
A list of tags to associate with this flow run; tags can be used in automations and for organizational purposes. |
None
|
idempotency_key |
Optional[str]
|
A unique value to recognize retries of the same run, and prevent creating multiple flow runs. |
None
|
work_queue_name |
Optional[str]
|
The name of a work queue to use for this run. Defaults to the default work queue for the deployment. |
None
|
as_subflow |
Optional[bool]
|
Whether to link the flow run as a subflow of the current flow or task run. |
True
|
job_variables |
Optional[dict]
|
A dictionary of dot delimited infrastructure overrides that
will be applied at runtime; for example |
None
|
Source code in prefect/deployments/deployments.py
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 |
|