Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
5 changes: 2 additions & 3 deletions assemblies/mta-install-title/assembly_installing-mta-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@ endif::[]

:context: installing-mta-cli

You can install the {ProductFullName} command-line interface (CLI) on Linux, Windows, or macOS operating systems.

NOTE: You can also install the CLI for use with Docker on Windows. Note, however, that this is a Developer Preview feature only.
[role="_abstract"]
You can install the {ProductFullName} command-line interface (CLI) on Linux, Windows, or macOS operating systems. You can also install the CLI for use with Docker on Windows. Note, however, that this is a Developer Preview feature only.
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM


include::topics/mta-install/proc_installing-cli-zip.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ endif::[]
= Installing the {ProductName} user interface
:context: installing-mta-ui

[role="_abstract"]
You can install the {ProductFullName} user interface (UI) on all Red Hat OpenShift cloud services and Red Hat OpenShift self-managed editions.

To create {ProductShortName} instances, you must first install the {ProductShortName} Operator. The {ProductShortName} Operator is a structural layer that manages resources deployed on OpenShift, such as database, front end, and back end, to automatically create an {ProductShortName} instance.
Expand Down
1 change: 1 addition & 0 deletions assemblies/mta-install-title/assembly_intro-to-mta.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ endif::[]

:context: intro-to-mta

[role="_abstract"]
{ProductFullName} is a set of tools that you can use to accelerate large-scale application modernization efforts across hybrid cloud environments on Red Hat OpenShift. {ProductShortName} looks for common resources and known trouble spots when migrating applications. It provides a high-level view of the technologies used by the application. {ProductShortName} also generates a detailed report that evaluates a migration or modernization path. By using this report, you can estimate the effort required for large-scale projects and reduce the work involved.

By using the {ProductShortName}, you can perform the following tasks:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ endif::[]

:context: red-hat-build-of-keycloak

[role="_abstract"]
Starting from version 7.3.0, {ProductShortName} uses the link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0[Red Hat Build of Keycloak (RHBK)] instance for user authentication and authorization. An RHBK instance is installed during the installation of the {ProductShortName} user interface. The {ProductShortName} Operator manages the RHBK instance and configures a dedicated realm with necessary roles and permissions.

You can use the {ProductShortName}-managed RHBK instance to perform advanced RHBK 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].
Expand Down
5 changes: 4 additions & 1 deletion docs/topics/mta-cli/ref_contributing-to-mta-development.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
[appendix,id="contributing-to-mta-development"]
= Contributing to the {ProductShortName} project

To help the {ProductName} cover most application constructs and server configurations, including yours, you can help with any of the following items:
[role="_abstract"]
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM

You can help the {ProductName} to cover most application constructs and server configurations, including yours.

You can provide your help with any of the following items:

* Send an email to [email protected] and let us know what {ProductShortName} migration rules must cover.
* Provide example applications to test migration rules.
Expand Down
5 changes: 4 additions & 1 deletion docs/topics/mta-cli/ref_supported-migration-paths.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
[id="supported-migration-paths_{context}"]
= Supported {ProductName} migration paths

You can run the {ProductFullName} analysis to assess your applications' suitability for migration to multiple target platforms. {ProductShortName} supports the following migration paths:
[role="_abstract"]
You can use the {ProductFullName} to assess your applications' suitability for migration to multiple target platforms.
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM


{ProductShortName} supports the following migration paths:

.Supported Java migration paths
[width="99%",cols="19%,10%,10%,10%,10%,10%,10%,10%,10%",options="^,header"]
Expand Down
6 changes: 5 additions & 1 deletion docs/topics/mta-install/con_mta-features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@
[id="mta-features_{context}"]
= {ProductShortName} features

{ProductFullName} provides the following features to simplify upgrades with more migration paths:
[role="_abstract"]
{ProductFullName} provides the many features that simplify upgrades with multiple migration paths.
Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM



{ProductShortName} brings the following benefits for application analysis and assessment:

* *Application inventory and assessment modules* to assist organizations in managing, classifying, and tagging their applications while assessing application suitability for deployment in containers, including flagging potential risks for migration strategies.
* *Full integration with source code and binary repositories* to automate the retrieval of applications for analysis along with proxy integration, including HTTP and HTTPS proxy configuration managed in the user interface.
Expand Down
5 changes: 4 additions & 1 deletion docs/topics/mta-install/con_mta-rules.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
[id="mta-rules_{context}"]
= {ProductShortName} rules

The {ProductFullName} contains rule-based migration tools (analyzers) that you can use to analyze the application user interfaces (APIs), technologies, and architectures used by the applications you plan to migrate. {ProductShortName} analyzer rules use the following rule pattern:
[role="_abstract"]
The {ProductFullName} contains rule-based migration tools (analyzers) that you can use to analyze the application user interfaces (APIs), technologies, and architectures used by the applications you plan to migrate.

{ProductShortName} analyzer rules use the following rule pattern:

----
when(condition)
Expand Down
5 changes: 4 additions & 1 deletion docs/topics/mta-install/con_mta-tools.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
[id="mta-tools_{context}"]
= {ProductShortName} tools

You can use the following {ProductFullName} tools for assistance in the various stages of your migration and modernization efforts:
[role="_abstract"]
Different {ProductFullName} tools provide assistance in the various stages of your migration and modernization efforts.

You can use the following {ProductShortName} tools for assessing and analyzing your applications:

* *User interface (UI)*
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
[id="roles-personas-users-permissions_{context}"]
= Roles, personas, users, and permissions

The {ProductFullName} uses three roles, each corresponds to a persona. The roles are already defined in your RHBK instance. You do not need to create them. If you are an {ProductShortName} administrator, you can create users in your RHBK and assign each user one or more roles, one role per persona. Although a user can have more than one role, each role corresponds to a specific persona:
[role="_abstract"]
The {ProductFullName} uses three roles, each corresponds to a persona. The roles are already defined in your RHBK instance. You do not need to create them. If you are an {ProductShortName} administrator, you can create users in your RHBK and assign each user one or more roles, one role per persona.

A user can have more than one role. Each role must correspond to a specific persona:

* The `tackle-admin` role corresponds to the Administrator persona. The administrator has all the permissions that architects and migrators have, along with the ability to create some application-wide configuration parameters that other users can consume but cannot change or view, for example, Git credentials or Maven `settings.xml` files.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
[id="accessing-rhbk-admin-console_{context}"]
= Accessing the RHBK Admin Console

To perform advanced configurations to an RHBK instance, you must be logged in to the RHBK Admin Console
[role="_abstract"]
To perform advanced configurations to an RHBK instance, you must be logged in to the RHBK Admin Console.

.Procedure

Expand Down
3 changes: 3 additions & 0 deletions docs/topics/mta-install/proc_creating-mta-instance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@
[id="creating-mta-instance_{context}"]
= Creating a MTA instance

[role="_abstract"]
You can use the {ProductFullName} user interface (UI) to assess and analyze your applications to get insights about the adoption process at both the portfolio and application levels as you inventory, assess, analyze, and manage applications for faster migration to Red Hat OpenShift.

To use the {ProductShortName} UI for assessing and analyzing your applications, you must create a {ProductShortName} instance first.

.Prerequisites

* You installed the {ProductShortName} Operator on your system. For more information, see xref:installing-mta-operator_installing-mta-ui[Installing the Migration Toolkit for Applications Operator].
Expand Down
6 changes: 5 additions & 1 deletion docs/topics/mta-install/proc_installing-cli-for-docker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@
[id="installing-cli-for-docker_{context}"]
= Installing the CLI for use with Docker on Windows

To migrate applications built with .NET framework version 4.5 or later, on Microsoft Windows to cross-platform .NET 8.0, you must install the CLI for use with Docker on Windows. To do so, you must configure Docker to use Windows containers first.
[role="_abstract"]
To migrate applications built with .NET framework version 4.5 or later, on Microsoft Windows to cross-platform .NET 8.0, you must install the CLI for use with Docker on Windows.


To install the CLI for use with Docker on Windows, you must configure Docker to use Windows containers first.

.Prerequisites

Expand Down
5 changes: 4 additions & 1 deletion docs/topics/mta-install/proc_installing-cli-zip.adoc
Copy link
Collaborator

@anarnold97 anarnold97 Aug 13, 2025

Choose a reason for hiding this comment

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

this is not correct

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

.Procedure

. Navigate to the link:{DevDownloadPageURL}[{ProductShortName} Download page] and download the OS-specific CLI file or the `src` file:
+
* {ProductShortNameLower}-{ProductVersion}-cli-linux-amd64.zip
* {ProductShortNameLower}-{ProductVersion}-cli-linux-arm64.zip
* {ProductShortNameLower}-{ProductVersion}-cli-darwin-amd64.zip
* {ProductShortNameLower}-{ProductVersion}-cli-darwin-arm64.zip
* {ProductShortNameLower}-{ProductVersion}-cli-windows-amd64.zip
* {ProductShortNameLower}-{ProductVersion}-cli-windows-arm64.zip
* {ProductShortNameLower}-{ProductVersion}-cli-src.zip

. 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.

Also, please note Igor's comments on this PR - https://github.com/migtools/mta-documentation/pull/178/files#r2273545164

FYI - @ibragins

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@anarnold97, I think my PTO makes me a bit stupid :D What exatcly is wrong here? The versions or the "extraction" step? Or even both? I checked the versions in the published doc and I don't see the difference . Or have the versions changed in the Download page?

Also, for Igor's comment, yes, we can move the containerless CLI section to the first place. Will think about how to put it the best possible way.

Copy link
Collaborator

Choose a reason for hiding this comment

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

You need to include:

. 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.

The .kantra part is essential

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
[id="installing-cli-zip_{context}"]
= Installing the CLI by using a .zip file

You can install the {ProductFullName} command-line interface (CLI) by using the downloadable `.zip` file available on the link:https://developers.redhat.com/products/mta/download[official {ProductShortName} download page].
[role="_abstract"]
You can use the {ProductFullName} command-line interface (CLI) to assess and analyze your applications to prepare them for the migration.

You can install the {ProductShortName} CLI by using the downloadable `.zip` file available on the link:https://developers.redhat.com/products/mta/download[official {ProductShortName} download page].


.Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
[id="installing-mta-disconnected-environment_{context}"]
= Installing the CLI on a disconnected environment

[role="_abstract"]
In certain cases, you might want to install the {ProductFullName} command-line interface (CLI) when no internet connection is available.

When your system is in a disconnected environment, you can install the {ProductFullName} command-line interface (CLI) by performing the following actions:

. Download the required images by using an external computer.
Expand Down
5 changes: 4 additions & 1 deletion docs/topics/mta-install/proc_installing-mta-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
[id="installing-mta-operator_{context}"]
= Installing the {ProductShortName} Operator

To create {ProductFullName} instances, you must first install the {ProductShortName} Operator. The {ProductShortName} Operator is a structural layer that manages resources deployed on OpenShift, such as database, front end, and back end, to automatically create an {ProductShortName} instance.
[role="_abstract"]
To create {ProductFullName} instances, you must first install the {ProductShortName} Operator.

The {ProductShortName} Operator is a structural layer that manages resources deployed on OpenShift, such as database, front end, and back end, to automatically create an {ProductShortName} instance.

.Prerequisites

Expand Down
9 changes: 8 additions & 1 deletion docs/topics/mta-install/ref_custom-resource-settings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
[id="custom-resource-settings_{context}"]
= Custom resource settings

The following are the most commonly used custom resource (CR) settings that you can find in the `spec` section of the YAML file.
[role="_abstract"]
When installing the {ProductrFullName} Operator, you might need to create custom resource (CR) settings. The default settings are acceptable. However, make sure to check the system requirements for storage, memory, and cores.

The following are the most commonly used CR settings that you can find in the `spec` section of the YAML file.

.Common custom resource settings
[options="header"]
Expand All @@ -30,3 +33,7 @@ The following are the most commonly used custom resource (CR) settings that you
|`analyzer_container_requests_memory `|4GB|Minimum amount of memory the pod needs to run.
|====

[role="_additional-resources"]
.Additional resources
* xref:installing-mta-operator_installing-mta-ui[Installing the {ProductShortName} Operator]

Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="persistent-volume-requirements_{context}"]
= Persistent volume requirements

[role="_abstract"]
To successfully deploy, the {ProductShortName} Operator requires two ReadWriteOnce (RWO) persistent volumes (PVs) used by different components. If the `rwx_supported` configuration option is set to `true`, the {ProductShortName} Operator requires additional two ReadWriteMany (RWX) PVs that are used by Maven and the hub file storage.

.Required persistent volumes
Expand Down