Skip to content
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

MTA-2744 - Rework MTA CLI section #880

Open
wants to merge 56 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
016bdd6
Updated .gitignore file
HagayVider1 Apr 21, 2024
7a5011b
Text edits in MTA CLI guide
HagayVider1 May 6, 2024
94897b6
Updated install CLI section
HagayVider1 May 6, 2024
54a0ec2
Updated install CLI procedure and link to Run CLI procedure
HagayVider1 May 7, 2024
3815164
Fixed spelling
HagayVider1 May 7, 2024
8722f49
Update according to comment
HagayVider1 May 7, 2024
4106033
Update according to Adndy's comments
HagayVider1 May 7, 2024
ad4158d
Update updated according to comment
HagayVider1 May 7, 2024
a9adfb0
Replaced link with xref
HagayVider1 May 7, 2024
1b2901f
Merge branch 'main' into mta-2744_rework-mta-cli-section
HagayVider1 May 7, 2024
37f5272
Changed xref
HagayVider1 May 7, 2024
5dae139
Changed xref
HagayVider1 May 7, 2024
74433e1
Updated xref command
HagayVider1 May 8, 2024
555a837
Added Windows EXE option
HagayVider1 May 16, 2024
b27fa85
Updated migration paths table - to revert
HagayVider1 May 21, 2024
9d67697
Updated About CLI
HagayVider1 May 23, 2024
aed8816
Updated CLI installation procedure
HagayVider1 May 23, 2024
0e6ef1e
Updated What is MTA
HagayVider1 May 23, 2024
ed6cf04
Updated Username and Password step
HagayVider1 May 23, 2024
56a8f60
Update docs/topics/installing-cli-tool.adoc
HagayVider1 May 27, 2024
da19c36
Update docs/topics/installing-cli-tool.adoc
HagayVider1 May 27, 2024
896b888
Moved sections within CLI guide
HagayVider1 May 27, 2024
e90fd7d
Updated about MTA according to Andy's comments
HagayVider1 May 29, 2024
35307af
Updated about CLI section
HagayVider1 May 29, 2024
30ba650
Corrected Podman name
HagayVider1 May 29, 2024
ad8a8d9
Updated About CLI section
HagayVider1 May 30, 2024
e57201e
Updated file download section
HagayVider1 May 30, 2024
a28e029
Corrected capitalization
HagayVider1 May 30, 2024
1474e60
Added darwin-mta-cli filename for macOS
HagayVider1 May 30, 2024
bb03d4e
Rewriting Running MTA CLI section
HagayVider1 May 30, 2024
1504f44
Updated file names in installation
HagayVider1 May 30, 2024
1011b1f
Corrected typos
HagayVider1 May 30, 2024
5e6d4b9
Updated installation procedure
HagayVider1 May 30, 2024
c2d899e
Merge branch 'main' into mta-2744_rework-mta-cli-section
HagayVider1 May 30, 2024
b86383b
Corrected after linting
HagayVider1 Jun 3, 2024
78c393b
Updated Running the CLI section
HagayVider1 Jun 5, 2024
728e9b8
Renamed Accessing reports to Reports and moved to head or Reports cha…
HagayVider1 Jun 5, 2024
222c1f3
Updated the Reports chapter start
HagayVider1 Jun 5, 2024
47a99ce
Corrected spacing
HagayVider1 Jun 5, 2024
85a35bf
Updated open report procedure
HagayVider1 Jun 5, 2024
b84f8d0
Updated outline for Reports chapter
HagayVider1 Jun 5, 2024
0765fe5
Updated What is the MTA
HagayVider1 Jun 5, 2024
bfe9536
Updated after linting
HagayVider1 Jun 6, 2024
b825cac
Corrected What is MTA section
HagayVider1 Jun 6, 2024
176ec50
Updated bulleted list
HagayVider1 Jun 6, 2024
7e09487
Added backticks where necessary
HagayVider1 Jun 10, 2024
142dbdf
Corrected table
HagayVider1 Jun 10, 2024
e6dbf74
Corrected table
HagayVider1 Jun 10, 2024
a212ed2
Corrected Running the CLI header
HagayVider1 Jun 10, 2024
5d740d7
Corrected document hierarchy
HagayVider1 Jun 10, 2024
97ad2ea
Corrected back-tick
HagayVider1 Jun 13, 2024
8af6fd0
Corrected third-party
HagayVider1 Jun 13, 2024
a850e14
Replaced image with MTA 7
HagayVider1 Jun 13, 2024
760771b
Removed Shared archives - added Dependencies
HagayVider1 Jun 13, 2024
7bbe1a8
Replaced Dashboard image
HagayVider1 Jun 13, 2024
5910a92
// Add query for Dashboard image
HagayVider1 Jun 13, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,9 @@ html/
*/build/*
Gemfile.lock
*/master.html
.idea/
.idea/
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why have you changed the .gitignore file?
You should be using your global .gitignore file which we set up in our last git training session.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have closed this comment and failed to correct your mistake

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.idea/
.idea/

.gitignore
.DS_Store
assets/.DS_Store
docs/.DS_Store
docs/topics/.DS_Store
2 changes: 1 addition & 1 deletion docs/topics/about-cli-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
[id="about-cli-guide_{context}"]
= About the {UserCLIBookName}

This guide is for engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate Java applications or other components. It describes how to install and run the {CLIName}, review the generated reports, and take advantage of additional features.
This guide is for programmers, engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate Java and Go applications, or other software components. It describes how to install and run the {CLIName}, review the generated reports, and take advantage of additional features.
2 changes: 1 addition & 1 deletion docs/topics/about-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="about-cli_{context}"]
= The {ProductShortName} {CLINameTitle}

The {CLIName} is a command-line tool in the {ProductName} that you can use to assess and prioritize migration and modernization efforts for applications. It provides numerous reports that highlight the analysis without using the other tools. The {CLIName} includes a wide array of customization options. By using the {CLIName}, you can tune {ProductShortName} analysis options or integrate with external automation tools.
The {ProductShortName} {CLIName} is a command-line tool that you can use to assess and prioritize migration and modernization efforts for applications. It provides numerous reports that highlight the analysis without using the other tools. The {CLIName} includes a wide array of customization options, enabling you to tune the {ProductShortName} analysis options or integrate with external automation tools.
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved

ifndef::cli-guide[]
For more information about using the {CLIName}, see link:{ProductDocUserGuideURL}[_{UserCLIBookName}_].
Expand Down
56 changes: 43 additions & 13 deletions docs/topics/installing-cli-tool.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
[id="installing-cli-tool_{context}"]
= Installing the {CLINameTitle}

You can install the {CLINameTitle} on Linux, Windows, or macOS operating systems.

You can install the {ProductShortName} {CLINameTitle} on Linux, Windows, or macOS operating systems.

.Prerequisites

Expand All @@ -24,24 +23,51 @@ Podman provides a command line interface (CLI) familiar to anyone who has used t
For more information on installing and using Podman, see link:https://podman.io/docs/installation[Podman installation instructions].
====

Installation options
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New step on Installation options
Downloading the ZIP file is preferred, but installing using Podman is also available.

This section offers two options to install {ProductShortName} {CLINameTitle}:
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved

* Downloading a `.zip` file and installing it using a command line
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved
* Running PodMan on your computer and installing using PodMan commands
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved

+
[WARNING]
====
Although installation using Podman is possible, downloading and installing the `.zip` file is the preferred installation.
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved
====


[id="installing-downloadable-cli-zip_{context}"]
== Installing the {CLINameTitle} `.zip` file

.Procedure

To install using the downloadable `.zip` file:

. Navigate to the link:{DevDownloadPageURL}[{ProductShortName} Download page] and download the OS specific CLI file or the `src` file:
. Navigate to the link:https://developers.redhat.com/products/mta/download[{ProductShortName} Download page] and download the OS specific CLI file or the `mta-{ProductVersion}-cli-src` file:
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved
+
* {ProductShortNameLower}-{ProductVersion}-cli-linux.zip
* {ProductShortNameLower}-{ProductVersion}-cli-macos.zip
* {ProductShortNameLower}-{ProductVersion}-cli-windows.zip
* {ProductShortNameLower}-{ProductVersion}-cli-src.zip
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for Linux x86_64
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for Linux aarch64
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for macOS x86_64
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for macOS aarch64
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for Windows x86_64
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for Windows aarch64
* Migration Toolkit {CLINameTitle} -{CLINameTitle} for {ProductShortName} source Code

+
[NOTE]
====
Do not download and install the {ProductShortName} source Code file if your computer runs one of the above operating systems.
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved
====

. Extract the `.zip` file to a directory of your choice. The `.zip` file extracts a single binary, called *mta-cli*.
+
When you encounter `<{ProductShortName}_HOME>` in this guide, replace it with the actual path to your {ProductShortName} installation.

. Copy or save the `mta-cli` binary, or `mta-cli.exe` in Windows, to a known directory.
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved
+
Continue to xref:cli-run_cli-guide[Running the CLI] to run the CLI command.


[id="installing-using-podman_{context}"]
== Installing the {CLINameTitle} using Podman
Expand All @@ -60,21 +86,25 @@ To install using `podman pull`:
[source,terminal]
----
podman login registry.redhat.io
----

. Enter your `Username` and `Password`.
+
[source,terminal]
----
Username: <username>
Password: <***********>
----
. Issue:
+
If your `Usernam` and `Password` are correct, the terminal line should show `Login Succeeded!`.
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved

. Copy the binary `PATH` for system-wide use.
+
[source,terminal]
----
podman cp $(podman create registry.redhat.com/mta-toolkit/mta-mta-cli-rhel9:{ProductVersion}):/usr/local/bin/mta-cli ./
----
+
This command will copy the binary `PATH` for system-wide use.
+
[WARNING]
====
Although installation using Podman is possible, downloading installing the `.zip` file is the preferred installation.
====


24 changes: 24 additions & 0 deletions docs/topics/migration-paths.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|Spring Boot in Red Hat Runtimes
|Quarkus
|Open Liberty
|Azure App Service

|Oracle WebLogic Server
|{icon-check}
Expand All @@ -36,6 +37,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|-
|-
|-

|IBM WebSphere Application Server
|{icon-check}
Expand All @@ -46,6 +48,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|-
|{icon-check}
|-

|JBoss EAP 4
|{icon-x} footnoteref:[note2,Although {ProductShortName} does not currently provide rules for this migration path, Red Hat Consulting can assist with migration from any source platform to JBoss EAP 7.]
Expand All @@ -55,6 +58,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|-
|-
|-

|JBoss EAP 5
|{icon-check}
Expand All @@ -65,6 +69,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|-
|-
|-

|JBoss EAP 6
|{icon-check}
Expand All @@ -75,6 +80,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|-
|-
|-

|JBoss EAP 7
|{icon-check}
Expand All @@ -85,6 +91,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|{icon-check}
|-
|-

|Thorntail
|{icon-check} footnoteref:[note3,Requires JBoss Enterprise Application Platform expansion pack 2 (EAP XP 2)]
Expand All @@ -95,6 +102,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|-
|-
|-

|Oracle JDK
|-
Expand All @@ -105,6 +113,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|-
|-
|-

|Camel 2
|-
Expand All @@ -115,6 +124,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|-
|-
|-

|Spring Boot
|-
Expand All @@ -125,6 +135,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|{icon-check}
|{icon-check}
|-
|-

|Any Java application
|-
Expand All @@ -135,6 +146,7 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|-
|-
|-

|Any Java EE application
|-
Expand All @@ -145,4 +157,16 @@ The {ProductName} ({ProductShortName}) supports the following migrations:
|-
|-
|-
|-

|Azure
|-
|-
|-
|-
|-
|-
|-
|-
|{icon-check}
|===
13 changes: 8 additions & 5 deletions docs/topics/mta-what-is-the-toolkit.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,19 @@

{ProductName} ({ProductShortName}) accelerates large-scale application modernization efforts across hybrid cloud environments on Red Hat OpenShift. 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 OpenShift via the user interface.

{ProductShortName} uses an extensive default questionnaire as the basis for assessing your applications, or you can create your own custom questionnaire, enabling you to estimate the difficulty, time, and other resources needed to prepare an application for containerization. You can use the results of an assessment as the basis for discussions between stakeholders to determine which applications are good candidates for containerization, which require significant work first, and which are not suitable for containerization.
{ProductShortName} uses an extensive default questionnaire as the basis to assess your applications. You can also create your own custom questionnaires, enabling you to estimate the difficulty, time, and other resources needed to prepare an application for containerization. The results of your assessment can be the basis for discussions between stakeholders to determine the status of application migration:
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved
* Applications that are good candidates for containerization
* Applications that require significant work before being modernized
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved
* Applications that are not suitable for containerization

{ProductShortName} analyzes applications by applying one or more rulesets to each application considered to determine which specific lines of that application must be modified before it can be modernized.
{ProductShortName} analyzes applications by applying one or more rulesets to each application considered, determining which specific lines of that application require modification before it can be migrated or modernized.
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved

{ProductShortName} examines application artifacts, including project source directories and application archives, and then produces an HTML report highlighting areas needing changes.
{ProductShortName} examines application artifacts, including project source directories and application archives, and then produces an HTML report highlighting areas that need changes.


[discrete]
== How does the {ProductName} simplify migration?

The {ProductName} looks for common resources and known trouble spots when migrating applications. It provides a high-level view of the technologies used by the application.
The {ProductName} analyzes the application by looking for common resources and known trouble spots when migrating applications. It provides a high-level view of the technologies used by the application.

{ProductShortName} generates a detailed report evaluating a migration or modernization path. This report can help you to estimate the effort required for large-scale projects and to reduce the work involved.
After analyzing the application, {ProductShortName} generates a detailed report evaluating a migration or modernization path. This report can help you to estimate the effort required for large-scale projects, and to reduce the work involved.
HagayVider1 marked this conversation as resolved.
Show resolved Hide resolved