prefect_gcp.workers.cloud_run
¶
Module containing the Cloud Run worker used for executing flow runs as Cloud Run jobs.
Get started by creating a Cloud Run work pool:
prefect work-pool create 'my-cloud-run-pool' --type cloud-run
Then start a Cloud Run worker with the following command:
prefect worker start --pool 'my-cloud-run-pool'
Configuration¶
Read more about configuring work pools here.
Advanced Configuration¶
Using a custom Cloud Run job template
Below is the default job body template used by the Cloud Run Worker:
{
"apiVersion": "run.googleapis.com/v1",
"kind": "Job",
"metadata":
{
"name": "{{ name }}",
"annotations":
{
"run.googleapis.com/launch-stage": "BETA",
}
},
"spec":
{
"template":
{
"spec":
{
"template":
{
"spec":
{
"containers":
[
{
"image": "{{ image }}",
"args": "{{ args }}",
"resources":
{
"limits":
{
"cpu": "{{ cpu }}",
"memory": "{{ memory }}"
},
"requests":
{
"cpu": "{{ cpu }}",
"memory": "{{ memory }}"
}
}
}
],
"timeoutSeconds": "{{ timeout }}",
"serviceAccountName": "{{ service_account_name }}"
}
}
}
}
},
"metadata":
{
"annotations":
{
"run.googleapis.com/vpc-access-connector": "{{ vpc_connector_name }}"
}
}
},
},
"keep_job": "{{ keep_job }}"
}
{{ }}
is a placeholder that will be replaced with
a value at runtime on a per-deployment basis. The values that can be used a
placeholders are defined by the variables
schema defined in the base job template.
The default job body template and available variables can be customized on a work pool by work pool basis. By editing the default job body template you can:
- Add additional placeholders to the default job template
- Remove placeholders from the default job template
- Pass values to Cloud Run that are not defined in the
variables
schema
Adding additional placeholders¶
For example, to allow for extra customization of a new annotation not described in the default job template, you can add the following:
{
"apiVersion": "run.googleapis.com/v1",
"kind": "Job",
"metadata":
{
"name": "{{ name }}",
"annotations":
{
"run.googleapis.com/my-custom-annotation": "{{ my_custom_annotation }}",
"run.googleapis.com/launch-stage": "BETA",
},
...
},
...
}
my_custom_annotation
can now be used as a placeholder in the job template and set
on a per-deployment basis.
# deployment.yaml
...
infra_overrides: {"my_custom_annotation": "my-custom-value"}
Additionally, fields can be set to prevent configuration at the deployment
level. For example to configure the vpc_connector_name
field, the placeholder can
be removed and replaced with an actual value. Now all deployments that point to this
work pool will use the same vpc_connector_name
value.
{
"apiVersion": "run.googleapis.com/v1",
"kind": "Job",
"spec":
{
"template":
{
"metadata":
{
"annotations":
{
"run.googleapis.com/vpc-access-connector": "my-vpc-connector"
}
},
...
},
...
}
}
CloudRunWorker
¶
Bases: BaseWorker
Prefect worker that executes flow runs within Cloud Run Jobs.
Source code in prefect_gcp/workers/cloud_run.py
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 |
|
kill_infrastructure
async
¶
Stops a job for a cancelled flow run based on the provided infrastructure PID and run configuration.
Source code in prefect_gcp/workers/cloud_run.py
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 |
|
run
async
¶
Executes a flow run within a Cloud Run Job and waits for the flow run to complete.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
flow_run |
FlowRun
|
The flow run to execute |
required |
configuration |
CloudRunWorkerJobConfiguration
|
The configuration to use when executing the flow run. |
required |
task_status |
Optional[TaskStatus]
|
The task status object for the current flow run. If provided, the task will be marked as started. |
None
|
Returns:
Name | Type | Description |
---|---|---|
CloudRunWorkerResult |
CloudRunWorkerResult
|
A result object containing information about the final state of the flow run |
Source code in prefect_gcp/workers/cloud_run.py
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 |
|
CloudRunWorkerJobConfiguration
¶
Bases: BaseJobConfiguration
Configuration class used by the Cloud Run Worker to create a Cloud Run Job.
An instance of this class is passed to the Cloud Run worker's run
method
for each flow run. It contains all information necessary to execute
the flow run as a Cloud Run Job.
Attributes:
Name | Type | Description |
---|---|---|
region |
str
|
The region where the Cloud Run Job resides. |
credentials |
Optional[GcpCredentials]
|
The GCP Credentials used to connect to Cloud Run. |
job_body |
Dict[str, Any]
|
The job body used to create the Cloud Run Job. |
timeout |
Optional[int]
|
Max allowed duration the job may be active before Cloud Run will actively try to mark it failed and kill associated containers (maximum of 3600 seconds, 1 hour). |
keep_job |
Optional[bool]
|
Whether to delete the Cloud Run Job after it completes. |
Source code in prefect_gcp/workers/cloud_run.py
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 |
|
job_name: str
property
¶
property for accessing the name from the job metadata.
project: str
property
¶
property for accessing the project from the credentials.
prepare_for_flow_run
¶
Prepares the job configuration for a flow run.
Ensures that necessary values are present in the job body and that the job body is valid.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
flow_run |
FlowRun
|
The flow run to prepare the job configuration for |
required |
deployment |
Optional[DeploymentResponse]
|
The deployment associated with the flow run used for preparation. |
None
|
flow |
Optional[Flow]
|
The flow associated with the flow run used for preparation. |
None
|
Source code in prefect_gcp/workers/cloud_run.py
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 |
|
CloudRunWorkerResult
¶
Bases: BaseWorkerResult
Contains information about the final state of a completed process
Source code in prefect_gcp/workers/cloud_run.py
529 530 |
|
CloudRunWorkerVariables
¶
Bases: BaseVariables
Default variables for the Cloud Run worker.
The schema for this class is used to populate the variables
section of the default
base job template.
Source code in prefect_gcp/workers/cloud_run.py
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 |
|