Update token renew docs (#12572)

* Update docs for token renew api and cli * Clarify api docs for renew/renew-self * Update wording around periodic tokens
hashicorp · Sep 16, 2021 · fdd7599 · fdd7599
1 parent 681a931
commit fdd7599
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 9 deletions.
diff --git a/command/token_renew.go b/command/token_renew.go
@@ -77,10 +77,10 @@ func (c *TokenRenewCommand) Flags() *FlagSets {
 		Default:    0,
 		EnvVar:     "",
 		Completion: complete.PredictAnything,
-		Usage: "Request a specific increment for renewal. Vault is not required " +
-			"to honor this request. If not supplied, Vault will use the default " +
-			"TTL. This is specified as a numeric string with suffix like \"30s\" " +
-			"or \"5m\".",
+		Usage: "Request a specific increment for renewal. This increment may " +
+			"not be honored, for instance in the case of periodic tokens. If not " +
+			"supplied, Vault will use the default TTL. This is specified as a " +
+			"numeric string with suffix like \"30s\" or \"5m\".",
 	})
 
 	return set

diff --git a/website/content/api-docs/auth/token.mdx b/website/content/api-docs/auth/token.mdx
@@ -337,8 +337,10 @@ if there is a lease associated with it.
 
 - `token` `(string: <required>)` - Token to renew. This can be part of the URL
   or the body.
-- `increment` `(string: "")` - An optional requested lease increment can be
-  provided. This increment may be ignored.
+- `increment` `(string: "")` - An optional requested increment duration can be
+  provided. This increment may not be honored, for instance in the case of periodic tokens. 
+  If not supplied, Vault will use the default TTL. This is specified as a numeric string 
+  with suffix like "30s" or "5m".
 
 ### Sample Payload
 
@@ -386,8 +388,10 @@ possible only if there is a lease associated with it.
 
 ### Parameters
 
-- `increment` `(string: "")` - An optional requested lease increment can be
-  provided. This increment may be ignored.
+- `increment` `(string: "")` - An optional requested increment duration can be
+  provided. This increment may not be honored, for instance in the case of periodic tokens. 
+  If not supplied, Vault will use the default TTL. This is specified as a numeric string 
+  with suffix like "30s" or "5m".
 
 ### Sample Payload
 

diff --git a/website/content/docs/commands/token/renew.mdx b/website/content/docs/commands/token/renew.mdx
@@ -50,6 +50,6 @@ flags](/docs/commands) included on all commands.
 ### Command Options
 
 - `-increment` `(duration: "")` - Request a specific increment for renewal.
-  Vault is not required to honor this request. If not supplied, Vault will use
+  Vault will not honor this request for periodic tokens. If not supplied, Vault will use
   the default TTL. This is specified as a numeric string with suffix like "30s"
   or "5m". This is aliased as "-i".