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
Copy file name to clipboardExpand all lines: README.md
+10-13Lines changed: 10 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,34 +1,31 @@
1
1
2
-
# Windup Documentation
2
+
# MTA documentation
3
3
4
-
This repository contains the files for Windup documentation.
4
+
Migration Toolkit for Applications (MTA) is a set of tools that can be used to accelerate large-scale application modernization efforts across hybrid cloud environments on Red Hat OpenShift.
5
5
6
-
[Windup](https://github.com/windup/windup) is an automated application migration and assessment tool.
6
+
This repository contains the files for MTA documentation.
7
7
8
-
For developer-focused documentation, see the [Windup wiki](https://github.com/windup/windup/wiki).
8
+
## Contributing to MTA documentation
9
9
10
-
## Contributing to Windup documentation
11
-
12
-
This project is [Apache 2.0 licensed](LICENSE) and accepts contributions via
13
-
GitHub pull requests.
10
+
This project is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub pull requests.
14
11
15
12
See the [Contributors Guide](CONTRIBUTING.adoc) for details.
16
13
17
14
## Reporting a documentation bug
18
15
19
16
To report a Windup documentation issue, submit a Jira issue on the [Windup project page]]{JiraWindupURL} with the *Component* field set to *Documentation*.
20
17
21
-
## Repository Structure
18
+
## Repository structure
22
19
23
-
This repository uses the following directory structure:
20
+
This repository has the following directory structure:
24
21
25
22
```
26
23
.
27
-
├── CONTRIBUTING.adoc (Guide for how to contribute to this repository)
24
+
├── CONTRIBUTING.adoc (Instructions on how to contribute to this repository)
28
25
├── README.md (This file)
29
26
├── topics (Symbolic link to docs/topics/)
30
27
└── docs/ (Contains all the asciidoc topics and top level content spec)
31
-
├── GUIDE_NAME/
28
+
├── guide_name/
32
29
│ ├── master.adoc (Base AsciiDoc file for this guide)
33
30
│ ├── master-docinfo.xml (Metadata about this guide)
34
31
│ └── topics (Symbolic link to docs/topics/)
@@ -39,7 +36,7 @@ This repository uses the following directory structure:
39
36
│ ├── document-attributes.adoc (Stores attributes used across guides)
40
37
│ ├── revision-info.adoc (Revision timestamp to be added to all guides)
<subtitle>Using the {ProductName} command-line interface to migrate applications.</subtitle>
4
+
<subtitle>Using the {ProductName} command-line interface to migrate your applications</subtitle>
5
5
<abstract>
6
-
<para>By using the {ProductName} command-line interface (CLI), you can assess and prioritize migration and modernization efforts for 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>
{ProductFullName} {DocInfoProductNumber} accelerates large-scale application modernization efforts across hybrid cloud environments on {ocp-first}. This solution provides insight throughout the adoption process, at both the portfolio and application levels: inventory, assess, analyze, and manage applications for faster migration to {ocp-short} through the user interface (UI) and command-line interface (CLI).
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/mavenize.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,7 +79,7 @@ The root POM is also configured to use the link:https://maven.repository.redhat.
79
79
[discrete]
80
80
=== BOM file
81
81
82
-
The Bill of Materials (BOM) file is generated in the directory ending in `-bom`. For the example `jee-example-app-1.0.0.ear` application, the BOM file can be found at `/path/to/output/mavenized/jee-example-app/jee-example-app-bom/pom.xml`. The purpose of this BOM is to have the versions of third-party dependencies used by the project defined in one place. For more information on using a BOM, see the link:https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html[Introduction to the dependency mechanism] section of the Apache Maven documentation.
82
+
The Bill of Materials (BOM) file is generated in the directory ending in `-bom`. For the example `jee-example-app-1.0.0.ear` application, the BOM file can be found at `/path/to/output/mavenized/jee-example-app/jee-example-app-bom/pom.xml`. The purpose of this BOM is to have the versions of third-party dependencies used by the project defined in one place. For more information on using a BOM, see the link:https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Bill_of_Materials_.28BOM.29_POMs[Introduction to the dependency mechanism] section of the Apache Maven documentation.
83
83
84
84
The following dependencies are listed in the BOM for the example `jee-example-app-1.0.0.ear` application
0 commit comments