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

Add figures to the documentation #109

Open
mlegner opened this issue Aug 19, 2024 · 9 comments
Open

Add figures to the documentation #109

mlegner opened this issue Aug 19, 2024 · 9 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@mlegner
Copy link
Collaborator

mlegner commented Aug 19, 2024

Some concepts would be easier to understand with visual support:

  • How all ecosystem components fit together and interact
  • How blobs, slivers, shards, and storage nodes are related

Suggested in #106

@mlegner mlegner added the documentation Improvements or additions to documentation label Aug 19, 2024
@mlegner mlegner added this to the Testnet milestone Aug 19, 2024
@nerodk89
Copy link

Working on this one.

@nerodk89
Copy link

Hi @mlegner, I would like to provide a quick update on the progress and confirm my understanding of the Walrus architecture. Please correct me if I'm wrong. I just want to ensure that I'm on the right track and and can continue working with Aggregators, Caches, and Publishers. Thanks

image

@mlegner
Copy link
Collaborator Author

mlegner commented Aug 22, 2024

Hi @nerophung! Thanks for your work! ❤️

This is roughly correct. However, the total number of shards is exactly the same as the number of slivers for a blob and each shard contains exactly one sliver for each blob. So you would not have a situation like shard 1 in your picture that has two slivers for the same blob.

@mlegner
Copy link
Collaborator Author

mlegner commented Aug 22, 2024

Also, one question: Would you be able and willing to provide the source files for this and other images for whatever tool you use? We may have to modify them later and that is difficult with just the final image files.

@nerodk89
Copy link

nerodk89 commented Aug 22, 2024

Also, one question: Would you be able and willing to provide the source files for this and other images for whatever tool you use? We may have to modify them later and that is difficult with just the final image files.

Yes, I just sent you the image for a quick update. I'll send all the source files afterward.

@nerodk89
Copy link

Hi @nerophung! Thanks for your work! ❤️

This is roughly correct. However, the total number of shards is exactly the same as the number of slivers for a blob and each shard contains exactly one sliver for each blob. So you would not have a situation like shard 1 in your picture that has two slivers for the same blob.

Thanks for clearing up my confusion. I will make the adjustment.

@nerodk89
Copy link

image
Correct if i'm wrong. Thanks

@mlegner
Copy link
Collaborator Author

mlegner commented Aug 27, 2024

Thanks a lot, @nerophung, looks very good. 💯

A few minor things:

  • The number of storage nodes and the number of shards are generally different. (In the picture, you have #N for storage nodes and again for the shards in the first storage node.)
  • The number of slivers for a particular blob is equal to the total number of shards. (In the picture it looks as if there were only 3 slivers.)
  • The shards assigned to a particular storage node are not necessarily contiguous. So, it doesn't need to be 1, 2, ..., n; it could also be 1, 7, 13, ...

@nerodk89
Copy link

Screenshot 2024-08-29 at 10 05 03
Thank for the explaination! Hope that this version work 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants