broadinstitute / cromwell

Scientific workflow engine designed for simplicity & scalability. Trivially transition between one off use cases to massive scale production environments
http://cromwell.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
998 stars 361 forks source link

Prepare caas Fisma docs #3792

Open davidbernick opened 6 years ago

davidbernick commented 6 years ago

Already kicked off in Slack — we need docs and diagrams for caas.

ruchim commented 6 years ago

@davidbernick can you provide a little more detail for whats needed so I can understand the scope of this work?

davidbernick commented 6 years ago

From SLACK:

1. Can you make sure CaaS conforms to this loose list — ask questions about what any of this means — https://broadinstitute.atlassian.net/wiki/spaces/DSDE/pages/229212218/New+Service+Checklist

2. This is an example of the “paperwork” required — https://docs.google.com/document/d/1vv0thxw1ESyO6k9pP1R0qqo1atEiMn4f-ynx6ns972Y — we’ll need one of these for CaaS
1. System diagram — shows the different components and how they connect to each other.

2. Data flow diagram — slightly different — shows how the data moves through the system. This should have a paragraph or so description walking through the different steps the data takes. 

3. Network Diagram — Actual network connectivity between components and how they connect to each other (inlcuding ports/protocols)

Yes, I know they all sound the same. They’re really really similar. They’re not the same.