wellcomecollection / storage-service

🗃️ Managing the safe, long-term storage of our digital collections in the cloud
MIT License
32 stars 5 forks source link

Add architecture overview #1117

Closed kenoir closed 7 months ago

kenoir commented 8 months ago

What does this change?

This change adds a detailed architecture overview, following a team architecture review on this service intended to capture some of the output from that knowledge sharing.

How to test

Review the docs.

How can we measure success?

It's easier to understand how all the parts of the storage service fit together and talk to one another.

Have we considered potential risks?

This image will become outdated, and the structure is not committed in code only captured by image. We can accept this if we're willing to perform updates or recreate this image in the future if necessary. Arguably the utility of providing it all outweighs these risks.