search

uyuni-project / uyuni

Source code for Uyuni
https://www.uyuni-project.org/
GNU General Public License v2.0
434 stars 181 forks source link

Create architectural overview diagrams #9131

Open sbehlert opened 3 months ago

sbehlert commented 3 months ago

Short description

We need some architectural diagrams to show how the various components of Uyuni play together. These should be stored at one place.

Details

A lot of changes happened in the structure of Uyuni, and the containerization started will bring even more. We need to have some documentation of how the components of the system play together not only to help new developers to the project to get into the structure easier, but also in the context of more containers. If we want to split e.g. some pieces off into other ocntainers, this is a good start for discussions and to not miss things.

We have some of the information in the various RFCs, but those are widely spread. Having at least some overview available centrally (and perhaps some pointers to the details then) will help to grasp the whole picture easier - or at all.

The tricky part might be to keep those up-to-date, but I think this is worth the effort.

rjmateus commented 1 month ago

The diagram is done, I'm missing the description of each component to make it clear what is doing. https://github.com/uyuni-project/uyuni/wiki/Project-Architecture-Documentation:-High-Level-Modules-Diagram