luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity

Better documentation around increment

Browse source 
Fixes #5701
This commit is contained in:
Jeff Mitchell 2018-11-06 17:42:20 -05:00
parent 4b1d816be7
commit 6e4f990902
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
website/source/docs/concepts/lease.html.md
View file

@ -51,9 +51,15 @@ Along with the lease ID, a _lease duration_ can be read. The lease duration is
a Time To Live value: the time in seconds for which the lease is valid. A
consumer of this secret must renew the lease within that time.
When renewing the lease, the user can request a specific amount of time from
now to extend the lease. For example: `vault renew my-lease-id 3600` would
request to extend the lease of "my-lease-id" by 1 hour (3600 seconds).
When renewing the lease, the user can request a specific amount of time they
want remaining on the lease, termed the `increment`. This is not an increment
at the end of the current TTL; it is an increment _from the current time_. For
example, `vault renew my-lease-id 3600` would request that the TTL of the lease
be adjusted to 1 hour (3600 seconds). Having the increment be rooted at the
current time instead of the end of the lease makes it easy for users to reduce
the length of leases if they don't actually need credentials for the full
possible lease period, allowing those credentials to expire sooner and
resources to be cleaned up earlier.
The requested increment is completely advisory. The backend in charge of the
secret can choose to completely ignore it. For most secrets, the backend does