DOC-1927 Document configuration param maximumSessionAge in console #1561
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the
📝 WalkthroughWalkthroughThis pull request adds documentation for a new Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
graham-rp
left a comment
graham-rp
left a comment
There was a problem hiding this comment.
Looks great, thanks for turning this around so quickly!
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@modules/console/pages/config/security/authentication.adoc`:
- Around line 500-590: Remove the entire "Configure session duration" section
(the header "Configure session duration", all explanatory text, the three YAML
example blocks that reference maximumSessionAge, and the footnote) because the
Console does not support a maximumSessionAge setting; delete every occurrence of
the configuration key maximumSessionAge and the invalid example value "90d" (or
alternatively replace the whole section with a short "Coming soon" note if you
prefer to keep a placeholder).
|
|
||
| [NOTE] | ||
| ==== | ||
| include::shared:partial$enterprise-and-console.adoc[] |
There was a problem hiding this comment.
Not sure I understand why the enterprise license note appears here. The license would be for Console, not session duration, right? This is confusing to me, and might also be for our users. Help me understand why it is in this section. thx
There was a problem hiding this comment.
You're right, it's confusing. @graham-rp I added this because the description said it's for enterprise accounts. But they just need a Console license, right? Also do we need to describe how this new config behaves with JWT token expiration?
There was a problem hiding this comment.
The OSS version skips over all of the auth stuff, so this really only applies to console with an enterprise license. As for OIDC, customers can (and could previously) set expirations on their tokens on their end to do something similar.
There was a problem hiding this comment.
Not sure I am tracking here @graham-rp. The only Enterprise licensed features Console manages are:
- Authentication of RP Console
- Authorization (RBAC) for Redpanda
- Debug bundle generation
- Reassign partitions
There is already a licensing reminder/note at the top of the Authentication section here, so why would we repeat it for this specific task? In and of itself, session duration only requires a license because it is part of Authentication. We typically do not add the licensing requirement for each task appearing within a licensed feature. Hence, my suggestion to remove it here.
There was a problem hiding this comment.
Got it! I think I misunderstood the use of the tag. In that case I'm good to remove it.
There was a problem hiding this comment.
I've removed the extra enterprise note
micheleRP
deleted the
DOC-1927-Document-configuration-param-maximumSessionAge-in-console
branch
Description
This pull request adds documentation and configuration support for limiting Redpanda Console session duration using the new
maximumSessionAgeparameter. This allows enterprise users to control how long browser sessions remain valid before requiring users to re-authenticate.maximumSessionAgeparameter to limit session duration for Redpanda Console, including examples for standalone, Kubernetes Operator, Helm, and Kubernetes standalone deployments.redpanda-console-config.yaml) to document the newmaximumSessionAgeoption, including usage notes and example values.Resolves https://redpandadata.atlassian.net/browse/DOC-1927
Review deadline:
Page previews
Configure session duration
config.yaml example
Checks