Skip to content

Commit 3d3cec1

Browse files
authored
Revise SapMachine version support in documentation
Updated SapMachine documentation to reflect the support for Java versions 17, 21, and 25. Removed outdated information regarding Java 11 and added notes on version management.
1 parent 2dc219f commit 3d3cec1

File tree

1 file changed

+42
-48
lines changed

1 file changed

+42
-48
lines changed

docs/30-development/sapmachine-785d6b3.md

Lines changed: 42 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# SapMachine
44

5-
SapMachine is an alternative to SAP JVM, and provides a Java Runtime Environment \(JRE\) with Java 11, 17, and 21.
5+
SapMachine provides a Java Runtime Environment \(JRE\) with Java 17, 21, and 25.
66

77

88

@@ -19,13 +19,6 @@ SapMachine works with the following application containers:
1919
- [Java Main](java-main-8a1786a.md)
2020

2121

22-
> ### Caution:
23-
> **Only relevant to SAP Java Buildpack 1:**
24-
>
25-
> Bear in mind that TomEE 7 supports only Java 7 and 8. Thus, even if your TomEE 7 application runs successfully with SapMachine JRE 17, at some point it might crash. Also, TomEE 7 has already [reached end of life](https://tomee.apache.org/tomee-7.1-eol.html). See: [Discontinued TomEE versions](https://tomee.apache.org/download-discontinued.html)
26-
27-
28-
2922
<a name="loio785d6b390b834bee818e242160f87df5__section_jre"/>
3023

3124
## Activation Using JRE
@@ -42,12 +35,11 @@ applications:
4235
...
4336
```
4437

45-
Without specifying a particular JRE version, your application will use the following default offline JRE, bundled within the buildpack:
46-
47-
- For SAP Java Buildpack 1 – SapMachine JRE 11
38+
Without specifying a particular JRE version, your application will currently use the following default offline JRE, bundled within the buildpack:
4839

4940
- For SAP Java Buildpack 2 – SapMachine JRE 17
5041

42+
NOTE: The default major version of the SapMachine JRE will be raised from 17 to either 21 or 25. This only matters when the major version isn’t explicitly specified.
5143

5244
To specify a particular JRE version, use environment variable JBP\_CONFIG\_SAP\_MACHINE\_JRE.
5345

@@ -57,9 +49,12 @@ If you set this parameter to *false*, the buildpack will attempt to download Sap
5749

5850

5951

60-
### SapMachine 11
52+
### SapMachine 17
53+
54+
> ### Tip:
55+
> SAP Java Buildpack 2 provide a customized SapMachine JRE 17 that contains a [jdk.compiler](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/module-summary.html) module.
6156
62-
To stay secure, use the latest stable version of SapMachine JRE 11, which is available in the major version. Set the JBP\_CONFIG\_SAP\_MACHINE\_JRE variable like this:
57+
To stay secure, use the latest stable version, which is available in the major version of SapMachine JRE 17. Set the JBP\_CONFIG\_SAP\_MACHINE\_JRE variable like this:
6358

6459
```
6560
---
@@ -68,10 +63,10 @@ applications:
6863
...
6964
env:
7065
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']"
71-
JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 11.+ }'
66+
JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 17.+ }'
7267
```
7368

74-
In some cases, it can be helpful to pin a particular published version of SapMachine JRE 11. To make the buildpack download this JRE version \(for example, 11.0.28\), specify it the following way:
69+
In some cases, it can be helpful to pin a particular published version of SapMachine JRE 17. To make the buildpack download this JRE version \(for example, 17.0.17\), specify it the following way:
7570

7671
```
7772
---
@@ -80,20 +75,20 @@ applications:
8075
...
8176
env:
8277
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']"
83-
JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 11.0.28 }'
78+
JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 17.0.17 }'
8479
...
8580
```
8681

8782
**NOTE:** To stay secure, you need to update this version string on your own. For this reason, SAP does **not** recommend this approach.
8883

8984

9085

91-
### SapMachine 17
86+
### SapMachine 21
9287

9388
> ### Tip:
94-
> SAP Java Buildpack 1 and 2 provide a customized SapMachine JRE 17 that contains a [jdk.compiler](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/module-summary.html) module.
89+
> SAP Java Buildpack 2 provides a customized SapMachine JRE 21 that contains a [jdk.compiler](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/module-summary.html) module.
9590
96-
To stay secure, use the latest stable version, which is available in the major version of SapMachine JRE 17. Set the JBP\_CONFIG\_SAP\_MACHINE\_JRE variable like this:
91+
To stay secure, use the latest stable version, which is available in the major version of SapMachine JRE 21. Set the JBP\_CONFIG\_SAP\_MACHINE\_JRE variable like this:
9792

9893
```
9994
---
@@ -102,10 +97,10 @@ applications:
10297
...
10398
env:
10499
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']"
105-
JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 17.+ }'
100+
JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 21.+ }'
106101
```
107102

108-
In some cases, it can be helpful to pin a particular published version of SapMachine JRE 17. To make the buildpack download this JRE version \(for example, 17.0.16\), specify it the following way:
103+
In some cases, it can be helpful to pin a particular published version of SapMachine JRE 21. To make the buildpack download this JRE version \(for example, 21.0.9\), specify it the following way:
109104

110105
```
111106
---
@@ -114,20 +109,20 @@ applications:
114109
...
115110
env:
116111
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']"
117-
JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 17.0.16 }'
112+
JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 21.0.9 }'
118113
...
119114
```
120115

121116
**NOTE:** To stay secure, you need to update this version string on your own. For this reason, SAP does **not** recommend this approach.
122117

123118

124119

125-
### SapMachine 21
120+
### SapMachine 25
126121

127122
> ### Tip:
128-
> SAP Java Buildpack 2 provides a customized SapMachine JRE 21 that contains a [jdk.compiler](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/module-summary.html) module.
123+
> SAP Java Buildpack 2 provides a customized SapMachine JRE 25 that contains a [jdk.compiler](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/module-summary.html) module.
129124
130-
To stay secure, use the latest stable version, which is available in the major version of SapMachine JRE 21. Set the JBP\_CONFIG\_SAP\_MACHINE\_JRE variable like this:
125+
To stay secure, use the latest stable version, which is available in the major version of SapMachine JRE 25. Set the JBP\_CONFIG\_SAP\_MACHINE\_JRE variable like this:
131126

132127
```
133128
---
@@ -136,10 +131,10 @@ applications:
136131
...
137132
env:
138133
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']"
139-
JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 21.+ }'
134+
JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 25.+ }'
140135
```
141136

142-
In some cases, it can be helpful to pin a particular published version of SapMachine JRE 21. To make the buildpack download this JRE version \(for example, 21.0.8\), specify it the following way:
137+
In some cases, it can be helpful to pin a particular published version of SapMachine JRE 25. To make the buildpack download this JRE version \(for example, 25.0.1\), specify it the following way:
143138

144139
```
145140
---
@@ -148,7 +143,7 @@ applications:
148143
...
149144
env:
150145
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']"
151-
JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 21.0.8 }'
146+
JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 25.0.1 }'
152147
...
153148
```
154149

@@ -173,17 +168,17 @@ applications:
173168
```
174169

175170
> ### Note:
176-
> SapMachine JDK is **not bundled** within the buildpack. Therefore, if you want to use SapMachine JDK 11, 17 or 21, you have to download it from the [GitHub project](https://sap.github.io/SapMachine/) as an online component.
171+
> SapMachine JDK is **not bundled** within the buildpack. Therefore, if you want to use SapMachine JDK 17, 21 or 25, you have to download it from the [GitHub project](https://sap.github.io/SapMachine/) as an online component.
177172
>
178-
> However, you can use the [jdk.compiler](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/module-summary.html) module, which is **provided** by the buildpack as part of the customized SapMachine JRE, v. 17 and 21. To learn more, see section [Activation Using JRE](sapmachine-785d6b3.md#loio785d6b390b834bee818e242160f87df5__section_jre).
173+
> However, you can use the [jdk.compiler](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/module-summary.html) module, which is **provided** by the buildpack as part of the customized SapMachine JRE, v. 17, 21, and 25. To learn more, see section [Activation Using JRE](sapmachine-785d6b3.md#loio785d6b390b834bee818e242160f87df5__section_jre).
179174
180-
To specify an online JDK version \(11, 17, or 21\), use environment variable JBP\_CONFIG\_SAP\_MACHINE\_JDK.
175+
To specify an online JDK version \(17, 21, or 25\), use environment variable JBP\_CONFIG\_SAP\_MACHINE\_JDK.
181176

182177

183178

184-
### SapMachine 11
179+
### SapMachine 17
185180

186-
To stay secure, use the latest stable version, which is available in the major version of SapMachine JDK 11. Set the JBP\_CONFIG\_SAP\_MACHINE\_JDK variable like this:
181+
To stay secure, use the latest stable version, which is available in the major version of SapMachine JDK 17. Set the JBP\_CONFIG\_SAP\_MACHINE\_JDK variable like this:
187182

188183
```
189184
---
@@ -192,10 +187,10 @@ applications:
192187
...
193188
env:
194189
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']"
195-
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 11.+ }'
190+
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 17.+ }'
196191
```
197192

198-
In some cases, it can be helpful to pin a particular published version of SapMachine JDK 11. To make the buildpack download this JDK version \(for example, 11.0.28\), specify it the following way:
193+
In some cases, it can be helpful to pin a particular published version of SapMachine JDK 17. To make the buildpack download this JDK version \(for example, 17.0.16\), specify it the following way:
199194

200195
```
201196
---
@@ -204,17 +199,17 @@ applications:
204199
...
205200
env:
206201
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']"
207-
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 11.0.28 }'
202+
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 17.0.17 }'
208203
...
209204
```
210205

211206
**NOTE:** To stay secure, you need to update this version string on your own. For this reason, SAP does **not** recommend this approach.
212207

213208

214209

215-
### SapMachine 17
210+
### SapMachine 21
216211

217-
To stay secure, use the latest stable version, which is available in the major version of SapMachine JDK 17. Set the JBP\_CONFIG\_SAP\_MACHINE\_JDK variable like this:
212+
To stay secure, use the latest stable version, which is available in the major version of SapMachine JDK 21. Set the JBP\_CONFIG\_SAP\_MACHINE\_JDK variable like this:
218213

219214
```
220215
---
@@ -223,10 +218,10 @@ applications:
223218
...
224219
env:
225220
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']"
226-
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 17.+ }'
221+
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 21.+ }'
227222
```
228223

229-
In some cases, it can be helpful to pin a particular published version of SapMachine JDK 17. To make the buildpack download this JDK version \(for example, 17.0.16\), specify it the following way:
224+
In some cases, it can be helpful to pin a particular published version of SapMachine JDK 21. To make the buildpack download this JDK version \(for example, 21.0.9\), specify it the following way:
230225

231226
```
232227
---
@@ -235,17 +230,17 @@ applications:
235230
...
236231
env:
237232
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']"
238-
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 17.0.16 }'
233+
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 21.0.9 }'
239234
...
240235
```
241236

242237
**NOTE:** To stay secure, you need to update this version string on your own. For this reason, SAP does **not** recommend this approach.
243238

244239

245240

246-
### SapMachine 21
241+
### SapMachine 25
247242

248-
To stay secure, use the latest stable version, which is available in the major version of SapMachine JDK 21. Set the JBP\_CONFIG\_SAP\_MACHINE\_JDK variable like this:
243+
To stay secure, use the latest stable version, which is available in the major version of SapMachine JDK 25. Set the JBP\_CONFIG\_SAP\_MACHINE\_JDK variable like this:
249244

250245
```
251246
---
@@ -254,10 +249,10 @@ applications:
254249
...
255250
env:
256251
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']"
257-
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 21.+ }'
252+
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 25.+ }'
258253
```
259254

260-
In some cases, it can be helpful to pin a particular published version of SapMachine JDK 21. To make the buildpack download this JDK version \(for example, 21.0.8\), specify it the following way:
255+
In some cases, it can be helpful to pin a particular published version of SapMachine JDK 25. To make the buildpack download this JDK version \(for example, 25.0.1\), specify it the following way:
261256

262257
```
263258
---
@@ -266,16 +261,15 @@ applications:
266261
...
267262
env:
268263
JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']"
269-
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 21.0.8 }'
264+
JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 25.0.1 }'
270265
...
271266
```
272267

273268
**NOTE:** To stay secure, you need to update this version string on your own. For this reason, SAP does **not** recommend this approach.
274-
275269
**Related Information**
276270

277271

278-
[https://sap.github.io/SapMachine/](https://sap.github.io/SapMachine/)
272+
[https://sapmachine.io/](https://sapmachine.io/)
279273

280274
[Runtimes and Containers](runtimes-and-containers-83d2416.md "Find out which application runtimes and containers you can use, depending on the Java buildpack your application is using.")
281275

0 commit comments

Comments
 (0)