13579: Document ManagementToken. Add information about trash behavior.

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <pamstutz@veritasgenetics.com>

diff --git a/doc/install/install-keepstore.html.textile.liquid b/doc/install/install-keepstore.html.textile.liquid
index d1633f31c2c8f4475c8b85113b646d06db53f1e7..61553f73ea62f14e1e6dcbf20920f1e713cee88f 100644 (file)
--- a/doc/install/install-keepstore.html.textile.liquid
+++ b/doc/install/install-keepstore.html.textile.liquid
@@ -85,6 +85,9 @@ Listen: :25107
 
 # Format of request/response and error logs: "json" or "text".
 LogFormat: json
+
+# The secret key that must be provided by monitoring services
+# wishing to access the health check endpoint (/_health).
 ManagementToken: ""
 
 # Maximum RAM to use for data buffers, given in multiples of block
@@ -158,7 +161,7 @@ On its own, a keepstore server never deletes data.  The "keep-balance":install-k
 
 When a block is newly written, it is protected from deletion for the duration in @BlobSignatureTTL@.  During this time, it cannot be trashed.
 
-If keep-balance instructs keepstore to trash a block which is older than @BlobSignatureTTL@, and @EnableDelete@ is true, the block will be moved to "trash".
+If keep-balance instructs keepstore to trash a block which is older than @BlobSignatureTTL@, and @EnableDelete@ is true, the block will be moved to "trash".  A block which is in the trash has been moved out of the way and 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 @TrashLifetime@.
 
 h3. Configure storage volumes
 

diff --git a/services/keepstore/config.go b/services/keepstore/config.go
index c9c9ae1158ec323f572524adb3e7586590d8f788..3db20e29ce64eaca4d8c5ddd58389595d2f9ce16 100644 (file)
--- a/services/keepstore/config.go
+++ b/services/keepstore/config.go
@@ -52,7 +52,8 @@ type Config struct {
        systemAuthToken string
        debugLogf       func(string, ...interface{})
 
-       ManagementToken string
+       ManagementToken string `doc: The secret key that must be provided by monitoring services
+wishing to access the health check endpoint (/_health).`
 
        metrics
 }