Configure jira session timeout (#987)

* Make Jira session timeout configurable

* Add default test

* Fix comment

---------

Co-authored-by: Yevhen Ivantsov <[email protected]>

Author: bianchi2

docs/docs/containers/JIRA.md

@@ -519,6 +519,10 @@ as a non-root user.
 
   See: [How to clear Jira's plugin cache](https://confluence.atlassian.com/jirakb/how-to-clear-jira-s-plugin-cache-1157468195.html).
 
+* `ATL_JIRA_SESSION_TIMEOUT`
+
+  The default Tomcat session timeout (in minutes) for all newly created sessions which is set in web.xml. Defaults to 30.
+
 ### Advanced Configuration
 
 As mentioned at the top of this section, the settings from the environment are

src/main/charts/jira/README.md

@@ -131,6 +131,7 @@ Kubernetes: `>=1.21.x-0`
 | jira.service.sessionAffinityConfig | object | `{"clientIP":{"timeoutSeconds":null}}` | Session affinity configuration  |
 | jira.service.sessionAffinityConfig.clientIP.timeoutSeconds | string | `nil` | Specifies the seconds of ClientIP type session sticky time. The value must be > 0 && <= 86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800 (for 3 hours).  |
 | jira.service.type | string | `"ClusterIP"` | The type of K8s service to use for Jira  |
+| jira.session.timeout | string | `nil` | User session timeout. Set to 30 minutes in web.xml  |
 | jira.setPermissions | bool | `true` | Boolean to define whether to set local home directory permissions on startup of Jira container. Set to 'false' to disable this behaviour.  |
 | jira.shutdown.command | string | `"/shutdown-wait.sh"` | By default pods will be stopped via a [preStop hook](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/), using a script supplied by the Docker image. If any other shutdown behaviour is needed it can be achieved by overriding this value. Note that the shutdown command needs to wait for the application shutdown completely before exiting; see [the default command](https://bitbucket.org/atlassian-docker/docker-atlassian-jira/src/master/shutdown-wait.sh) for details.  |
 | jira.shutdown.terminationGracePeriodSeconds | int | `30` | The termination grace period for pods during shutdown. This should be set to the internal grace period, plus a small buffer to allow the JVM to fully terminate.  |

src/main/charts/jira/templates/statefulset.yaml

@@ -122,6 +122,10 @@ spec:
           image: {{ include "jira.image" . | quote }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           env:
+            {{- if .Values.jira.session.timeout }}
+            - name: ATL_JIRA_SESSION_TIMEOUT
+              value: {{ .Values.jira.session.timeout | quote }}
+            {{- end }}
             {{- include "jira.tunnelVars" . | nindent 12 }}
             {{ if .Values.ingress.https }}
             - name: ATL_TOMCAT_SCHEME

src/main/charts/jira/values.yaml

@@ -712,6 +712,12 @@ jira:
       #
       endpointOverride:
 
+  session:
+
+    # -- User session timeout. Set to 30 minutes in web.xml
+    #
+    timeout:
+
   # Data Center clustering
   #
   clustering:

src/test/java/test/ContainersTest.java

@@ -133,4 +133,28 @@ void nfx_permission_fixer_container_default_custom_resources(Product product) th
         assertThat(nfsPermissionFixerContainer.get("resources").get("limits").get("cpu")).hasValueEqualTo(2);
         assertThat(nfsPermissionFixerContainer.get("resources").get("limits").get("memory")).hasTextEqualTo("3Gi");
     }
+
+    @ParameterizedTest
+    @EnumSource(value = Product.class, names = {"jira"}, mode = EnumSource.Mode.INCLUDE)
+    void jira_session_timeout(Product product) throws Exception {
+        final var pname = product.name().toLowerCase();
+        final var resources = helm.captureKubeResourcesFromHelmChart(product, Map.of(
+                pname+".session.timeout", "60"
+        ));
+
+        final var statefulSet = resources.getStatefulSet(product.getHelmReleaseName());
+        final var env = statefulSet.getContainer().getEnv();
+        env.assertHasValue("ATL_JIRA_SESSION_TIMEOUT", "60");
+    }
+
+    @ParameterizedTest
+    @EnumSource(value = Product.class, names = {"jira"}, mode = EnumSource.Mode.INCLUDE)
+    void jira_session_timeout_default(Product product) throws Exception {
+        final var pname = product.name().toLowerCase();
+        final var resources = helm.captureKubeResourcesFromHelmChart(product, Map.of());
+
+        final var statefulSet = resources.getStatefulSet(product.getHelmReleaseName());
+        final var env = statefulSet.getContainer().getEnv();
+        env.assertDoesNotHaveAnyOf("ATL_JIRA_SESSION_TIMEOUT");
+    }
 }

src/test/resources/expected_helm_output/jira/output.yaml

@@ -213,6 +213,8 @@ data:
           clientIP:
             timeoutSeconds: null
         type: ClusterIP
+      session:
+        timeout: null
       setPermissions: true
       shutdown:
         command: /shutdown-wait.sh