diff --git a/README.md b/README.md index 1646666ed..606125816 100644 --- a/README.md +++ b/README.md @@ -43,3 +43,92 @@ Please share any issues or questions regarding the HTCondor-CE via the following - [htcondor-admin@cs.wisc.edu](mailto:htcondor-admin@cs.wisc.edu): For issues and questions containing private information. - [htcondor-security@cs.wisc.edu](mailto:htcondor-security@cs.wisc.edu): 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
_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
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:
-stdin
-stdout
-stderr| F +E ===|File:
-stdin
-stdout
-stderr| H +0 --> A +%% -- Subgraph Links -- +```