diff --git a/articles/tools/kubernetes/configuration.adoc b/articles/tools/kubernetes/configuration.adoc index 79092b7dbc..e9f9f5e55e 100644 --- a/articles/tools/kubernetes/configuration.adoc +++ b/articles/tools/kubernetes/configuration.adoc @@ -9,6 +9,54 @@ order: 120 = Configuring Kubernetes Kit +== Common Settings + +|=== +| Property | Description | Default Value + +| `vaadin.kubernetes.auto-configure` +| Enables or disables the Kit auto configuration +| `true` + +| `vaadin.kubernetes.cluster-key-cookie-name` +| Sets the name of the distributed storage session key cookie. +| `clusterKey` + +| `vaadin.kubernetes.cluster-key-cookie-same-site` +| Sets the value of the distributed storage session key cookie's SameSite attribute. +(`Strict`, `Lax`, `None`) +| `Strict` + +| `vaadin.kubernetes.backend-session-expiration-tolerance` +| Amount of time to be added to the HTTP session timeout to determine the expiration of the backend session. If not set, backend session never expires. See <> for details. +| + + +|=== + +== Serialization Properties + +|=== +| Property | Description | Default Value + +| `vaadin.serialization.timeout` +| Sets the timeout in milliseconds to wait for the serialization to be completed. +| 30000 (30 seconds) + +| `vaadin.serialization.optimistic-timeout` +| Sets the timeout in milliseconds to wait for the optimistic serialization to be completed. +| 30000 (30 seconds) + +| `vaadin.serialization.optimistic-delay` +| Sets the delay in milliseconds to wait between optimistic serialization attempts. +| 10 + +| `vaadin.serialization.deserialization-lock-timeout` +| Sets the timeout in milliseconds to wait for the deserialization lock to be released if the deserialization is not completed. +| 10000 (10 seconds) + +|=== + == Packages Inspected during Serialization When a session is serialized, Kubernetes Kit inspects classes for transient fields that can be injected during deserialization (see <>). @@ -39,7 +87,8 @@ vaadin: == Hazelcast for Session Replication -The `service-name` property defines the name of the Hazelcast service deployment within a cluster. +The `service-name` and `service-port` properties defines the endpoint of the Hazelcast service deployment within a cluster. +If `service-port` is specified with a value greater than 0, it overrides the default Hazelcast port (5701). The optional `namespace` property is used when the Hazelcast service is deployed in a namespace other than `default`. @@ -63,6 +112,13 @@ vaadin: ---- -- +[NOTE] +==== +By default, Hazelcast installs a shutdown hook to stop the instance when the JVM shuts down. +Kubernetes Kit requires the shutdown hook to be disabled to ensure that the latest session state can be persisted when the application stops. +The Kit automatically applies the configuration; however, if the application provides a custom `HazelcastInstance` bean, it is important that it is configured with `hazelcast.shutdownhook.enabled=false`. A warning message is printed on the console at startup if the shutdown hook is enabled. +Spring takes care of automatically gracefully stop the Hazelcast instance when the bean is destroyed. +==== == Redis for Session Replication