You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<subtitle>Learn how to use the {ProductName} {CLIName} to migrate your applications.</subtitle>
4
+
<subtitle>Using the {ProductName} command-line interface to migrate your applications</subtitle>
5
5
<abstract>
6
-
<para>This guide describes how to use the {ProductName} {CLIName} to simplify migration of Java applications.</para>
6
+
<para>By using the {ProductFullName} command-line interface (CLI), you can assess and prioritize migration and modernization efforts for applications written in different languages. You can use the CLI to customize {ProductShortName} analysis options or integrate with external automation tools.</para>
7
7
</abstract>
8
8
<authorgroup>
9
9
<orgname>Red Hat Customer Content Services</orgname>
Each analyzer rule is a set of instructions that are used to analyze source code and detect issues that are problematic for migration.
33
33
34
-
The analyzer parses user-provided rules, applies them to applications' source code, and generates issues for matched rules. A collection of one or more rules forms a ruleset. Creating rulesets provides a way of organizing multiple rules that achieve a common goal. The analyzer CLI takes rulesets as input arguments.
34
+
The analyzer parses user-provided rules, applies them to applications' source code, and generates issues for matched rules.
35
+
36
+
A collection of one or more rules forms a ruleset. Creating rulesets provides a way of organizing multiple rules that achieve a common goal.
37
+
38
+
The analyzer CLI takes rulesets as input arguments.
This section describes how to create a basic {ProductShortName} YAML rule. This assumes that you already have {ProductShortName} installed. See the {ProductShortName} {ProductDocUserGuideURL}[_{UserCLIBookName}_] for installation instructions.
Copy file name to clipboardExpand all lines: docs/topics/installing-cli-tool.adoc
+46-10Lines changed: 46 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,27 +11,59 @@ You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems
11
11
12
12
[IMPORTANT]
13
13
====
14
-
Starting from {ProductShortName} 7.2.0, you can run the application analysis for Java applications in the containerless mode.
14
+
15
+
Starting from {ProductShortName} 7.2.0, you can run the application analysis for Java applications in the containerless mode.
15
16
16
17
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].
17
18
18
19
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.
19
20
====
20
21
21
-
.Prerequisites
22
+
.Prerequisites for containerized CLI
23
+
24
+
The following are the prerequisites for the {ProductFullName} CLI installation (container):
22
25
23
26
* 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].
24
27
28
+
* link:https://podman.io/[Podman] must be installed.
29
+
30
+
* 8 GB of RAM is required for the {ProductShortName} {CLIName}.
31
+
32
+
.Prerequisites for containerless CLI
33
+
34
+
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:
35
+
36
+
* Java Development Kit (JDK) is installed.
37
+
+
38
+
{ProductShortName} supports the following JDKs:
39
+
40
+
** Oracle JDK 17 or later
41
+
** Eclipse Temurin™ JDK 17 or later
42
+
** OpenJDK 17 or later
43
+
+
44
+
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].
45
+
46
+
* You must set the `JAVA_HOME` and the `PATH` environment variables.
47
+
48
+
* 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].
49
+
50
+
* macOS installation requires:
51
+
52
+
** The value of `maxproc` must be `2048` or greater.
53
+
25
54
[id="installing-downloadable-cli-zip_{context}"]
26
55
== Installing the {CLINameTitle} `.zip` file
27
56
28
57
.Procedure
29
58
30
59
. Navigate to the link:{DevDownloadPageURL}[{ProductShortName} Download page] and download the OS-specific CLI file or the `src` file:
. Extract the `.zip` file to the `.kantra` directory inside your `$HOME` directory. The `.zip` file extracts the *mta-cli* binary, along with other required directories and files.
@@ -42,7 +74,12 @@ When you encounter `<{ProductShortName}_HOME>` in this guide, replace it with th
42
74
[id="installing-using-podman_{context}"]
43
75
== Installing the {CLINameTitle} by using Podman
44
76
45
-
You can install the {CLINameTitle} using `podman pull`.
77
+
You can install the containerized {CLINameTitle} using `podman pull`.
78
+
79
+
[NOTE]
80
+
====
81
+
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.
Copy file name to clipboardExpand all lines: docs/topics/mta-7-installing-web-console-on-openshift.adoc
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -151,15 +151,15 @@ The most commonly used CR settings are listed in this table:
151
151
|Maximum number of CPUs the pod is allowed to use
152
152
153
153
|`analyzer_container_limits_memory`
154
-
|`4Gi`
154
+
|`1Gi`
155
155
|Maximum amount of memory the pod is allowed to use. You can increase this limit if the pod displays `OOMKilled` errors.
156
156
157
157
|`analyzer_container_requests_cpu`
158
158
|`1`
159
159
|Minimum number of CPUs the pod needs to run
160
160
161
161
|`analyzer_container_requests_memory`
162
-
|`4Gi`
162
+
|`1Gi`
163
163
|Minimum amount of memory the pod needs to run
164
164
165
165
|`ui_container_limits_cpu`
@@ -267,34 +267,35 @@ To prevent out-of-memory events and protect nodes, use the `--eviction-hard` set
267
267
The amount of memory available for running pods on this node is 28.9 GB. This amount is calculated by subtracting the `system-reserved` and `eviction-hard` values from the overall capacity of the node. If the memory usage exceeds this amount, the node starts evicting pods.
268
268
269
269
270
-
[id="mta-7-red-hat-single-sign-on_{context}"]
271
-
== Red Hat Single Sign-On
270
+
[id="mta-7-red-hat-build-of-keycloak_{context}"]
271
+
== Red Hat Build of Keycloak
272
272
273
-
The {ProductShortName} uses link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6[Red Hat Single Sign-On (RHSSO)] instance for user authentication and authorization.
273
+
The {ProductShortName} 7.3.0 uses link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0[{rhbk-first}] instance for user authentication and authorization.
274
274
275
-
The {ProductShortName} operator manages the RHSSO instance and configures a dedicated link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/configuring_realms[realm] with necessary roles and permissions.
275
+
The {ProductShortName} operator manages the {rhbk-short} instance and configures a dedicated link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/server_administration_guide/configuring-realms[realm] with necessary roles and permissions.
276
276
277
-
{ProductShortName}-managed RHSSO instance allows you to perform advanced RHSSO configurations, such as link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/user-storage-federation#adding_a_provider[adding a provider for User Federation] or link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/identity_broker[integrating identity providers]. To access the link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/configuring_realms#using_the_admin_console[RHSSO Admin Console], enter the URL https://<_route_>/auth/admin in your browser by replacing <route> with the {ProductShortName} web console address.
277
+
{ProductShortName}-managed {rhbk-short} instance allows you to perform advanced {rhbk-short} configurations, such as link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/server_administration_guide/user-storage-federation#adding_a_provider[adding a provider for User Federation] or link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/server_administration_guide/identity_broker[integrating identity providers]. To access the link:hhttps://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/server_administration_guide/configuring-realms#using_the_admin_console[{rhbk-short} Admin Console], enter the URL https://<_route_>/auth/admin in your browser by replacing < _route_ > with the {ProductShortName} web console address.
278
278
279
279
Example:
280
280
281
281
* MTA web console: https://mta-openshiftmta.example.com/
To create a dedicated route for the RHSSO instance, set the `rhsso_external_access` parameter to `true` in the Tackle custom resource (CR) for {ProductShortName}.
292
+
//To create a dedicated route for the {rhbk-short} instance, set the `rhsso_external_access` parameter to `true` in the Tackle custom resource (CR) for {ProductShortName}. #QE asked to remove this line.
292
293
293
-
include::analyzer-rbac-snippet.adoc[]
294
+
//include::analyzer-rbac-snippet.adoc[]
294
295
295
296
.Additional resources
296
-
* link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/server_administration_guide/index#ldap[Configuring LDAP and Active Directory in RHSSO]
297
-
* link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/server_administration_guide/red_hat_single_sign_on_features_and_concepts[Red Hat Single Sign-On features and concepts]
297
+
* link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/server_administration_guide/user-storage-federation#ldap[Configuring LDAP and Active Directory in {rhbk-short}]
298
+
* link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/server_administration_guide/red_hat_build_of_keycloak_features_and_concepts[Red Hat Build of Keycloak features and concepts]
The roles are already defined in your RHSSO instance. You do not need to create them.
321
+
The roles are already defined in your {rhbk-short} instance. You do not need to create them.
321
322
322
-
If you are an {ProductShortName} administrator, you can create users in your RHSSO and assign each user one or more roles, one role per persona.
323
+
If you are an {ProductShortName} administrator, you can create users in your {rhbk-short} and assign each user one or more roles, one role per persona.
323
324
324
325
[id="mta-roles-personas-ui-views_{context}"]
325
326
==== Roles, personas, and access to {WebName} views
@@ -360,7 +361,7 @@ The ability of administrators, architects, and migrators to access the *Administ
360
361
[id="mta-roles-permissions_{context}"]
361
362
==== Roles and permissions
362
363
363
-
The following table contains the roles and permissions (scopes) that {ProductShortName} seeds the managed RHSSO instance with:
364
+
The following table contains the roles and permissions (scopes) that {ProductShortName} seeds the managed {rhbk-short} instance with:
0 commit comments