Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add sequence diagram #19

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion readme.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,38 @@ The HPC Client is a self-service solution that allows Flywheel jobs and gears to

## Architecture

![hpc-client-architecture 20210726](https://user-images.githubusercontent.com/75435671/127048966-af0582f7-10dc-451c-b955-4d5ab50eaf08.png)
<!-- ![hpc-client-architecture 20210726](https://user-images.githubusercontent.com/75435671/127048966-af0582f7-10dc-451c-b955-4d5ab50eaf08.png) -->

```mermaid
sequenceDiagram
box Flywheel
actor User
participant Job queue
participant Assets
end
box HPC
participant Cast
participant Scheduler
participant Compute Node
end

User->>Job queue: Submit job
Note over Cast: Cast wakes up on cron
Cast->>Job queue: Poll for HPC jobs
Job queue->>Cast: Return jobs
loop
Cast->> Scheduler: Submit job
Compute Node->>Scheduler: Poll task
Scheduler->>Compute Node: Return "fw engine" task
Note over Compute Node: Engine starts
Assets->>Compute Node: Pull Docker image and job inputs / config
Note over Compute Node: Gear execute with singularity runner
Compute Node->>Assets: Push job outputs
Compute Node->>Job queue: Mark job as complete
end

```


## HPC types

Expand Down
Loading