Move packages to proejct/pkg to follow go project folder structure convention (#1190)

2019-05-31 16:28:55 +08:00
parent 1c5fd92ad6
commit a0e9a39511
196 changed files with 1672 additions and 1716 deletions
@@ -0,0 +1,26 @@
+# StorageSvc 
+StorageSvc consists of 3 components
+* Storage http request handler
+* StowClient
+* ArchivePruner
+
+## StorageSvc  
+This is the HTTP handler that serves requests to :
+* upload archive into a storage
+* fetch an archive from storage
+* delete archive from storage
+
+## StowClient 
+This is the storage interface layer that interacts with stow package.
+It provides methods to:
+* write a file to storage
+* retrieve a file from storage
+* delete a file from storage
+* get all files on storage
+
+## ArchivePruner
+This acts like a cron job to clean up orphaned archives from storage.
+By default configured to run every hour. The value can be set in Values.yaml to any preferred interval.
+
+
+