Code Monkey home page Code Monkey logo

illustrated's Introduction

Storj on Diagrams

Diagrams are under: https://github.com/storj/illustrated/tree/master/docs

But it's also visible in one HTML page at: https://storj.github.io/illustrated/

The diagrams represent my (may or may not be good) understanding.

If you see any problems, please create an issue.

If you need something to be explained, please create an issue.

Diagrams

docs/0title.svg




docs/authservice.svg




docs/core.svg




docs/delete.svg




docs/edge.svg




docs/encrypted-keys.svg




docs/encrypted-path.svg




docs/grant.svg




docs/identity.svg




docs/macaroon.svg




docs/overview.svg




docs/pieces.svg




docs/ranged-loop.svg




docs/read1.svg




docs/read2.svg




docs/reputation.svg




docs/satellite-api.svg




docs/secrets.svg




docs/signatures.svg




docs/storagenode-accounting.svg




docs/versioncontrol.svg

How to contribute

Original source of the diagrams can be edited with online or offline version of diagrams.net

When one diagram is saved, both the export (svg) both the embedded source are updated.

PR can be created where the old version and new version of the SVG can be seen, just click to the rich diff option:

Rich diff

To regenerate the previews, the following can be used (after existing lines are removed):

ls -1 docs/*.svg | sort | xargs -n1 -IFILE printf "![FILE](FILE)\n\n```\n\n\n\n```\n\n"         

(tested in fish)

illustrated's People

Contributors

elek avatar jtolio avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

elek

illustrated's Issues

Edge Services should include uplink cli and libuplink as actors

The Edge Services diagram currently displays two actors: S3 and Browser.

Uplink CLI and libuplink are other actors that may be added. The share command of Uplink CLI can register access grants to the Auth Service. Libuplink can do the same via the RegisterAccess function.

What does it mean for the S3 actor to register access grant?

In the Edge Service diagram, we have an arrow that tells that the S3 actor registers an access grant in the Auth Service.

I am not sure what exactly this means. I don't think it is possible to register an access grant via the S3 protocol. S3-related access grants when the user generates S3 credentials in the Satellite GUI using the web browser.

Core Services: GC perhaps misses a line with SN

Garbage collector sends Bloom filters to SNs to remove deleted pieces that they missed, for whatever reason, when the deletion happen.

I'm wondering if that line is missing or it isn't because the diagram only shows 2-way communication, i.e. Satellite asks and SNs reply, which isn't the case for GC.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.