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
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ You can perform the analysis either of the following ways:

* Select a supported language provider to run the analysis for.
* Overwrite the existing supported language provider with your own unsupported language provider, and then run the analysis on it.


IMPORTANT: Analyzing applications written in languages other than Java is only possible in container mode. You can use the containerless CLI only for Java applications. For more information, see xref:running-the-containerless-mta-cli_analyzing-applications-mta-cli[Analyzing an application in containerless mode].

[IMPORTANT]
====
Analyzing applications written in languages other than Java is only possible in container mode. You can use the containerless CLI only for Java applications. For more information, see xref:running-the-containerless-mta-cli_analyzing-applications-mta-cli[Analyzing an application in containerless mode].
====

include::topics/mta-cli/proc_analyze-selected-provider.adoc[leveloffset=+1]

Expand Down
6 changes: 4 additions & 2 deletions assemblies/cli-guide/assembly_performing-transformation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ endif::[]
[role="_abstract"]
To accelerate your application modernization, use the {ProductFullName} command-line interface (CLI) to transform your source code. The transformation process applies predefined migration rules to your codebase, reducing the manual effort required to update Java libraries or frameworks.

IMPORTANT: Performing transformation requires the container runtime to be configured.

[IMPORTANT]
====
Performing transformation requires the container runtime to be configured.
====

include::topics/mta-cli/proc_transforming-application-source-code.adoc[leveloffset=+1]

Expand Down
8 changes: 6 additions & 2 deletions docs/cli-guide/master.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
:mta:
include::topics/templates/document-attributes.adoc[]
:_mod-docs-content-type: ASSEMBLY
[id="cli-guide"]
= Using the {ProductName} command-line interface


[role="_abstract"]
Use the {ProductName} command-line interface to analyze applications, review reports, transform source code, and generate deployment assets for migration and modernization.

include::topics/templates/document-attributes.adoc[]

:toc:
:toclevels: 4
:numbered:
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/making-open-source-more-inclusive.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
= Making open source more inclusive

[role="_abstract"]
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see link:https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language[our CTO Chris Wright's message].
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with four terminology changes: blocklist, allowlist, and primary and secondary for role designations. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see link:https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language[our CTO Chris Wright's message].
2 changes: 1 addition & 1 deletion docs/topics/mta-cli/proc_accessing-analysis-report.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Report created: _<output_report_directory>_/index.html
Access it at this URL: file:///_<output_report_directory>_/index.html
....
+
Alternatively, press *Ctrl* and click on the path of the `index.html` file.
Alternatively, press *Ctrl* and click the path of the `index.html` file.
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Report created: _<output_report_directory>_/index.html
.. Paste the path to the browser of your choice.

+
Alternatively, press *Ctrl* and click on the path to the report file.
Alternatively, press *Ctrl* and click the path to the report file.

[role="_additional-resources"]
.Additional resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
= Generating a deployment manifest

[role="_abstract"]
To prepare your application for deployment to a container platform, generate a deployment manifest by using the {ProductFullName} command-line interface (CLI). Generating the deployment manifest creates the necessary configuration files to define your application's resources, streamlining the transition to your target environment.
To prepare your application for deployment to a container platform, generate a deployment manifest by using the {ProductFullName} command-line interface (CLI). Generating the deployment manifest creates the necessary configuration files to define your application's resources, streamlining the move to your target environment.

You can auto-generate the {ocp-full} deployment manifest for the Cloud Foundry (CF) application by using the `generate` command. Based on the Helm template that you provide, the command generates manifests, such as a ConfigMap, and non-Kubernetes manifests, such as a Dockerfile, for application deployment.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@
= Reviewing the analysis issues and incidents

[role="_abstract"]
To identify specific code segments that require modification, review the issues and incidents provided in the {ProductFullName} command-lie interface analysis report. You can use these details to locate migration blockers within your source code and prioritize remediation tasks based on severity.
To identify specific code segments that require modification, review the issues and incidents provided in the {ProductFullName} command-line interface analysis report. You can use these details to locate migration blockers within your source code and prioritize remediation tasks based on severity.

Each issue contains a list of files where a rule matched one or more times. These files include all the incidents within the issue. Each incident contains a detailed explanation of the issue and how to fix this issue.

.Procedure

. Open the analysis report. For more information, see xref:accessing-analysis-report_reviewing-analysis-reports[Accessing an analysis report].
. Click *Issues*.
. Click on the issue you want to check.
. Under the *File* tab, click on a file to display an incident or incidents that triggered the issue.
. Click the issue you want to check.
. Under the *File* tab, click a file to display an incident or incidents that triggered the issue.
. Display the incident message by hovering over the line that triggered the incident, for example:
+
[subs="+quotes"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
= Analyzing an application in containerless mode

[role="_abstract"]
To analyze applications in environments where a container engine is not available or desired, you can run the {ProductFullName} command-line interface (CLI) in containerless mode. This way, you can execute assessments directly on your local machine by using the provided shell script, bypassing the need for Podman or Docker.
To analyze applications in environments where a container engine is not available or not needed, you can run the {ProductFullName} command-line interface (CLI) in containerless mode. This way, you can run assessments directly on your local machine by using the provided shell script, bypassing the need for Podman or Docker.

[IMPORTANT]
====
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/mta-cli/ref_effort-level-estimation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ View the general guidelines the {ProductFullName} uses for effort level estimati

|Unknown
|13
|The migration solution is not known and may need a complete rewrite.
|The migration solution is not known and might need a complete rewrite.
|====
6 changes: 3 additions & 3 deletions docs/topics/mta-cli/ref_mta-cli-analyze-flags.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ You can customize the application analysis process with {ProductFullName} comman
[options="header"]
|====
|Option|Description
|`--analyze-known-libraries` (bool)|Analyze open-source libraries.
|`--disable-maven-search`| Set `--disable-maven-search=true` to disable {ProductShortName} from relying on the Maven search index to determine if a dependency is publicly available, such as an open-source dependency, or internal to the Java binary application during analysis.
|`--analyze-known-libraries` (bool)|Analyze open source libraries.
|`--disable-maven-search`| Set `--disable-maven-search=true` to disable {ProductShortName} from relying on the Maven search index to determine if a dependency is publicly available, such as an open source dependency, or internal to the Java binary application during analysis.

When you disable Maven search, {ProductShortName} at first tries to determine dependencies from the JAR file's POM file, if any. If this method does not succeed, {ProductShortName} goes through the directory structure to determine dependencies. This method may not produce a reliable dependency classification since the package structure can differ from what is expected by {ProductShortName}. You may see more number of incidents because some dependencies may be wrongly classified as internal.
When you disable Maven search, {ProductShortName} at first tries to determine dependencies from the JAR file's POM file, if any. If this method does not succeed, {ProductShortName} goes through the directory structure to determine dependencies. This method might not produce a reliable dependency classification since the package structure can differ from what is expected by {ProductShortName}. You might see more number of incidents because some dependencies might be wrongly classified as internal.

By default, `--disable-maven-search=false`. Therefore, {ProductShortName} uses the SHA digest of the JAR file to search the Maven search index. This setting generates more accurate dependencies but the drawback is that the Maven search index is frequently unavailable.
|`--context-lines` (int)|The number of lines of source code to include in the output for each incident. The default is 100.
Expand Down
8 changes: 4 additions & 4 deletions docs/topics/mta-cli/ref_openrewrite-command-options.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
:_mod-docs-content-type: REFERENCE

[id="openrewrite-command-options_{context}"]
= The openrewrite command options
= The OpenRewrite command options

[role="_abstract"]
The {ProductFullName} command-line interface (CLI) provides the `mta-cli transform openrewrite` command options to customize the transformation of your application source code. Check the following table to identify the available arguments for applying specific migration recipes and controlling the output of the transformation process.
The {ProductFullName} command-line interface (CLI) provides the `mta-cli transform OpenRewrite` command options to customize the transformation of your application source code. Check the following table to identify the available arguments for applying specific migration recipes and controlling the output of the transformation process.

.The mta-cli transform openrewrite command options
.The mta-cli transform OpenRewrite command options
[options="header"]
|====
|Option|Description
|`--goal` (string)|A target goal. The default is `"dryRun"`.
|`--help`|Display all `mta-cli transform openrewrite` command options.
|`--help`|Display all `mta-cli transform OpenRewrite` command options.
|`--input` (string)|A path to the application source code directory.
|`--list-targets`|List all available OpenRewrite recipes.
|`-maven-settings` (string)|A path to a custom Maven settings file.
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/mta-cli/ref_supported-migration-paths.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ You can use the {ProductFullName} to assess your applications' suitability for t
|-

|Thorntail
|{icon-check} footnoteref:[note3,Requires JBoss Enterprise Application Platform expansion pack 2 (EAP XP 2)]
|{icon-check} footnoteref:[note3,Requires JBoss EAP expansion pack 2 (JBoss EAP XP 2)]
|-
|-
|-
Expand Down