Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc Update: MaxTTL no longer capped at 24h #21066

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

karlhungus
Copy link

Description

This was uncapped in eded58b

Testing & Reproduction steps

n/a

Links

https://developer.hashicorp.com/consul/api-docs/acl/auth-methods#maxtokenttl

I don't know how the version drop down works; maybe there's a better way to do this that applies to 1.16+ docs

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

@karlhungus karlhungus requested a review from a team as a code owner May 7, 2024 17:05
@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label May 7, 2024
@karlhungus
Copy link
Author

Feel free to close this if there's a better way to update docs

@blake blake added backport-inactive/1.16 This release series is longer active backport-inactive/1.17 This release series is longer active. Use backport/ent/1.17. backport/ent/1.18 Changes are backported to 1.18 ent pr/no-changelog PR does not need a corresponding .changelog entry labels May 7, 2024
Copy link
Contributor

@boruszak boruszak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please implement the suggestions, as abbreviations like i.e. and parenthesis are style guide violations.

@@ -64,8 +64,7 @@ The corresponding CLI command is [`consul acl auth-method create`](/consul/comma
[`ExpirationTime`](/consul/api-docs/acl/tokens#expirationtime) field on all tokens
to a value of `Token.CreateTime + AuthMethod.MaxTokenTTL`. This field is not
persisted beyond its initial use. Can be specified in the form of `"60s"` or
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
persisted beyond its initial use. Can be specified in the form of `"60s"` or
persisted beyond its initial use. Specify time as an alphanumeric string. For example, `"60s"` and

@@ -64,8 +64,7 @@ The corresponding CLI command is [`consul acl auth-method create`](/consul/comma
[`ExpirationTime`](/consul/api-docs/acl/tokens#expirationtime) field on all tokens
to a value of `Token.CreateTime + AuthMethod.MaxTokenTTL`. This field is not
persisted beyond its initial use. Can be specified in the form of `"60s"` or
`"5m"` (i.e., 60 seconds or 5 minutes, respectively). This value must be no
smaller than 1 minute and no longer than 24 hours. Added in Consul 1.8.0.
`"5m"` (i.e., 60 seconds or 5 minutes, respectively). Added in Consul 1.8.0.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`"5m"` (i.e., 60 seconds or 5 minutes, respectively). Added in Consul 1.8.0.
`"5m"` set the duration at 60 seconds and 5 minutes, respectively. Added in Consul 1.8.0.

@boruszak boruszak added the backport-inactive/1.15 This release series is longer active. Use backport/ent/1.15. label May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/ent/1.18 Changes are backported to 1.18 ent backport-inactive/1.15 This release series is longer active. Use backport/ent/1.15. backport-inactive/1.16 This release series is longer active backport-inactive/1.17 This release series is longer active. Use backport/ent/1.17. pr/no-changelog PR does not need a corresponding .changelog entry type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants