Skip to content

Commit 524159d

Browse files
authored
Docs: Drop JDK 7 support and remove MetaspaceSize options (#838)
1 parent 29e8b2a commit 524159d

File tree

3 files changed

+6
-36
lines changed

3 files changed

+6
-36
lines changed

openam-documentation/openam-doc-source/src/main/asciidoc/admin-guide/chap-tuning.adoc

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -254,14 +254,6 @@ a|`-server`
254254
a|-
255255
a|Ensures the server JVM is used
256256
257-
a|`-XX:PermSize` & `-XX:MaxPermSize` (JDK 7)
258-
a|Set both to 256 MB
259-
a|Controls the size of the permanent generation in the JVM
260-
261-
a|`-XX:MetaspaceSize` & `-XX:MaxMetaspaceSize` (JDK 8)
262-
a|Set both to 256 MB
263-
a|Controls the size of the metaspace in the JVM
264-
265257
a|`-Dsun.net.client.defaultReadTimeout`
266258
a|60000
267259
a|Controls the read timeout in the Java HTTP client implementation

openam-documentation/openam-doc-source/src/main/asciidoc/deployment-planning/chap-hw-sw-requirements.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Check your assumptions in testing. For example, make sure that logs are cleaned
127127
[#ram-requirements]
128128
==== Random Access Memory Requirements
129129
130-
OpenAM core services require a minimum JVM heap size of 1 GB and, when running on JDK 7, a minimum permanent generation size of 256 MB. If you are including the embedded OpenDJ directory, OpenAM requires at least a 2 GB heap, as 50% of that space is allocated to OpenDJ.
130+
OpenAM core services require a minimum JVM heap size of 1 GB and. If you are including the embedded OpenDJ directory, OpenAM requires at least a 2 GB heap, as 50% of that space is allocated to OpenDJ.
131131
132132
[NOTE]
133133
====

openam-documentation/openam-doc-source/src/main/asciidoc/install-guide/chap-prepare-install.adoc

Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -57,26 +57,11 @@ OpenAM software depends on a Java runtime environment. Check the output of `java
5757
==== Settings For Sun/Oracle Java Environments
5858
5959
--
60-
When using a Sun or Oracle Java environment set at least the following options.
60+
When using an Adoptium, Azul or Oracle Java environment set at least the following options.
6161
6262
`-server`::
6363
Use `-server` rather than `-client`.
6464
65-
`-Xmx1g` (minimum)::
66-
OpenAM requires at least a 1 GB heap. If you are including the embedded OpenDJ directory, OpenAM requires at least a 2 GB heap, as 50% of that space is allocated to OpenDJ. Higher volume and higher performance deployments require additional heap space.
67-
68-
`-XX:PermSize=256m` (when using JDK 7)::
69-
Set the permanent generation size to 256 MB.
70-
71-
`-XX:MaxPermSize=256m` (when using JDK 7)::
72-
Set the maximum permanent generation size to 256 MB.
73-
74-
`-XX:MetaspaceSize=256m` (when using JDK 8)::
75-
Set the metaspace memory size to 256 MB.
76-
77-
`-XX:MaxMetaspaceSize=256m` (when using JDK 8)::
78-
Set the maximum metaspace memory size to 256 MB.
79-
8065
8166
[IMPORTANT]
8267
====
@@ -107,9 +92,6 @@ When using an IBM Java environment set at least the following options.
10792
`-DamCryptoDescriptor.provider=IBMJCE`,`-DamKeyGenDescriptor.provider=IBMJCE`::
10893
Use the IBM Java Cryptography Extensions.
10994
110-
`-Xmx1024m` (minimum)::
111-
OpenAM requires at least a 1 GB heap. If you are including the embedded OpenDJ directory, OpenAM requires at least a 2 GB heap, as 50% of that space is allocated to OpenDJ. Higher volume and higher performance deployments require additional heap space.
112-
11395
--
11496
11597
@@ -1377,7 +1359,7 @@ You should also ensure `sslProtocol` is set to `TLS`, which disables the potenti
13771359
maxThreads="150" scheme="https" secure="true"
13781360
clientAuth="false" sslProtocol="TLS" URIEncoding="UTF-8" />
13791361
----
1380-
The following example script, `/etc/init.d/tomcat`, manages the service at system startup and shutdown. This script assumes you run OpenAM as the user `openam` and that you use Oracle JDK 7.
1362+
The following example script, `/etc/init.d/tomcat`, manages the service at system startup and shutdown. This script assumes you run OpenAM as the user `openam` and that you use Oracle JDK 8.
13811363
13821364
[source, shell]
13831365
----
@@ -1391,7 +1373,7 @@ CATALINA_HOME="/path/to/tomcat"
13911373
export CATALINA_HOME
13921374
JAVA_HOME=/path/to/jdk
13931375
export JAVA_HOME
1394-
CATALINA_OPTS="-server -Xmx2g -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=256m"
1376+
CATALINA_OPTS="-server"
13951377
export CATALINA_OPTS
13961378
13971379
case "${1}" in
@@ -1417,7 +1399,7 @@ One possible workaround is to configure Tomcat to allow encoded slash characters
14171399
14181400
[source]
14191401
----
1420-
CATALINA_OPTS= "-server -Xmx2g -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=256m \
1402+
CATALINA_OPTS= "-server \
14211403
-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true"
14221404
----
14231405
@@ -1485,10 +1467,6 @@ After configuring JBoss or WildFly, you then prepare OpenAM for deployment by ma
14851467
.. Open the `standalone.conf` file in the `/path/to/jboss/bin` directory for JBoss or WildFly in standalone mode.
14861468
14871469
.. Check the JVM settings associated with `JAVA_OPTS`.
1488-
+
1489-
Change the JVM heap size to `-Xmx1024m`. The default JVM heap size for some versions of JBoss might already exceed the recommended value. If you are using the embedded version of OpenDJ, the minimum heap size may be higher. For details on the JVM options to use, see xref:#prepare-java["Preparing a Java Environment"].
1490-
+
1491-
Change the metaspace size to `-XX:MaxMetaspaceSize=256m` if the default size does not exceed this amount.
14921470
14931471
.. Set the following JVM `JAVA_OPTS` setting in the same file:
14941472
+

0 commit comments

Comments
 (0)