Skip to content

on_boarding.md

Latest commit

 

History

History
34 lines (28 loc) · 3.33 KB

on_boarding.md

File metadata and controls

34 lines (28 loc) · 3.33 KB
graph LR
    Cloud_Run_Job_Manager["Cloud Run Job Manager"]
    Region_Selector["Region Selector"]
    Workflow_Orchestrator["Workflow Orchestrator"]
    Utility_Functions["Utility Functions"]
    Workflow_Orchestrator -- "manages" --> Cloud_Run_Job_Manager
    Workflow_Orchestrator -- "selects region using" --> Region_Selector
    Cloud_Run_Job_Manager -- "uses" --> Utility_Functions
    click Cloud_Run_Job_Manager href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/VertFlow/Cloud Run Job Manager.md" "Details"
    click Region_Selector href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/VertFlow/Region Selector.md" "Details"
    click Workflow_Orchestrator href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/VertFlow/Workflow Orchestrator.md" "Details"
    click Utility_Functions href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/VertFlow/Utility Functions.md" "Details"
Loading

Component Details

VertFlow orchestrates cloud workflows by managing Cloud Run jobs across different regions, optimizing for factors like proximity and environmental impact. The core flow involves the Workflow Orchestrator receiving a task, selecting an appropriate region using the Region Selector, and then delegating the job's lifecycle management to the Cloud Run Job Manager. Utility functions provide supporting capabilities throughout this process, ensuring efficient and reliable workflow execution.

Cloud Run Job Manager

The Cloud Run Job Manager is responsible for the lifecycle management of Cloud Run jobs. It handles the creation, execution, deletion, and status checking of these jobs, interacting directly with the Cloud Run service. This component abstracts away the complexities of managing individual Cloud Run instances.

  • Related Classes/Methods: VertFlow.src.cloud_run.CloudRunJob:delete, VertFlow.src.cloud_run.CloudRunJob:create, VertFlow.src.cloud_run.CloudRunJob:run, VertFlow.src.cloud_run.CloudRunJob:executed_successfully

Region Selector

The Region Selector determines the optimal Cloud Run region for job execution based on predefined criteria. It offers methods to select regions based on proximity or environmental impact, allowing for efficient resource utilization and adherence to environmental considerations. This component ensures that jobs are executed in the most suitable location.

  • Related Classes/Methods: VertFlow.src.data.CloudRunRegions:closest, VertFlow.src.data.CloudRunRegions:greenest

Workflow Orchestrator

The Workflow Orchestrator is the central component responsible for executing the overall workflow. It utilizes the Cloud Run Job Manager to manage individual jobs and the Region Selector to determine the appropriate execution region. It also handles job termination when necessary, ensuring the smooth and reliable execution of the entire workflow.

  • Related Classes/Methods: VertFlow.src.operator.VertFlowOperator:execute, VertFlow.src.operator.VertFlowOperator:on_kill

Utility Functions

The Utility Functions component provides a collection of general-purpose functions used by other components within the system. These functions offer supporting capabilities that enhance the operation of other modules, promoting code reuse and simplifying complex tasks.

  • Related Classes/Methods: VertFlow.src.utils:intersection_equal