Document add-opens flags for Java 17, #31087 (#31685)

akka · Oct 18, 2022 · d676904 · d676904
1 parent fc6faa4
commit d676904
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/akka-docs/src/main/paradox/persistence.md b/akka-docs/src/main/paradox/persistence.md
@@ -848,6 +848,12 @@ in your Akka configuration. Also note that for the LevelDB Java port, you will n
   version="0.9"
 }
 
+@@@ note { title="Java 17" }
+
+When using LevelDB with Java 17 you have to add JVM flag `--add-opens=java.base/java.nio=ALL-UNNAMED`. 
+
+@@@
+
 @@@ warning
 
 It is not possible to test persistence provided classes (i.e. `PersistentActor`

diff --git a/akka-docs/src/main/paradox/remoting-artery.md b/akka-docs/src/main/paradox/remoting-artery.md
@@ -43,6 +43,12 @@ The Aeron dependency needs to be explicitly added if using the `aeron-udp` trans
   version2="$aeron_version$"
 }
 
+@@@ note { title="Java 17" }
+
+When using Aeron with Java 17 you have to add JVM flag `--add-opens=java.base/sun.nio.ch=ALL-UNNAMED`.
+
+@@@
+
 ## Configuration
 
 To enable remote capabilities in your Akka project you should, at a minimum, add the following changes

diff --git a/akka-docs/src/main/paradox/typed/cluster-sharding.md b/akka-docs/src/main/paradox/typed/cluster-sharding.md
@@ -634,6 +634,13 @@ Reasons for disabling:
 
 For supporting remembered entities in an environment without disk storage use `eventsourced` mode instead.
 
+@@@ note { title="Java 17" }
+
+When using `remember-entities-store=ddata` the remember entities store is persisted to disk by LMDB.
+When running with Java 17 you have to add JVM flags `--add-opens=java.base/sun.nio.ch=ALL-UNNAMED --add-opens=java.base/java.nio=ALL-UNNAMED`.
+
+@@@
+
 #### Event sourced mode
 
 Enable `eventsourced` mode with:

diff --git a/akka-docs/src/main/paradox/typed/distributed-data.md b/akka-docs/src/main/paradox/typed/distributed-data.md
@@ -675,6 +675,12 @@ possible to replace that with another implementation by implementing the actor p
 `akka.cluster.ddata.DurableStore` and defining the `akka.cluster.distributed-data.durable.store-actor-class`
 property for the new implementation.
 
+@@@ note { title="Java 17" }
+
+When using LMDB with Java 17 you have to add JVM flags `--add-opens=java.base/sun.nio.ch=ALL-UNNAMED --add-opens=java.base/java.nio=ALL-UNNAMED`.
+
+@@@
+
 The location of the files for the data is configured with:
 
 Scala