Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add technical flow mermaid diagrams #621

Merged
merged 6 commits into from
Nov 4, 2024

Conversation

AhmedTremo
Copy link
Contributor

@AhmedTremo AhmedTremo commented Oct 30, 2024

Motivation

I faced some issues when I used Spegel because of wrong assumptions that I've made on how the project works, which motivated me to dive into the code to understand better. So, I created these diagrams to help me understand and to help others who get to same situations I was in.

Diagrams

  • Core components architecture
  • Image pull flow
  • P2P interactions
  • State tracking / content advertisements.

Caveat

(These diagrams are based on my current understanding of the inner workings of the project), I created the diagrams as mermaid diagrams to they can be corrected or updated in the future as the project evolves.

@phillebaba
Copy link
Member

First of all this looks great. It is really detailed and very informative! 🌹

One small things. In the first diagram it shows that Spegel handles fallback. In reality it is Containerd that deals with the fallback to the original registry, Spegel has no knowledge of this.

@AhmedTremo
Copy link
Contributor Author

@phillebaba That's a good catch, I updated the diagram/description. Let me know if you have comments/suggestions for others.

Copy link

codecov bot commented Nov 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

@phillebaba phillebaba merged commit e1e62b3 into spegel-org:main Nov 4, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants