14714: Removes metrics serving
[arvados.git] / doc / admin / keep-balance.html.textile.liquid
index 1a77cdd160daa4052c5a5f4928a7a43bd6f0feb2..5af0a2688033d311a6c8c7b96a39719088a01d7a 100644 (file)
@@ -14,6 +14,14 @@ This page describes how to balance keepstore servers using keep-balance. Keep-ba
 
 See "the Keep-balance install docs":{{site.baseurl}}/install/install-keep-balance.html for installation instructions.
 
+h3. Data deletion
+
+The keep-balance service determines which blocks are candidates for deletion and instructs the keepstore to move those blocks to the trash. When a block is newly written, it is protected from deletion for the duration in @BlobSigningTTL@.  During this time, it cannot be trashed or deleted.
+
+If keep-balance instructs keepstore to trash a block which is older than @BlobSigningTTL@, and @BlobTrashLifetime@ is non-zero, the block will be moved to "trash".  A block which is in the trash is no longer accessible by read requests, but has not yet been permanently deleted.  Blocks which are in the trash may be recovered using the "untrash" API endpoint.  Blocks are permanently deleted after they have been in the trash for the duration in @BlobTrashLifetime@.
+
+Keep-balance is also responsible for balancing the distribution of blocks across keepstore servers by asking servers to pull blocks from other servers (as determined by their "storage class":{{site.baseurl}}/admin/storage-classes.html and "rendezvous hashing order":{{site.baseurl}}/api/storage.html).  Pulling a block makes a copy.  If a block is overreplicated (i.e. there are excess copies) after pulling, it will be subsequently trashed and deleted on the original server, subject to @BlobTrash@ and @BlobTrashLifetime@ settings.
+
 h3. Scanning
 
 By default, keep-balance operates periodically, i.e. do a scan/balance operation, sleep, repeat.