Skip to content

Commit 914b1b4

Browse files
authored
Merge pull request #142 from anarnold97/MTA-4887-MTA-CLI-JDK-requirements-for-Linux-devel-package
MTA-4887: Ensure that JDK requirements for RHEL & Fedora indicate to install Development package
2 parents 566309a + 3d804a9 commit 914b1b4

File tree

3 files changed

+44
-11
lines changed

3 files changed

+44
-11
lines changed

docs/topics/installing-cli-tool.adoc

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,45 @@ You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems
1111

1212
[IMPORTANT]
1313
====
14-
Starting from {ProductShortName} 7.2.0, you can run the application analysis for Java applications in the containerless mode.
14+
Starting from {ProductShortName} 7.2.0, you can run the application analysis for Java applications in the containerless mode.
1515
1616
The containerless mode is set by default and is used automatically if all requirements are met. For more information, see xref:running-the-containerless-mta-cli_cli-guide[Running the containerless CLI].
1717
1818
However, if you want to analyze applications in languages other than Java or, for example, use xref:mta-cli-transform_cli-guide[transformation commands], you still need to use containers.
1919
====
2020

21-
.Prerequisites
21+
.Prerequisites for containerized CLI
22+
23+
The following are the prerequisites for the {ProductFullName} CLI installation (container):
2224

2325
* Red Hat Container Registry Authentication for `registry.redhat.io`. Red Hat distributes container images from `registry.redhat.io`, which requires authentication. For more details, see link:https://access.redhat.com/RegistryAuthentication[Red Hat Container Registry Authentication].
2426

27+
* link:https://podman.io/[Podman] must be installed.
28+
29+
* 8 GB of RAM is required for the {ProductShortName} {CLIName}.
30+
31+
.Prerequisites for containerless CLI
32+
33+
The following are the prerequisites if you want to to run {ProductShortName} {CLIName} as in xref:running-the-containerless-mta-cli_cli-guide[containerless CLI] mode:
34+
35+
* Java Development Kit (JDK) is installed.
36+
+
37+
{ProductShortName} supports the following JDKs:
38+
39+
** Oracle JDK 17 or later
40+
** Eclipse Temurin™ JDK 17 or later
41+
** OpenJDK 17 or later
42+
+
43+
If you install OpenJDK on {op-system-base-full} or Fedora, the JDK requires a compiler provided by the `devel` package to also be installed, as having only the Java Runtime (JRE) installed causes issues during analysis. For more information about installing Red Hat build of OpenJDK 17 on {op-system-base-full}, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_openjdk/17/html-single/installing_and_using_red_hat_build_of_openjdk_17_on_rhel/index#installing-jre-on-rhel-using-archive_openjdk[Installing Red Hat build of OpenJDK on RHEL by using yum].
44+
45+
* You must set the `JAVA_HOME` and the `PATH` environment variables.
46+
47+
* Maven 3.9.9 installed, and the bin directory is added to the `PATH` environment variable. Setting the path and environment variables depends on the operating system you are using. For more information about installing Maven, see link:https://maven.apache.org/install.html[Apache Maven installation].
48+
49+
* macOS installation requires:
50+
51+
** The value of `maxproc` must be `2048` or greater.
52+
2553
[id="installing-downloadable-cli-zip_{context}"]
2654
== Installing the {CLINameTitle} `.zip` file
2755

@@ -45,7 +73,12 @@ When you encounter `<{ProductShortName}_HOME>` in this guide, replace it with th
4573
[id="installing-using-podman_{context}"]
4674
== Installing the {CLINameTitle} by using Podman
4775

48-
You can install the {CLINameTitle} using `podman pull`.
76+
You can install the containerized {CLINameTitle} using `podman pull`.
77+
78+
[NOTE]
79+
====
80+
You cannot install the containerless {CLINameTitle} using Podman as this procedure does not include pulling and unpacking the dependencies that are included in the `.zip` file.
81+
====
4982

5083
.Prerequisites
5184

docs/topics/snippet_jdk-hardware-mac-prerequisites.adoc

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@ The following are the prerequisites for the {ProductFullName} installation:
44

55
* Java Development Kit (JDK) is installed. {ProductShortName} supports the following JDKs:
66
7-
** OpenJDK 11
8-
** OpenJDK 17
9-
** Oracle JDK 11
10-
** Oracle JDK 17
11-
** Eclipse Temurin™ JDK 11
12-
** Eclipse Temurin™ JDK 17
13-
14-
* 8 GB RAM
7+
** Oracle JDK 17 or later
8+
** Eclipse Temurin™ JDK 17 or later
9+
** OpenJDK 17 or later
10+
11+
* 8 GB of RAM is required for {ProductShortName}.
12+
1513
* macOS installation: the value of `maxproc` must be `2048` or greater.

docs/topics/templates/document-attributes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ ifdef::mta[]
4040
:ocp: OCP
4141
:ocp-version: 4.18
4242
:ocp-supported: 4.18, 4.17, 4.16
43+
:op-system-base-full: Red Hat Enterprise Linux (RHEL)
44+
:op-system-base: RHEL
4345
endif::[]
4446

4547
ifdef::mtr[]

0 commit comments

Comments
 (0)