-
Notifications
You must be signed in to change notification settings - Fork 117
Revise SapMachine version support in documentation #287
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |||||
|
|
||||||
| # SapMachine | ||||||
|
|
||||||
| SapMachine is an alternative to SAP JVM, and provides a Java Runtime Environment \(JRE\) with Java 11, 17, and 21. | ||||||
| SapMachine provides a Java Runtime Environment \(JRE\) with Java 17, 21, and 25. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@@ -19,13 +19,6 @@ SapMachine works with the following application containers: | |||||
| - [Java Main](java-main-8a1786a.md) | ||||||
|
|
||||||
|
|
||||||
| > ### Caution: | ||||||
| > **Only relevant to SAP Java Buildpack 1:** | ||||||
| > | ||||||
| > 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) | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| <a name="loio785d6b390b834bee818e242160f87df5__section_jre"/> | ||||||
|
|
||||||
| ## Activation Using JRE | ||||||
|
|
@@ -42,12 +35,11 @@ applications: | |||||
| ... | ||||||
| ``` | ||||||
|
|
||||||
| Without specifying a particular JRE version, your application will use the following default offline JRE, bundled within the buildpack: | ||||||
|
|
||||||
| - For SAP Java Buildpack 1 – SapMachine JRE 11 | ||||||
| Without specifying a particular JRE version, your application will currently use the following default offline JRE, bundled within the buildpack: | ||||||
|
|
||||||
| - For SAP Java Buildpack 2 – SapMachine JRE 17 | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| To specify a particular JRE version, use environment variable JBP\_CONFIG\_SAP\_MACHINE\_JRE. | ||||||
|
|
||||||
|
|
@@ -57,9 +49,12 @@ If you set this parameter to *false*, the buildpack will attempt to download Sap | |||||
|
|
||||||
|
|
||||||
|
|
||||||
| ### SapMachine 11 | ||||||
| ### SapMachine 17 | ||||||
|
|
||||||
| 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: | ||||||
| > ### Tip: | ||||||
| > 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. | ||||||
|
|
||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -68,10 +63,10 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 11.+ }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 17.+ }' | ||||||
| ``` | ||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -80,20 +75,20 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 11.0.28 }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 17.0.17 }' | ||||||
| ... | ||||||
| ``` | ||||||
|
|
||||||
| **NOTE:** To stay secure, you need to update this version string on your own. For this reason, SAP does **not** recommend this approach. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| ### SapMachine 17 | ||||||
| ### SapMachine 21 | ||||||
|
|
||||||
| > ### Tip: | ||||||
| > 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. | ||||||
| > 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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -102,10 +97,10 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 17.+ }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 21.+ }' | ||||||
| ``` | ||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -114,20 +109,20 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 17.0.16 }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 21.0.9 }' | ||||||
| ... | ||||||
| ``` | ||||||
|
|
||||||
| **NOTE:** To stay secure, you need to update this version string on your own. For this reason, SAP does **not** recommend this approach. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| ### SapMachine 21 | ||||||
| ### SapMachine 25 | ||||||
|
|
||||||
| > ### Tip: | ||||||
| > 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. | ||||||
| > 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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -136,10 +131,10 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 21.+ }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{ version: 25.+ }' | ||||||
| ``` | ||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -148,7 +143,7 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jre.SAPMachineJRE']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 21.0.8 }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JRE: '{use_offline_repository: false, version: 25.0.1 }' | ||||||
| ... | ||||||
| ``` | ||||||
|
|
||||||
|
|
@@ -173,17 +168,17 @@ applications: | |||||
| ``` | ||||||
|
|
||||||
| > ### Note: | ||||||
| > 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. | ||||||
| > 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. | ||||||
| > | ||||||
| > 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). | ||||||
| > 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). | ||||||
|
|
||||||
| To specify an online JDK version \(11, 17, or 21\), use environment variable JBP\_CONFIG\_SAP\_MACHINE\_JDK. | ||||||
| To specify an online JDK version \(17, 21, or 25\), use environment variable JBP\_CONFIG\_SAP\_MACHINE\_JDK. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| ### SapMachine 11 | ||||||
| ### SapMachine 17 | ||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -192,10 +187,10 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 11.+ }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 17.+ }' | ||||||
| ``` | ||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -204,17 +199,17 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 11.0.28 }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 17.0.17 }' | ||||||
| ... | ||||||
| ``` | ||||||
|
|
||||||
| **NOTE:** To stay secure, you need to update this version string on your own. For this reason, SAP does **not** recommend this approach. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| ### SapMachine 17 | ||||||
| ### SapMachine 21 | ||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -223,10 +218,10 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 17.+ }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 21.+ }' | ||||||
| ``` | ||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -235,17 +230,17 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 17.0.16 }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 21.0.9 }' | ||||||
| ... | ||||||
| ``` | ||||||
|
|
||||||
| **NOTE:** To stay secure, you need to update this version string on your own. For this reason, SAP does **not** recommend this approach. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| ### SapMachine 21 | ||||||
| ### SapMachine 25 | ||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -254,10 +249,10 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 21.+ }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 25.+ }' | ||||||
| ``` | ||||||
|
|
||||||
| 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: | ||||||
| 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: | ||||||
|
|
||||||
| ``` | ||||||
| --- | ||||||
|
|
@@ -266,16 +261,22 @@ applications: | |||||
| ... | ||||||
| env: | ||||||
| JBP_CONFIG_COMPONENTS: "jres: ['com.sap.xs.java.buildpack.jdk.SAPMachineJDK']" | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 21.0.8 }' | ||||||
| JBP_CONFIG_SAP_MACHINE_JDK: '{ version: 25.0.1 }' | ||||||
| ... | ||||||
| ``` | ||||||
|
|
||||||
| **NOTE:** To stay secure, you need to update this version string on your own. For this reason, SAP does **not** recommend this approach. | ||||||
|
|
||||||
|
|
||||||
| **Related Information** | ||||||
|
|
||||||
| [https://sapmachine.io/](https://sapmachine.io/ "The SapMachine Website with downloads and documentation.") | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| [Java Main](java-main-8a1786a.md "Find out how you can create a Java application that starts its own runtime. This allows the usage of frameworks and Java runtimes, such as Spring Boot, Jetty, Undertow, or Netty.") | ||||||
|
|
||||||
| [SAP Java Buildpack 2](sap-java-buildpack-2-1cf206b.md "Find information about SAP Java Buildpack 2 which is a Cloud Foundry buildpack for running SapMachine-based applications.") | ||||||
|
|
||||||
| [https://sap.github.io/SapMachine/](https://sap.github.io/SapMachine/) | ||||||
| [Debug an Application Running on SapMachine](debug-an-application-running-on-sapmachine-f7fa9f3.md "Find out possibilties how to debug a Java web application running on a Cloud Foundry container that uses SapMachine.") | ||||||
|
|
||||||
| [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.") | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.