Skip to content

Commit 2f697a0

Browse files
authored
DOC-1927 Document configuration param maximumSessionAge in console (#1561)
1 parent b2a231b commit 2f697a0

File tree

2 files changed

+89
-0
lines changed

2 files changed

+89
-0
lines changed

modules/console/pages/config/security/authentication.adoc

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,93 @@ Most Kafka client libraries support SASL/SCRAM out of the box. You must configur
497497
- `sasl.username`: The Redpanda username
498498
- `sasl.password`: The corresponding password
499499

500+
== Configure session duration
501+
502+
By default, Redpanda Console sessions remain valid for one year. For enterprise deployments, you can limit the maximum session duration using the `maximumSessionAge` configuration parameter.
503+
504+
When a session exceeds the configured maximum age, users must re-authenticate to continue using Redpanda Console.
505+
506+
[tabs]
507+
======
508+
Standalone::
509+
+
510+
--
511+
[,yaml]
512+
----
513+
authentication:
514+
jwtSigningKey: "<secret-key>"
515+
useSecureCookies: true
516+
maximumSessionAge: "90d" # <1>
517+
basic:
518+
enabled: true
519+
----
520+
--
521+
522+
Kubernetes embedded::
523+
+
524+
--
525+
When using the Redpanda Operator or the Redpanda Helm chart:
526+
527+
[tabs]
528+
====
529+
Operator::
530+
+
531+
[,yaml]
532+
----
533+
apiVersion: cluster.redpanda.com/v1alpha2
534+
kind: Redpanda
535+
metadata:
536+
name: redpanda
537+
spec:
538+
clusterSpec:
539+
console:
540+
enabled: true
541+
console:
542+
config:
543+
authentication:
544+
jwtSigningKey: "<secret-key>"
545+
useSecureCookies: true
546+
maximumSessionAge: "90d" # <1>
547+
basic:
548+
enabled: true
549+
----
550+
551+
Helm::
552+
+
553+
[,yaml]
554+
----
555+
console:
556+
enabled: true
557+
console:
558+
config:
559+
authentication:
560+
jwtSigningKey: "<secret-key>"
561+
useSecureCookies: true
562+
maximumSessionAge: "90d" # <1>
563+
basic:
564+
enabled: true
565+
----
566+
====
567+
--
568+
569+
Kubernetes standalone::
570+
+
571+
--
572+
[,yaml]
573+
----
574+
config:
575+
authentication:
576+
jwtSigningKey: "<secret-key>"
577+
useSecureCookies: true
578+
maximumSessionAge: "90d" # <1>
579+
basic:
580+
enabled: true
581+
----
582+
--
583+
======
584+
585+
<1> Maximum duration for browser sessions. Accepts duration strings such as `90d` (90 days), `24h` (24 hours), or `30m` (30 minutes). If not specified, sessions remain valid for one year.
586+
500587
== Configure API authentication
501588

502589
After enabling authentication, you must configure how Redpanda Console authenticates to each Redpanda API: Kafka, Admin, and Schema Registry.

modules/shared/attachments/redpanda-console-config.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ schemaRegistry:
8585
authentication:
8686
jwtSigningKey: "secret-value"
8787
useSecureCookies: true
88+
# Maximum browser session age (Enterprise). Accepts duration strings (for example, "90d", "24h", "30m"). Default: 1 year.
89+
# maximumSessionAge: "90d"
8890
# Optionally enable cookie chunking if cookie size is an issue.
8991
# useCookieChunking: false
9092
# OIDC configuration (if using OIDC):

0 commit comments

Comments
 (0)