From 16d24abadd586184bc2891a6fdbdf54f0b3d7f5f Mon Sep 17 00:00:00 2001
From: Viet Nguyen Duc <nguyenducviet4496@gmail.com>
Date: Tue, 3 Dec 2024 21:19:43 +0700
Subject: [PATCH 1/2] K8s: Add configs for sessions external datastore

Signed-off-by: Viet Nguyen Duc <nguyenducviet4496@gmail.com>
---
 Base/Dockerfile                               | 14 ++++-
 Makefile                                      |  4 +-
 Sessions/Dockerfile                           | 17 ++++--
 Sessions/generate_config                      | 39 +++++++++++++
 Sessions/start-selenium-grid-sessions.sh      | 26 ++++++++-
 charts/selenium-grid/CONFIGURATION.md         | 14 +++++
 charts/selenium-grid/Chart.yaml               |  8 +++
 charts/selenium-grid/README.md                | 33 +++++++++++
 .../selenium-grid/templates/_nameHelpers.tpl  |  7 +++
 .../templates/session-map-configmap.yaml      | 45 +++++++++++++++
 .../templates/session-map-deployment.yaml     |  2 +
 charts/selenium-grid/values.yaml              | 56 +++++++++++++++++++
 tests/charts/config/ct.yaml                   |  1 +
 tests/charts/make/chart_test.sh               | 14 +++++
 tests/charts/templates/render/dummy.yaml      |  3 +
 .../templates/render/dummy_solution.yaml      |  3 +
 16 files changed, 274 insertions(+), 12 deletions(-)
 create mode 100755 Sessions/generate_config
 create mode 100644 charts/selenium-grid/templates/session-map-configmap.yaml

diff --git a/Base/Dockerfile b/Base/Dockerfile
index bf6d4ffd01..40b4c979f1 100644
--- a/Base/Dockerfile
+++ b/Base/Dockerfile
@@ -11,6 +11,8 @@ ARG OPENTELEMETRY_VERSION=1.44.1
 ARG GRPC_VERSION=1.68.1
 ARG NETTY_VERSION=4.1.115.Final
 ARG CS_VERSION=2.1.18
+ARG POSTGRESQL_VERSION=42.7.4
+ARG MVN_SELENIUM_VERSION=4.27.0
 
 #Arguments to define the user running Selenium
 ARG SEL_USER=seluser
@@ -118,8 +120,16 @@ RUN --mount=type=secret,id=SEL_PASSWD \
   && if [ -f "/tmp/cs" ]; then \
         java -jar /tmp/cs fetch --classpath --cache /external_jars \
         io.opentelemetry:opentelemetry-exporter-otlp:${OPENTELEMETRY_VERSION} \
-        io.grpc:grpc-netty:${GRPC_VERSION} io.netty:netty-codec-http:${NETTY_VERSION} > /external_jars/.classpath.txt \
-        && chmod 664 /external_jars/.classpath.txt ; \
+        io.grpc:grpc-netty:${GRPC_VERSION} \
+        io.netty:netty-codec-http:${NETTY_VERSION} \
+        > /external_jars/.classpath.txt \
+        && chmod 664 /external_jars/.classpath.txt \
+        && java -jar /tmp/cs fetch --classpath --cache /external_jars \
+        org.seleniumhq.selenium:selenium-session-map-jdbc:${MVN_SELENIUM_VERSION} \
+        org.postgresql:postgresql:${POSTGRESQL_VERSION} \
+        org.seleniumhq.selenium:selenium-session-map-redis:${MVN_SELENIUM_VERSION} \
+        > /external_jars/.classpath_session_map.txt \
+        && chmod 664 /external_jars/.classpath_session_map.txt ; \
      fi \
   && rm -fr /root/.cache/* \
   # (Note that .bashrc is only executed in interactive bash shells.)
diff --git a/Makefile b/Makefile
index d0c4cfdb41..8b33a498d4 100644
--- a/Makefile
+++ b/Makefile
@@ -917,7 +917,7 @@ chart_test_autoscaling_disabled:
 	./tests/charts/make/chart_test.sh NoAutoscaling
 
 chart_test_autoscaling_deployment_https:
-	PLATFORMS=$(PLATFORMS) CHART_FULL_DISTRIBUTED_MODE=true CHART_ENABLE_BASIC_AUTH=true \
+	PLATFORMS=$(PLATFORMS) CHART_FULL_DISTRIBUTED_MODE=true CHART_ENABLE_BASIC_AUTH=true TEST_EXTERNAL_DATASTORE=postgresql \
 	SECURE_INGRESS_ONLY_DEFAULT=true INGRESS_DISABLE_USE_HTTP2=true SELENIUM_GRID_PROTOCOL=https CHART_ENABLE_INGRESS_HOSTNAME=true SELENIUM_GRID_PORT=443 \
 	SELENIUM_GRID_AUTOSCALING_MIN_REPLICA=0 MAX_SESSIONS_FIREFOX=1 MAX_SESSIONS_EDGE=1 MAX_SESSIONS_CHROME=1 TEST_NAME_OVERRIDE=true \
 	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) KEDA_BASED_NAME=$(KEDA_BASED_NAME) KEDA_BASED_TAG=$(KEDA_BASED_TAG) NAMESPACE=$(NAMESPACE) BINDING_VERSION=$(BINDING_VERSION) BASE_VERSION=$(BASE_VERSION) \
@@ -955,7 +955,7 @@ chart_test_autoscaling_job:
 	./tests/charts/make/chart_test.sh JobAutoscaling
 
 chart_test_autoscaling_playwright_connect_grid:
-	PLATFORMS=$(PLATFORMS) CHART_ENABLE_TRACING=true CHART_ENABLE_BASIC_AUTH=true MATRIX_TESTS=CDPTests \
+	PLATFORMS=$(PLATFORMS) CHART_FULL_DISTRIBUTED_MODE=true CHART_ENABLE_BASIC_AUTH=true TEST_EXTERNAL_DATASTORE=redis MATRIX_TESTS=CDPTests \
 	BASIC_AUTH_USERNAME=docker-selenium BASIC_AUTH_PASSWORD=2NMI4jdBi6k7bENoeUfV25295VvzwAE9chM24a+2VL95uOHozo \
 	SECURE_INGRESS_ONLY_DEFAULT=true SECURE_USE_EXTERNAL_CERT=true SELENIUM_GRID_PROTOCOL=https SELENIUM_GRID_HOST=$$(hostname -I | cut -d' ' -f1) SELENIUM_GRID_PORT=443 \
 	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) KEDA_BASED_NAME=$(KEDA_BASED_NAME) KEDA_BASED_TAG=$(KEDA_BASED_TAG) NAMESPACE=$(NAMESPACE) BINDING_VERSION=$(BINDING_VERSION) BASE_VERSION=$(BASE_VERSION) \
diff --git a/Sessions/Dockerfile b/Sessions/Dockerfile
index a9d550a82c..66f7ceed7d 100644
--- a/Sessions/Dockerfile
+++ b/Sessions/Dockerfile
@@ -4,17 +4,24 @@ FROM ${NAMESPACE}/base:${VERSION}
 ARG AUTHORS
 LABEL authors=${AUTHORS}
 
-USER ${SEL_UID}
-
 #========================
 # Selenium SessionMap Configuration
 #========================
 
-EXPOSE 5556
+USER root
 
-COPY --chown="${SEL_UID}:${SEL_GID}" start-selenium-grid-sessions.sh \
+COPY --chown="${SEL_UID}:${SEL_GID}" start-selenium-grid-sessions.sh generate_config \
     /opt/bin/
+RUN chmod +x /opt/bin/start-selenium-grid-sessions.sh /opt/bin/generate_config
 
 COPY selenium-grid-sessions.conf /etc/supervisor/conf.d/
 
-ENV SE_OTEL_SERVICE_NAME="selenium-session-map"
+USER ${SEL_UID}
+
+EXPOSE 5556
+
+ENV SE_OTEL_SERVICE_NAME="selenium-session-map" \
+    # Path to the Configfile
+    CONFIG_FILE=/opt/selenium/config.toml \
+    GENERATE_CONFIG=true \
+    SE_SESSIONS_MAP_EXTERNAL_DATASTORE=false
diff --git a/Sessions/generate_config b/Sessions/generate_config
new file mode 100755
index 0000000000..7c41aa1085
--- /dev/null
+++ b/Sessions/generate_config
@@ -0,0 +1,39 @@
+#!/bin/bash
+
+if [[ -z "$CONFIG_FILE" ]]; then
+	FILENAME="/opt/selenium/config.toml"
+else
+	FILENAME="$CONFIG_FILE"
+fi
+
+echo "[sessions]" >"$FILENAME"
+
+if [ "${SE_SESSIONS_MAP_EXTERNAL_DATASTORE}" = "true" ]; then
+	if [[ -n "${SE_SESSIONS_MAP_EXTERNAL_SCHEME}" ]]; then
+		echo "scheme = \"${SE_SESSIONS_MAP_EXTERNAL_SCHEME}\"" >>"$FILENAME"
+	fi
+
+	if [[ -n "${SE_SESSIONS_MAP_EXTERNAL_IMPLEMENTATION}" ]]; then
+		echo "implementation = \"${SE_SESSIONS_MAP_EXTERNAL_IMPLEMENTATION}\"" >>"$FILENAME"
+	fi
+
+	if [[ -n "${SE_SESSIONS_MAP_EXTERNAL_HOSTNAME}" ]]; then
+		echo "hostname = \"${SE_SESSIONS_MAP_EXTERNAL_HOSTNAME}\"" >>"$FILENAME"
+	fi
+
+	if [[ -n "${SE_SESSIONS_MAP_EXTERNAL_PORT}" ]]; then
+		echo "port = \"${SE_SESSIONS_MAP_EXTERNAL_PORT}\"" >>"$FILENAME"
+	fi
+
+	if [[ -n "${SE_SESSIONS_MAP_EXTERNAL_JDBC_URL}" ]]; then
+		echo "jdbc-url = \"${SE_SESSIONS_MAP_EXTERNAL_JDBC_URL}\"" >>"$FILENAME"
+	fi
+
+	if [[ -n "${SE_SESSIONS_MAP_EXTERNAL_JDBC_USER}" ]]; then
+		echo "jdbc-user = \"${SE_SESSIONS_MAP_EXTERNAL_JDBC_USER}\"" >>"$FILENAME"
+	fi
+
+	if [[ -n "${SE_SESSIONS_MAP_EXTERNAL_JDBC_PASSWORD}" ]]; then
+		echo "jdbc-password = \"${SE_SESSIONS_MAP_EXTERNAL_JDBC_PASSWORD}\"" >>"$FILENAME"
+	fi
+fi
diff --git a/Sessions/start-selenium-grid-sessions.sh b/Sessions/start-selenium-grid-sessions.sh
index db8dfffdb5..b0357269ff 100755
--- a/Sessions/start-selenium-grid-sessions.sh
+++ b/Sessions/start-selenium-grid-sessions.sh
@@ -3,8 +3,6 @@
 # set -e: exit asap if a command exits with a non-zero status
 set -e
 
-echo "Starting Selenium Grid Sessions..."
-
 function append_se_opts() {
   local option="${1}"
   local value="${2:-""}"
@@ -98,12 +96,21 @@ if [ ! -z "$SE_REGISTRATION_SECRET" ]; then
   append_se_opts "--registration-secret" "${SE_REGISTRATION_SECRET}" "false"
 fi
 
+if [ "$GENERATE_CONFIG" = true ]; then
+  echo "Generating Selenium Config for Sessions"
+  /opt/bin/generate_config
+fi
+
+if [ ! -z "${CONFIG_FILE}" ]; then
+  append_se_opts "--config" "${CONFIG_FILE}"
+fi
+
 EXTRA_LIBS=""
 
 if [ "$SE_ENABLE_TRACING" = "true" ]; then
   EXTERNAL_JARS=$(</external_jars/.classpath.txt)
   [ -n "$EXTRA_LIBS" ] && [ -n "${EXTERNAL_JARS}" ] && EXTRA_LIBS=${EXTRA_LIBS}:
-  EXTRA_LIBS="--ext "${EXTRA_LIBS}${EXTERNAL_JARS}
+  EXTRA_LIBS="${EXTRA_LIBS}${EXTERNAL_JARS}"
   echo "Tracing is enabled"
   echo "Classpath will be enriched with these external jars : " ${EXTRA_LIBS}
   if [ -n "$SE_OTEL_SERVICE_NAME" ]; then
@@ -128,6 +135,19 @@ else
   echo "Tracing is disabled"
 fi
 
+if [ "${SE_SESSIONS_MAP_EXTERNAL_DATASTORE}" = "true" ]; then
+  EXTERNAL_JARS=$(</external_jars/.classpath_session_map.txt)
+  [ -n "$EXTRA_LIBS" ] && [ -n "${EXTERNAL_JARS}" ] && EXTRA_LIBS=${EXTRA_LIBS}:
+  EXTRA_LIBS="${EXTRA_LIBS}${EXTERNAL_JARS}"
+fi
+
+if [ -n "${EXTRA_LIBS}" ]; then
+  EXTRA_LIBS="--ext ${EXTRA_LIBS}"
+fi
+
+cat "$CONFIG_FILE"
+echo "Starting Selenium Grid Sessions..."
+
 java ${JAVA_OPTS:-$SE_JAVA_OPTS} \
   -jar /opt/selenium/selenium-server.jar \
   ${EXTRA_LIBS} sessions \
diff --git a/charts/selenium-grid/CONFIGURATION.md b/charts/selenium-grid/CONFIGURATION.md
index 3f084018a0..7734f8b3fa 100644
--- a/charts/selenium-grid/CONFIGURATION.md
+++ b/charts/selenium-grid/CONFIGURATION.md
@@ -18,6 +18,8 @@ A Helm chart for creating a Selenium Grid Server in Kubernetes
 
 | Repository | Name | Version |
 |------------|------|---------|
+| https://charts.bitnami.com/bitnami | postgresql | 16.2.3 |
+| https://charts.bitnami.com/bitnami | redis | 20.4.0 |
 | https://jaegertracing.github.io/helm-charts | jaeger | 3.3.3 |
 | https://kedacore.github.io/charts | keda | 2.16.0 |
 | https://kubernetes.github.io/ingress-nginx | ingress-nginx | 4.11.3 |
@@ -109,6 +111,8 @@ A Helm chart for creating a Selenium Grid Server in Kubernetes
 | ingress.tls | list | `[]` | TLS backend configuration for ingress resource |
 | busConfigMap.nameOverride | string | `nil` | Override the name of the bus configMap |
 | busConfigMap.annotations | object | `{}` | Custom annotations for configmap |
+| sessionMapConfigMap.nameOverride | string | `nil` | Override the name of the session map configMap |
+| sessionMapConfigMap.annotations | object | `{}` | Custom annotations for configmap |
 | distributorConfigMap.nameOverride | string | `nil` | Override the name of the distributor configMap |
 | distributorConfigMap.defaultMode | int | `493` | Default mode for ConfigMap is mounted as file |
 | distributorConfigMap.extraScriptsImportFrom | string | `"configs/distributor/**"` | Directory where the extra scripts are imported to ConfigMap by default (if given a relative path, it should be in chart's directory) |
@@ -244,6 +248,10 @@ A Helm chart for creating a Selenium Grid Server in Kubernetes
 | components.sessionMap.tolerations | list | `[]` | Tolerations for Session Map pods |
 | components.sessionMap.nodeSelector | object | `{}` | Node selector for Session Map pods |
 | components.sessionMap.priorityClassName | string | `""` | Priority class name for Session Map pods |
+| components.sessionMap.externalDatastore.enabled | bool | `false` | Enable external datastore for Session Map |
+| components.sessionMap.externalDatastore.backend | string | `"postgresql"` | Backend for external datastore (supported: postgresql, redis). Details for each backend are described below config key |
+| components.sessionMap.externalDatastore.postgresql | object | `{"implementation":"org.openqa.selenium.grid.sessionmap.jdbc.JdbcBackedSessionMap","jdbcPassword":"seluser","jdbcUrl":"jdbc:postgresql://{{ $.Release.Name }}-postgresql:5432/selenium_sessions","jdbcUser":"seluser"}` | Configure database backed Session Map (https://www.selenium.dev/documentation/grid/advanced_features/external_datastore/#database-backed-session-map) |
+| components.sessionMap.externalDatastore.redis | object | `{"hostname":"{{ $.Release.Name }}-redis-master","implementation":"org.openqa.selenium.grid.sessionmap.redis.RedisBackedSessionMap","port":"6379","scheme":"redis"}` | Configure Redis backed Session Map (https://www.selenium.dev/documentation/grid/advanced_features/external_datastore/#redis-backed-session-map) |
 | components.sessionQueue.imageRegistry | string | `nil` | Registry to pull the image (this overwrites global.seleniumGrid.imageRegistry parameter) |
 | components.sessionQueue.imageName | string | `"session-queue"` | Session Queue image name |
 | components.sessionQueue.imageTag | string | `nil` | Session Queue image tag (this overwrites global.seleniumGrid.imageTag parameter) |
@@ -590,4 +598,10 @@ A Helm chart for creating a Selenium Grid Server in Kubernetes
 | ingress-nginx | object | `{"controller":{"admissionWebhooks":{"enabled":false}}}` | Configuration for dependency chart ingress-nginx |
 | kube-prometheus-stack | object | `{"cleanPrometheusOperatorObjectNames":true,"prometheus":{"prometheusSpec":{"additionalConfig":{"additionalScrapeConfigs":{"key":"{{ template \"seleniumGrid.monitoring.scrape.key\" $ }}","name":"{{ template \"seleniumGrid.monitoring.exporter.fullname\" $ }}"}}}}}` | Configuration for dependency chart kube-prometheus-stack |
 | jaeger | object | `{"agent":{"enabled":false},"allInOne":{"enabled":true,"extraEnv":[{"name":"QUERY_BASE_PATH","value":"/jaeger"}]},"collector":{"enabled":false},"provisionDataStore":{"cassandra":false},"query":{"enabled":false},"storage":{"type":"badger"}}` | Configuration for dependency chart jaeger |
+| postgresql.enabled | bool | `false` | Enable to install PostgreSQL along with Grid |
+| postgresql.auth | object | `{"database":"selenium_sessions","password":"seluser","username":"seluser"}` | Authentication should be aligned with config in session map |
+| postgresql.primary.initdb.scripts | object | `{"init.sql":"CREATE TABLE IF NOT EXISTS sessions_map(\n  session_ids varchar(256),\n  session_caps text,\n  session_uri varchar(256),\n  session_stereotype text,\n  session_start varchar(256)\n);\n"}` | Initdb scripts for PostgreSQL to create sessions_map table |
+| redis.enabled | bool | `false` | Enable to install Redis along with Grid |
+| redis.architecture | string | `"standalone"` | Setup architecture |
+| redis.auth.enabled | bool | `false` | Disable authentication due to implementation still not supporting it |
 
diff --git a/charts/selenium-grid/Chart.yaml b/charts/selenium-grid/Chart.yaml
index 2a0cf667ba..fb1aa374c0 100644
--- a/charts/selenium-grid/Chart.yaml
+++ b/charts/selenium-grid/Chart.yaml
@@ -22,6 +22,14 @@ dependencies:
   version: 66.3.0
   name: kube-prometheus-stack
   condition: monitoring.enabled, prometheus-stack.enabled
+- repository: https://charts.bitnami.com/bitnami
+  version: 16.2.3
+  name: postgresql
+  condition: postgresql.enabled
+- repository: https://charts.bitnami.com/bitnami
+  version: 20.4.0
+  name: redis
+  condition: redis.enabled
 maintainers:
   - name: SeleniumHQ
     email: selenium-developers@googlegroups.com
diff --git a/charts/selenium-grid/README.md b/charts/selenium-grid/README.md
index 3511429edb..b72d9ebff5 100644
--- a/charts/selenium-grid/README.md
+++ b/charts/selenium-grid/README.md
@@ -40,6 +40,7 @@ This chart enables the creation of a Selenium Grid Server in Kubernetes.
       * [TLS termination in the ingress controller, HTTP/2, and related troubleshooting](#tls-termination-in-the-ingress-controller-http2-and-related-troubleshooting)
     * [Node Registration](#node-registration)
     * [Configuration of tracing observability](#configuration-of-tracing-observability)
+    * [Configuration of Session Map using External Datastore](#configuration-of-session-map-using-external-datastore)
     * [Configuration of Selenium Grid chart](#configuration-of-selenium-grid-chart)
     * [Configuration of KEDA](#configuration-of-keda)
     * [Configuration of Ingress NGINX Controller](#configuration-of-ingress-nginx-controller)
@@ -873,6 +874,38 @@ tracing:
 By default, the exporter is set to `otlp`. It is wide compatibility with many tracing backends.
 Read more: [vendors](https://opentelemetry.io/ecosystem/vendors/) native support OpenTelemetry and guidelines on [integration](https://opentelemetry.io/ecosystem/integrations/)
 
+### Configuration of Session Map using External Datastore
+
+Feature [documentation](https://www.selenium.dev/documentation/grid/advanced_features/external_datastore/). It requires the Grid deployed in distributed mode. The feature is disabled by default.
+
+To enable it with Database backed Session Map, also install PostgreSQL service in the same namespace as Selenium Grid. You can set the following values:
+
+```yaml
+isolateComponents: true
+components:
+  sessionMap:
+    externalDatastore:
+      enabled: true
+      backend: postgresql
+
+postgresql:
+  enabled: true
+```
+
+To enable it with Redis backed Session Map, also install Redis service in the same namespace as Selenium Grid. You can set the following values:
+
+```yaml
+isolateComponents: true
+components:
+  sessionMap:
+    externalDatastore:
+      enabled: true
+      backend: redis
+
+redis:
+  enabled: true
+```
+
 ### Configuration of Selenium Grid chart
 
 Check out list [configuration](https://github.com/SeleniumHQ/docker-selenium/blob/trunk/charts/selenium-grid/CONFIGURATION.md) parameter of chart and their default values for more details.
diff --git a/charts/selenium-grid/templates/_nameHelpers.tpl b/charts/selenium-grid/templates/_nameHelpers.tpl
index 6968225ee4..38c5267ee1 100644
--- a/charts/selenium-grid/templates/_nameHelpers.tpl
+++ b/charts/selenium-grid/templates/_nameHelpers.tpl
@@ -91,6 +91,13 @@ Event bus ConfigMap fullname
 {{- tpl (default (include "seleniumGrid.component.name" (list "selenium-event-bus-config" $)) .Values.busConfigMap.nameOverride) $ | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
+{{/*
+Session Map ConfigMap fullname
+*/}}
+{{- define "seleniumGrid.sessionMap.configmap.fullname" -}}
+{{- tpl (default (include "seleniumGrid.component.name" (list "selenium-session-map-config" $)) .Values.sessionMapConfigMap.nameOverride) $ | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
 {{/*
 Router fullname
 */}}
diff --git a/charts/selenium-grid/templates/session-map-configmap.yaml b/charts/selenium-grid/templates/session-map-configmap.yaml
new file mode 100644
index 0000000000..da89d54dc7
--- /dev/null
+++ b/charts/selenium-grid/templates/session-map-configmap.yaml
@@ -0,0 +1,45 @@
+{{- if .Values.isolateComponents }}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ template "seleniumGrid.sessionMap.configmap.fullname" . }}
+  namespace: {{ .Release.Namespace }}
+{{- with .Values.sessionMapConfigMap.annotations }}
+  annotations: {{- toYaml . | nindent 4 }}
+{{- end }}
+  labels:
+    {{- include "seleniumGrid.commonLabels" . | nindent 4 }}
+    {{- with .Values.customLabels }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
+data:
+{{- if .Values.components.sessionMap.externalDatastore.enabled }}
+  SE_SESSIONS_MAP_EXTERNAL_DATASTORE: "true"
+{{- $backend := .Values.components.sessionMap.externalDatastore.backend -}}
+{{- with (get .Values.components.sessionMap.externalDatastore $backend) }}
+{{- with .scheme }}
+  SE_SESSIONS_MAP_EXTERNAL_SCHEME: {{ tpl . $ | quote }}
+{{- end }}
+{{- with .implementation }}
+  SE_SESSIONS_MAP_EXTERNAL_IMPLEMENTATION: {{ tpl . $ | quote }}
+{{- end }}
+{{- with .hostname }}
+  SE_SESSIONS_MAP_EXTERNAL_HOSTNAME: {{ tpl . $ | quote }}
+{{- end }}
+{{- with .port }}
+  SE_SESSIONS_MAP_EXTERNAL_PORT: {{ tpl . $ | quote }}
+{{- end }}
+{{- with .jdbcUrl }}
+  SE_SESSIONS_MAP_EXTERNAL_JDBC_URL: {{ tpl . $ | quote }}
+{{- end }}
+{{- with .jdbcUser }}
+  SE_SESSIONS_MAP_EXTERNAL_JDBC_USER: {{ tpl . $ | quote }}
+{{- end }}
+{{- with .jdbcPassword }}
+  SE_SESSIONS_MAP_EXTERNAL_JDBC_PASSWORD: {{ tpl . $ | quote }}
+{{- end }}
+{{- end }}
+{{- else }}
+  SE_SESSIONS_MAP_EXTERNAL_DATASTORE: "false"
+{{- end }}
+{{- end }}
diff --git a/charts/selenium-grid/templates/session-map-deployment.yaml b/charts/selenium-grid/templates/session-map-deployment.yaml
index 8e9a4a158f..8e85cdc603 100644
--- a/charts/selenium-grid/templates/session-map-deployment.yaml
+++ b/charts/selenium-grid/templates/session-map-deployment.yaml
@@ -53,6 +53,8 @@ spec:
             {{- tpl (toYaml .) $ | nindent 12 }}
         {{- end }}
           envFrom:
+            - configMapRef:
+                name: {{ template "seleniumGrid.sessionMap.configmap.fullname" $ }}
             - configMapRef:
                 name: {{ template "seleniumGrid.logging.configmap.fullname" $ }}
             - configMapRef:
diff --git a/charts/selenium-grid/values.yaml b/charts/selenium-grid/values.yaml
index a48ad54f84..d50f3d2ca6 100644
--- a/charts/selenium-grid/values.yaml
+++ b/charts/selenium-grid/values.yaml
@@ -235,6 +235,13 @@ busConfigMap:
   # -- Custom annotations for configmap
   annotations: {}
 
+# ConfigMap that contains environment variables for session map
+sessionMapConfigMap:
+  # -- Override the name of the session map configMap
+  nameOverride:
+  # -- Custom annotations for configmap
+  annotations: {}
+
 distributorConfigMap:
   # -- Override the name of the distributor configMap
   nameOverride:
@@ -597,6 +604,23 @@ components:
     nodeSelector: {}
     # -- Priority class name for Session Map pods
     priorityClassName: ""
+    externalDatastore:
+      # -- Enable external datastore for Session Map
+      enabled: false
+      # -- Backend for external datastore (supported: postgresql, redis). Details for each backend are described below config key
+      backend: postgresql
+      # -- Configure database backed Session Map (https://www.selenium.dev/documentation/grid/advanced_features/external_datastore/#database-backed-session-map)
+      postgresql:
+        implementation: "org.openqa.selenium.grid.sessionmap.jdbc.JdbcBackedSessionMap"
+        jdbcUser: "seluser"
+        jdbcPassword: "seluser"
+        jdbcUrl: "jdbc:postgresql://{{ $.Release.Name }}-postgresql:5432/selenium_sessions"
+      # -- Configure Redis backed Session Map (https://www.selenium.dev/documentation/grid/advanced_features/external_datastore/#redis-backed-session-map)
+      redis:
+        scheme: "redis"
+        implementation: "org.openqa.selenium.grid.sessionmap.redis.RedisBackedSessionMap"
+        hostname: "{{ $.Release.Name }}-redis-master"
+        port: "6379"
 
   # Configuration for Session Queue component
   sessionQueue:
@@ -1851,3 +1875,35 @@ jaeger:
     enabled: false
   query:
     enabled: false
+
+# Configuration for dependency chart PostgreSQL (README: https://artifacthub.io/packages/helm/bitnami/postgresql)
+postgresql:
+  # -- Enable to install PostgreSQL along with Grid
+  enabled: false
+  # -- Authentication should be aligned with config in session map
+  auth:
+    username: "seluser"
+    password: "seluser"
+    database: "selenium_sessions"
+  primary:
+    initdb:
+      # -- Initdb scripts for PostgreSQL to create sessions_map table
+      scripts:
+        init.sql: |
+          CREATE TABLE IF NOT EXISTS sessions_map(
+            session_ids varchar(256),
+            session_caps text,
+            session_uri varchar(256),
+            session_stereotype text,
+            session_start varchar(256)
+          );
+
+# Configuration for dependency chart Redis (README: https://artifacthub.io/packages/helm/bitnami/redis)
+redis:
+  # -- Enable to install Redis along with Grid
+  enabled: false
+  # -- Setup architecture
+  architecture: standalone
+  auth:
+    # -- Disable authentication due to implementation still not supporting it
+    enabled: false
diff --git a/tests/charts/config/ct.yaml b/tests/charts/config/ct.yaml
index e07685901d..79d796166d 100755
--- a/tests/charts/config/ct.yaml
+++ b/tests/charts/config/ct.yaml
@@ -8,6 +8,7 @@ chart-repos:
   - ingressNginx=https://kubernetes.github.io/ingress-nginx
   - jaegertracing=https://jaegertracing.github.io/helm-charts
   - prometheusCommunity=https://prometheus-community.github.io/helm-charts
+  - bitnami=https://charts.bitnami.com/bitnami
 upgrade: false
 helm-extra-args: --timeout 600s
 check-version-increment: false
diff --git a/tests/charts/make/chart_test.sh b/tests/charts/make/chart_test.sh
index e1812e18a0..4d45884b7e 100755
--- a/tests/charts/make/chart_test.sh
+++ b/tests/charts/make/chart_test.sh
@@ -176,6 +176,20 @@ elif [ "${SELENIUM_GRID_AUTOSCALING}" = "true" ] && [ "${TEST_EXISTING_KEDA}" =
   "
 fi
 
+if [ "${TEST_EXTERNAL_DATASTORE}" = "postgresql" ]; then
+  HELM_COMMAND_SET_IMAGES="${HELM_COMMAND_SET_IMAGES} \
+  --set components.sessionMap.externalDatastore.enabled=true \
+  --set components.sessionMap.externalDatastore.backend=postgresql \
+  --set postgresql.enabled=true \
+  "
+elif [ "${TEST_EXTERNAL_DATASTORE}" = "redis" ]; then
+  HELM_COMMAND_SET_IMAGES="${HELM_COMMAND_SET_IMAGES} \
+  --set components.sessionMap.externalDatastore.enabled=true \
+  --set components.sessionMap.externalDatastore.backend=redis \
+  --set redis.enabled=true \
+  "
+fi
+
 if [ "${SELENIUM_GRID_MONITORING}" = "true" ] && [ "${TEST_EXISTING_PTS}" = "true" ]; then
   HELM_COMMAND_SET_IMAGES="${HELM_COMMAND_SET_IMAGES} \
   --set monitoring.enabled=false \
diff --git a/tests/charts/templates/render/dummy.yaml b/tests/charts/templates/render/dummy.yaml
index 682ab40c0c..f91c90da81 100644
--- a/tests/charts/templates/render/dummy.yaml
+++ b/tests/charts/templates/render/dummy.yaml
@@ -115,6 +115,9 @@ components:
     annotations:
       "restartOnUpdate": "true"
     serviceType: NodePort
+    externalDatastore:
+      enabled: true
+      backend: postgresql
 
 chromeNode:
   nodeMaxSessions: 2
diff --git a/tests/charts/templates/render/dummy_solution.yaml b/tests/charts/templates/render/dummy_solution.yaml
index b702d6ec05..d5c1faa16f 100644
--- a/tests/charts/templates/render/dummy_solution.yaml
+++ b/tests/charts/templates/render/dummy_solution.yaml
@@ -106,6 +106,9 @@ selenium-grid:
       serviceType: NodePort
     sessionMap:
       serviceType: NodePort
+      externalDatastore:
+        enabled: true
+        backend: redis
 
   chromeNode:
     nodeMaxSessions: 2

From a7a649ed026de58219eb39eec0010ef45e7722b9 Mon Sep 17 00:00:00 2001
From: Viet Nguyen Duc <nguyenducviet4496@gmail.com>
Date: Wed, 4 Dec 2024 01:33:08 +0700
Subject: [PATCH 2/2] Add docker-compose file for reference [skip ci]

Signed-off-by: Viet Nguyen Duc <nguyenducviet4496@gmail.com>
---
 Base/Dockerfile                               |   2 +
 Distributor/selenium-grid-distributor.conf    |   5 +-
 EventBus/selenium-grid-eventbus.conf          |   5 +-
 Hub/selenium-grid-hub.conf                    |   5 +-
 Router/selenium-grid-router.conf              |   5 +-
 SessionQueue/selenium-grid-session-queue.conf |   5 +-
 Sessions/init.sql                             |   7 +
 Sessions/selenium-grid-sessions.conf          |   5 +-
 docker-compose-v2-tracing.yml                 |   2 +-
 ...ompose-v3-full-grid-external-datastore.yml | 133 ++++++++++++++++++
 docker-compose-v3-full-grid-tracing.yml       |   2 +-
 docker-compose-v3-tracing.yml                 |   2 +-
 12 files changed, 163 insertions(+), 15 deletions(-)
 create mode 100644 Sessions/init.sql
 create mode 100644 docker-compose-v3-full-grid-external-datastore.yml

diff --git a/Base/Dockerfile b/Base/Dockerfile
index 40b4c979f1..348e845746 100644
--- a/Base/Dockerfile
+++ b/Base/Dockerfile
@@ -175,6 +175,8 @@ ENV SE_BIND_HOST=false \
     SE_SUPERVISORD_CHILD_LOG_DIR="/tmp" \
     SE_SUPERVISORD_LOG_FILE="/tmp/supervisord.log" \
     SE_SUPERVISORD_PID_FILE="/tmp/supervisord.pid" \
+    SE_SUPERVISORD_AUTO_RESTART=true \
+    SE_SUPERVISORD_START_RETRIES=5 \
     SE_LOG_TIMESTAMP_FORMAT="%Y-%m-%d %H:%M:%S,%3N" \
     SE_LOG_LEVEL="INFO" \
     SE_HTTP_LOGS=false \
diff --git a/Distributor/selenium-grid-distributor.conf b/Distributor/selenium-grid-distributor.conf
index 0a3dda3163..8bb3e19f06 100644
--- a/Distributor/selenium-grid-distributor.conf
+++ b/Distributor/selenium-grid-distributor.conf
@@ -5,9 +5,10 @@
 priority=0
 command=/opt/bin/start-selenium-grid-distributor.sh
 autostart=true
-autorestart=false
+autorestart=%(ENV_SE_SUPERVISORD_AUTO_RESTART)s
 startsecs=0
-startretries=0
+startretries=%(ENV_SE_SUPERVISORD_START_RETRIES)s
+stopsignal=TERM
 
 ;Logs (all Hub activity redirected to stdout so it can be seen through "docker logs"
 redirect_stderr=true
diff --git a/EventBus/selenium-grid-eventbus.conf b/EventBus/selenium-grid-eventbus.conf
index 3e12c746f8..3409e4f4cd 100644
--- a/EventBus/selenium-grid-eventbus.conf
+++ b/EventBus/selenium-grid-eventbus.conf
@@ -5,9 +5,10 @@
 priority=0
 command=/opt/bin/start-selenium-grid-eventbus.sh
 autostart=true
-autorestart=false
+autorestart=%(ENV_SE_SUPERVISORD_AUTO_RESTART)s
 startsecs=0
-startretries=0
+startretries=%(ENV_SE_SUPERVISORD_START_RETRIES)s
+stopsignal=TERM
 
 ;Logs (all Hub activity redirected to stdout so it can be seen through "docker logs"
 redirect_stderr=true
diff --git a/Hub/selenium-grid-hub.conf b/Hub/selenium-grid-hub.conf
index bd67dae312..42ffbfef93 100644
--- a/Hub/selenium-grid-hub.conf
+++ b/Hub/selenium-grid-hub.conf
@@ -5,9 +5,10 @@
 priority=0
 command=/opt/bin/start-selenium-grid-hub.sh
 autostart=true
-autorestart=false
+autorestart=%(ENV_SE_SUPERVISORD_AUTO_RESTART)s
 startsecs=0
-startretries=0
+startretries=%(ENV_SE_SUPERVISORD_START_RETRIES)s
+stopsignal=TERM
 
 ;Logs (all Hub activity redirected to stdout so it can be seen through "docker logs"
 redirect_stderr=true
diff --git a/Router/selenium-grid-router.conf b/Router/selenium-grid-router.conf
index a5c3dca905..931857bb4c 100644
--- a/Router/selenium-grid-router.conf
+++ b/Router/selenium-grid-router.conf
@@ -5,9 +5,10 @@
 priority=0
 command=/opt/bin/start-selenium-grid-router.sh
 autostart=true
-autorestart=false
+autorestart=%(ENV_SE_SUPERVISORD_AUTO_RESTART)s
 startsecs=0
-startretries=0
+startretries=%(ENV_SE_SUPERVISORD_START_RETRIES)s
+stopsignal=TERM
 
 ;Logs (all Hub activity redirected to stdout so it can be seen through "docker logs"
 redirect_stderr=true
diff --git a/SessionQueue/selenium-grid-session-queue.conf b/SessionQueue/selenium-grid-session-queue.conf
index e82308526e..0511b993c0 100644
--- a/SessionQueue/selenium-grid-session-queue.conf
+++ b/SessionQueue/selenium-grid-session-queue.conf
@@ -5,9 +5,10 @@
 priority=0
 command=/opt/bin/start-selenium-grid-session-queue.sh
 autostart=true
-autorestart=false
+autorestart=%(ENV_SE_SUPERVISORD_AUTO_RESTART)s
 startsecs=0
-startretries=0
+startretries=%(ENV_SE_SUPERVISORD_START_RETRIES)s
+stopsignal=TERM
 
 ;Logs (all Hub activity redirected to stdout so it can be seen through "docker logs"
 redirect_stderr=true
diff --git a/Sessions/init.sql b/Sessions/init.sql
new file mode 100644
index 0000000000..989ee55168
--- /dev/null
+++ b/Sessions/init.sql
@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS sessions_map(
+    session_ids varchar(256),
+    session_caps text,
+    session_uri varchar(256),
+    session_stereotype text,
+    session_start varchar(256)
+ );
diff --git a/Sessions/selenium-grid-sessions.conf b/Sessions/selenium-grid-sessions.conf
index a3b9487ad4..8af1e8855b 100644
--- a/Sessions/selenium-grid-sessions.conf
+++ b/Sessions/selenium-grid-sessions.conf
@@ -5,9 +5,10 @@
 priority=0
 command=/opt/bin/start-selenium-grid-sessions.sh
 autostart=true
-autorestart=false
+autorestart=%(ENV_SE_SUPERVISORD_AUTO_RESTART)s
 startsecs=0
-startretries=0
+startretries=%(ENV_SE_SUPERVISORD_START_RETRIES)s
+stopsignal=TERM
 
 ;Logs (all Hub activity redirected to stdout so it can be seen through "docker logs"
 redirect_stderr=true
diff --git a/docker-compose-v2-tracing.yml b/docker-compose-v2-tracing.yml
index df5df9109b..c0219a95b4 100644
--- a/docker-compose-v2-tracing.yml
+++ b/docker-compose-v2-tracing.yml
@@ -4,7 +4,7 @@
 version: '2'
 services:
   jaeger:
-    image: jaegertracing/all-in-one:1.60
+    image: jaegertracing/all-in-one:latest
     ports:
       - "16686:16686"
       - "4317:4317"
diff --git a/docker-compose-v3-full-grid-external-datastore.yml b/docker-compose-v3-full-grid-external-datastore.yml
new file mode 100644
index 0000000000..8fa7d73507
--- /dev/null
+++ b/docker-compose-v3-full-grid-external-datastore.yml
@@ -0,0 +1,133 @@
+# To execute this docker compose yml file use `docker compose -f docker-compose-v3-full-grid.yml up`
+# Add the `-d` flag at the end for detached execution
+# To stop the execution, hit Ctrl+C, and then `docker compose -f docker-compose-v3-full-grid.yml down`
+version: "3"
+services:
+  selenium-event-bus:
+    image: selenium/event-bus:4.27.0-20241127
+    container_name: selenium-event-bus
+    environment:
+      - SE_ENABLE_TRACING=false
+    ports:
+      - "4442:4442"
+      - "4443:4443"
+      - "5557:5557"
+
+  selenium-sessions:
+    image: selenium/sessions:4.27.0-20241127
+    container_name: selenium-sessions
+    ports:
+      - "5556:5556"
+    depends_on:
+      - selenium-event-bus
+    environment:
+      - SE_EVENT_BUS_HOST=selenium-event-bus
+      - SE_EVENT_BUS_PUBLISH_PORT=4442
+      - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
+      - SE_ENABLE_TRACING=false
+      - SE_SESSIONS_MAP_EXTERNAL_DATASTORE=true
+      - SE_SESSIONS_MAP_EXTERNAL_IMPLEMENTATION=org.openqa.selenium.grid.sessionmap.jdbc.JdbcBackedSessionMap
+      - SE_SESSIONS_MAP_EXTERNAL_JDBC_URL=jdbc:postgresql://postgresql:5432/selenium_sessions
+      - SE_SESSIONS_MAP_EXTERNAL_JDBC_USER=seluser
+      - SE_SESSIONS_MAP_EXTERNAL_JDBC_PASSWORD=seluser
+# Uncomment the following lines to use Redis as the external datastore
+#      - SE_SESSIONS_MAP_EXTERNAL_SCHEME=redis
+#      - SE_SESSIONS_MAP_EXTERNAL_IMPLEMENTATION=org.openqa.selenium.grid.sessionmap.redis.RedisBackedSessionMap
+#      - SE_SESSIONS_MAP_EXTERNAL_HOSTNAME=redis
+#      - SE_SESSIONS_MAP_EXTERNAL_PORT=6379
+
+  postgresql:
+    image: postgres:latest
+    restart: always
+    environment:
+      - POSTGRES_USER=seluser
+      - POSTGRES_PASSWORD=seluser
+      - POSTGRES_DB=selenium_sessions
+    ports:
+      - "5432:5432"
+    volumes:
+      - ./Sessions/init.sql:/docker-entrypoint-initdb.d/init.sql
+
+  redis:
+    image: redis:latest
+    restart: always
+    ports:
+      - "6379:6379"
+
+  selenium-session-queue:
+    image: selenium/session-queue:4.27.0-20241127
+    container_name: selenium-session-queue
+    environment:
+      - SE_ENABLE_TRACING=false
+    ports:
+      - "5559:5559"
+
+  selenium-distributor:
+    image: selenium/distributor:4.27.0-20241127
+    container_name: selenium-distributor
+    ports:
+      - "5553:5553"
+    depends_on:
+      - selenium-event-bus
+      - selenium-sessions
+      - selenium-session-queue
+    environment:
+      - SE_EVENT_BUS_HOST=selenium-event-bus
+      - SE_EVENT_BUS_PUBLISH_PORT=4442
+      - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
+      - SE_SESSIONS_MAP_HOST=selenium-sessions
+      - SE_SESSIONS_MAP_PORT=5556
+      - SE_SESSION_QUEUE_HOST=selenium-session-queue
+      - SE_SESSION_QUEUE_PORT=5559
+      - SE_ENABLE_TRACING=false
+
+  selenium-router:
+    image: selenium/router:4.27.0-20241127
+    container_name: selenium-router
+    ports:
+      - "4444:4444"
+    depends_on:
+      - selenium-distributor
+      - selenium-sessions
+      - selenium-session-queue
+    environment:
+      - SE_DISTRIBUTOR_HOST=selenium-distributor
+      - SE_DISTRIBUTOR_PORT=5553
+      - SE_SESSIONS_MAP_HOST=selenium-sessions
+      - SE_SESSIONS_MAP_PORT=5556
+      - SE_SESSION_QUEUE_HOST=selenium-session-queue
+      - SE_SESSION_QUEUE_PORT=5559
+      - SE_ENABLE_TRACING=false
+
+  chrome:
+    image: selenium/node-chrome:4.27.0-20241127
+    shm_size: 2gb
+    depends_on:
+      - selenium-event-bus
+    environment:
+      - SE_EVENT_BUS_HOST=selenium-event-bus
+      - SE_EVENT_BUS_PUBLISH_PORT=4442
+      - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
+      - SE_ENABLE_TRACING=false
+
+  edge:
+    image: selenium/node-edge:4.27.0-20241127
+    shm_size: 2gb
+    depends_on:
+      - selenium-event-bus
+    environment:
+      - SE_EVENT_BUS_HOST=selenium-event-bus
+      - SE_EVENT_BUS_PUBLISH_PORT=4442
+      - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
+      - SE_ENABLE_TRACING=false
+
+  firefox:
+    image: selenium/node-firefox:4.27.0-20241127
+    shm_size: 2gb
+    depends_on:
+      - selenium-event-bus
+    environment:
+      - SE_EVENT_BUS_HOST=selenium-event-bus
+      - SE_EVENT_BUS_PUBLISH_PORT=4442
+      - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
+      - SE_ENABLE_TRACING=false
diff --git a/docker-compose-v3-full-grid-tracing.yml b/docker-compose-v3-full-grid-tracing.yml
index f0d0b8fd3b..8d43276a55 100644
--- a/docker-compose-v3-full-grid-tracing.yml
+++ b/docker-compose-v3-full-grid-tracing.yml
@@ -4,7 +4,7 @@
 version: "3"
 services:
   jaeger:
-    image: jaegertracing/all-in-one:1.60
+    image: jaegertracing/all-in-one:latest
     ports:
       - "16686:16686"
       - "4317:4317"
diff --git a/docker-compose-v3-tracing.yml b/docker-compose-v3-tracing.yml
index 847dd38402..412cedd6b0 100644
--- a/docker-compose-v3-tracing.yml
+++ b/docker-compose-v3-tracing.yml
@@ -4,7 +4,7 @@
 version: "3"
 services:
   jaeger:
-    image: jaegertracing/all-in-one:1.60
+    image: jaegertracing/all-in-one:latest
     ports:
       - "16686:16686"
       - "4317:4317"