Skip to content

Commit 477c28e

Browse files
mcollovatiheruanmshabarov
authored
docs: improve Kubernetes Kit configuration documentation (#4827)
* docs: improve Kubernetes Kit configuration documentation Fixes vaadin/kubernetes-kit#248 * vale fixes * Apply suggestion * Update articles/tools/kubernetes/configuration.adoc Co-authored-by: Giovanni Lovato <[email protected]> --------- Co-authored-by: Giovanni Lovato <[email protected]> Co-authored-by: Mikhail Shabarov <[email protected]>
1 parent 76e05f8 commit 477c28e

File tree

1 file changed

+57
-1
lines changed

1 file changed

+57
-1
lines changed

articles/tools/kubernetes/configuration.adoc

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,54 @@ order: 120
99

1010
= Configuring Kubernetes Kit
1111

12+
== Common Settings
13+
14+
|===
15+
| Property | Description | Default Value
16+
17+
| `vaadin.kubernetes.auto-configure`
18+
| Enables or disables the Kit auto configuration
19+
| `true`
20+
21+
| `vaadin.kubernetes.cluster-key-cookie-name`
22+
| Sets the name of the distributed storage session key cookie.
23+
| `clusterKey`
24+
25+
| `vaadin.kubernetes.cluster-key-cookie-same-site`
26+
| Sets the value of the distributed storage session key cookie's SameSite attribute.
27+
(`Strict`, `Lax`, `None`)
28+
| `Strict`
29+
30+
| `vaadin.kubernetes.backend-session-expiration-tolerance`
31+
| 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 <<Backend Session Expiration Policy>> for details.
32+
|
33+
34+
35+
|===
36+
37+
== Serialization Properties
38+
39+
|===
40+
| Property | Description | Default Value
41+
42+
| `vaadin.serialization.timeout`
43+
| Sets the timeout in milliseconds to wait for the serialization to be completed.
44+
| 30000 (30 seconds)
45+
46+
| `vaadin.serialization.optimistic-timeout`
47+
| Sets the timeout in milliseconds to wait for the optimistic serialization to be completed.
48+
| 30000 (30 seconds)
49+
50+
| `vaadin.serialization.optimistic-delay`
51+
| Sets the delay in milliseconds to wait between optimistic serialization attempts.
52+
| 10
53+
54+
| `vaadin.serialization.deserialization-lock-timeout`
55+
| Sets the timeout in milliseconds to wait for the deserialization lock to be released if the deserialization is not completed.
56+
| 10000 (10 seconds)
57+
58+
|===
59+
1260
== Packages Inspected during Serialization
1361

1462
When a session is serialized, Kubernetes Kit inspects classes for transient fields that can be injected during deserialization (see <<session-replication#,session replication>>).
@@ -39,7 +87,8 @@ vaadin:
3987

4088
== Hazelcast for Session Replication
4189

42-
The `service-name` property defines the name of the Hazelcast service deployment within a cluster.
90+
The `service-name` and `service-port` properties defines the endpoint of the Hazelcast service deployment within a cluster.
91+
If `service-port` is specified with a value greater than 0, it overrides the default Hazelcast port (5701).
4392

4493
The optional `namespace` property is used when the Hazelcast service is deployed in a namespace other than `default`.
4594

@@ -63,6 +112,13 @@ vaadin:
63112
----
64113
--
65114

115+
[NOTE]
116+
====
117+
By default, Hazelcast installs a shutdown hook to stop the instance when the JVM shuts down.
118+
Kubernetes Kit requires the shutdown hook to be disabled to ensure that the latest session state can be persisted when the application stops.
119+
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.
120+
Spring takes care of automatically gracefully stop the Hazelcast instance when the bean is destroyed.
121+
====
66122

67123
== Redis for Session Replication
68124

0 commit comments

Comments
 (0)