Skip to content

Commit

Permalink
Update CE repo readme with mermaid diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
rc-jacob committed Aug 9, 2023
1 parent 537defe commit 10a589b
Showing 1 changed file with 89 additions and 0 deletions.
89 changes: 89 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,92 @@ Please share any issues or questions regarding the HTCondor-CE via the following
- [[email protected]](mailto:[email protected]): For issues and questions containing private information.
- [[email protected]](mailto:[email protected]): For issues regarding security problems/vunerabilities.
For more information regarding reporting security problems go to [HTCSS Security](https://htcondor.org/security/).

Diagrams
--------
### HTCondor-CE workflow
``` mermaid
flowchart LR %% Specify diagram type and direction
%% ID FORMAT:
%% - External nodes are numbered (0 - 100)
%% - Internal nodes are alphabetic (A - Z)
%% - Nodes within nested subgraphs are
%% are labelled by double letters (AA - ZZ)
%% - All subgraph names are capitalized (Blahp)
%% while nodes with the same name are lowercase (blahp)
subgraph HTCondor-CE
%%direction LR %% Flowchart direction statement overrides statements in connected subgraphs; comment these out.
A[[SchedD]] --> B(Job Router)
B -. Routed Job .-> A
A -.-> C{Grid Mgr.}
D[(Log)] --> C
end
subgraph Blahp
%%direction LR
subgraph lsf_*.sh %% Configure nested subgraphs above internal nodes
direction LR %% Set direction of isolated subgraphs
AA[submit] ---|OR| BB[cancel]
BB ---|OR| CC[status]
end
E[[blahp]] --> lsf_*.sh
F[common_sub</br>_attr.sh] -->|attrs| lsf_*.sh
lsf_*.sh -->|args| F
end
subgraph Batch Sys
%%direction LR
G((qsub))
end
%% -- External Nodes --
0>Job Ad]
%% -- External Nodes --
%% -- Subgraph Links --
C <--> E
lsf_*.sh --> G
0 --> A
%% -- Subgraph Links --
```

### Bosco Cluster workflow
```mermaid
flowchart LR %% Specify diagram type and direction
%% ID FORMAT:
%% - External nodes are numbered (0 - 100)
%% - Internal nodes are alphabetic (A - Z)
%% - Nodes within nested subgraphs are
%% are labelled by double letters (AA - ZZ)
%% - All subgraph names are capitalized (Blahp)
%% while nodes with the same name are lowercase (blahp)
subgraph Bosco Cluster
%%direction LR %% Flowchart direciton statement overrides statements in connected subgraphs; comment these out
A[schedd] --> B[Grid</br>Manager]
C[SP] --> B
B --- D[ssh]
B --- E[ssh]
E --> |FT|B
C -. Data Channel .- E
end
subgraph Remote Submit
%%direction LR
F[sshd] --> G[blahp]
H[sshd] --> I[FTGahp] %% FTGahp capitalized to be legible
end
%% -- External Nodes --
0>Job Ad]
%% -- External Nodes --
%% -- Subgraph Links --
D ===|Blahp:</br>-stdin</br>-stdout</br>-stderr| F
E ===|File:</br>-stdin</br>-stdout</br>-stderr| H
0 --> A
%% -- Subgraph Links --
```

0 comments on commit 10a589b

Please sign in to comment.