This repository was archived by the owner on Oct 14, 2020. It is now read-only.
Providing Two New Architecture Diagrams #52
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This diagramm shows a very high level overview of main SCBv2 compononents and how they communicate with each other. This diagram only shows the most important parts to be as simple as possible. It mainly uses terms from Kubernetes because the new architecture is completely based on Kubernetes. The diagram (uxf) itself is editable with UMLet: https://www.umlet.com/ It isn't made with PlantUML because it was a big hassle to lign up the boxes properly with PlantUMLs auto layouting. The rendered image is also commited so one does not need to install UMLet first to view it. Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
This diagram shows the sequencial interaction of the main components
for a scan.
Note: Full arrows are syncronous calls. Half arrows areasynchronou
calls. This is theeasier notation from UML 1.x.
The file is edited with PlatnUML: https://plantuml.com/
The rendered image is also commited so one does not need to install
UMLet first to view it.
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
- we aonly talk about findings and not about issues - hooks have also access to theraw result Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf
added
architecture
documentation
Weltraumschaf
changed the title
Member
|
The diagrams by themself are great, what I'm still missing is where they should be included / linked to. I guess its okay to merge this now and include them later, as the user docs are currently basically a empty markdown file... |
J12934
approved these changes
Jul 20, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR closes #50 by provides two new Architecture diagrams in the directory
docs/uml:At the moment we didn't clarified the question which tool to use for painting digrams. Focus should be simple text based like PlantUML. But not all kinds of diagrams are feaseable with it due to autolayout issues.