From: Peter Amstutz Date: Mon, 11 Jun 2018 19:27:55 +0000 (-0400) Subject: 13579: Document ManagementToken. Add information about trash behavior. X-Git-Tag: 1.2.0~111^2~7 X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/296ac256c898c145f7e4566d86d5f09f4e966b43 13579: Document ManagementToken. Add information about trash behavior. Arvados-DCO-1.1-Signed-off-by: Peter Amstutz --- diff --git a/doc/install/install-keepstore.html.textile.liquid b/doc/install/install-keepstore.html.textile.liquid index d1633f31c2..61553f73ea 100644 --- 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 c9c9ae1158..3db20e29ce 100644 --- 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 }