Using the MTA command-line interface to analyze applications
Using the Migration Toolkit for Applications command-line interface to prepare your applications for migration
Abstract
Making open source more inclusive Copy linkLink copied to clipboard!
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 our CTO Chris Wright’s message.
Chapter 1. Introduction to the MTA command-line interface Copy linkLink copied to clipboard!
The Migration Toolkit for Applications (MTA) command-line interface (CLI) provides a comprehensive set of rules to assess the suitability of your applications for containerization and deployment on Red Hat OpenShift. By using the MTA CLI, you can assess and prioritize migration and modernization efforts for applications written in different languages. For example, you can use MTA to analyze applications written in the following languages:
- Java
- Go
- .NET
- Node.js
- Python
Analyzing applications written in the .NET language is a Developer Preview feature only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
Analyzing applications written in the Python and Node.js languages is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.
The CLI provides numerous reports that highlight the analysis without using the other tools. You can use the CLI to customize MTA analysis options or integrate with external automation tools.
Chapter 2. Supported Migration Toolkit for Applications migration paths Copy linkLink copied to clipboard!
You can use the Migration Toolkit for Applications (MTA) to assess your applications' suitability for migration to multiple target platforms.
MTA supports the following migration paths:
| Source platform ⇒ | Migration to JBoss EAP 7 & 8 | OpenShift (cloud readiness) | OpenJDK 11, 17, and 21 | Jakarta EE 9 | Camel 3 & 4 | Spring Boot in Red Hat Runtimes | Quarkus | Open Liberty |
|---|---|---|---|---|---|---|---|---|
| Oracle WebLogic Server | ✔ | ✔ | ✔ | - | - | - | - | - |
| IBM WebSphere Application Server | ✔ | ✔ | ✔ | - | - | - | - | ✔ |
| JBoss EAP 4 | ✘ [a] | ✔ | ✔ | - | - | - | - | - |
| JBoss EAP 5 | ✔ | ✔ | ✔ | - | - | - | - | - |
| JBoss EAP 6 | ✔ | ✔ | ✔ | - | - | - | - | - |
| JBoss EAP 7 | ✔ | ✔ | ✔ | - | - | - | ✔ | - |
| Thorntail | ✔ [b] | - | - | - | - | - | - | - |
| Oracle JDK | - | ✔ | ✔ | - | - | - | - | - |
| Camel 2 | - | ✔ | ✔ | - | ✔ | - | - | - |
| Spring Boot | - | ✔ | ✔ | ✔ | - | ✔ | ✔ | - |
| Any Java application | - | ✔ | ✔ | - | - | - | - | - |
| Any Java EE application | - | - | - | ✔ | - | - | - | - |
[a]
Although MTA does not currently provide rules for this migration path, Red Hat Consulting can assist with migration from any source platform to JBoss EAP 7.
[b]
Requires JBoss Enterprise Application Platform expansion pack 2 (EAP XP 2)
| ||||||||
| Source platform ⇒ | OpenShift (cloud readiness) | Migration to .NET 8.0 |
|---|---|---|
| .NET Framework 4.5+ (Windows only) | ✔ | ✔ |
Analyzing applications written in the .NET language is a Developer Preview feature only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
Chapter 3. Analyzing Java applications with MTA command-line interface Copy linkLink copied to clipboard!
Depending on your scenario, you can use the Migration Toolkit for Applications (MTA) CLI to perform the following actions:
- Run the analysis against a single application.
Run the analysis against multiple applications:
-
In MTA versions earlier than 7.1.0, you can enter a series of
--analyzecommands, each against an application and each generating a separate report. For more information, see Running the MTA CLI against an application. -
In MTA version 7.1.0 and later, you can use the
--bulkoption to analyze multiple applications at once and generate a single report. Note that this feature is a Developer Preview feature only. For more information, see Analyzing multiple applications.
-
In MTA versions earlier than 7.1.0, you can enter a series of
Starting from MTA version 7.2.0, you can run the application analysis for Java applications in the containerless mode. Note that this option is set by default and is used automatically only if all requirements are met. For more information, see Analyzing an application in the containerless mode.
However, if you want to analyze applications in languages other than Java or, for example, use transformation commands, you still need to use containers.
The analysis output in the disconnected environment usually results in fewer incidents because a dependency analysis does not run accurately without access to Maven.
MTA CLI supports running source code and binary analysis by using analyzer-lsp. analyzer-lsp is a tool that evaluates rules by using language providers.
3.1. Analyzing a single application Copy linkLink copied to clipboard!
You can use the Migration Toolkit for Applications (MTA) CLI to perform an application analysis for a single application.
Extracting the list of dependencies from compiled Java binaries is not always possible during the analysis, especially if the dependencies are not embedded within the binary.
Procedure
Optional: List available target technologies for an analysis:
mta-cli analyze --list-targets
$ mta-cli analyze --list-targetsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Run the analysis:
mta-cli analyze --input <path_to_input> --output <path_to_output> --source <source_name> --target <target_name>
$ mta-cli analyze --input <path_to_input> --output <path_to_output> --source <source_name> --target <target_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Specify the following arguments:
-
--input: An application to be evaluated. --output: An output directory for the generated reports.mta-cli analyzecreates the following analysis reports:Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
--source: A source technology for the application migration, for example,weblogic. -
--target: A target technology for the application migration, for example,eap8.
-
Access the generated analysis report:
In the output of the
mta-cli analyzecommand, copy a path to theindex.htmlanalysis report file:Report created: <output_report_directory>/index.html Access it at this URL: file:///<output_report_directory>/index.htmlReport created: <output_report_directory>/index.html Access it at this URL: file:///<output_report_directory>/index.htmlCopy to Clipboard Copied! Toggle word wrap Toggle overflow - Paste the path to the browser of your choice.
Alternatively, press Ctrl and click on the path to the report file.
3.2. Analyzing multiple applications Copy linkLink copied to clipboard!
You can use the Migration Toolkit for Applications (MTA) CLI to perform an application analysis for multiple applications at once and generate a combined report.
Analyzing multiple applications is a Developer Preview feature only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
Procedure
Run the analysis for multiple applications.
ImportantYou must enter one input per analyze command, but make sure to enter the same output directory for all inputs.
For example, to analyze example applications
A,B, andC, enter the following commands:For input
A, enter:mta-cli analyze --bulk --input <path_to_input_A> --output <path_to_output_ABC> --source <source_A> --target <target_A>
$ mta-cli analyze --bulk --input <path_to_input_A> --output <path_to_output_ABC> --source <source_A> --target <target_A>Copy to Clipboard Copied! Toggle word wrap Toggle overflow For input
B, enter:mta-cli analyze --bulk --input <path_to_input_B> --output <path_to_output_ABC> --source <source_B> --target <target_B>
$ mta-cli analyze --bulk --input <path_to_input_B> --output <path_to_output_ABC> --source <source_B> --target <target_B>Copy to Clipboard Copied! Toggle word wrap Toggle overflow For input
C, enter:mta-cli analyze --bulk --input <path_to_input_C> --output <path_to_output_ABC> --source <source_C> --target <target_C>
$ mta-cli analyze --bulk --input <path_to_input_C> --output <path_to_output_ABC> --source <source_C> --target <target_C>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
- Access the analysis report. MTA generates a single report, listing all issues that must be resolved before the applications can be migrated.
3.3. Analyzing an application in containerless mode Copy linkLink copied to clipboard!
Starting from MTA 7.2.0, you can perform an application analysis for Java applications by using the MTA CLI that does not require installation of a container runtime.
In MTA 7.2.0 and later, containerless CLI is a default mode. To enable container runtime usage for the analysis of Java applications, you must set the --run-local flag to false:
--run-local=false
--run-local=false
The analysis for other applications runs in the container mode automatically
Prerequisites
- You installed the MTA CLI. For more information, see Installing the CLI by using a .zip file.
- You installed Java Development Kit (JDK) version 17 or later.
-
If you use OpenJDK on Red Hat Enterprise Linux (RHEL) or Fedora, you installed the Java
develpackage. - You installed Maven version 3.9.9 or later.
The CLI assumes that a path to the
mvnbinary is correctly registered in the system variable. Therefore, ensure that you addedmvnto the following variable:-
Pathfor Windows. -
PATHfor Linux and macOS.
-
-
You set the
JAVA_HOMEenvironmental variable. You set the
JVM_MAX_MEMsystem variable.NoteIf you do not set
JVM_MAX_MEM, the analysis might hang because Java might require more memory than the defaultJVM_MAX_MEMvalue.For Gradle analysis:
- You installed OpenJDK version 8.
-
You set
$JAVA8_HOMEand it is pointing to the OpenJDK 8 home directory. - Your project has a Gradle wrapper.
Procedure
Optional: Display all
mta-cli analyzecommand options:mta-cli analyze --help
$ mta-cli analyze --helpCopy to Clipboard Copied! Toggle word wrap Toggle overflow Run the application analysis:
mta-cli analyze --overwrite --input <path_to_input> --output <path_to_output> --target <target_source>
$ mta-cli analyze --overwrite --input <path_to_input> --output <path_to_output> --target <target_source>Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteThe
--overwriteoption overwrites the output folder if it exists.
3.4. The analyze command options Copy linkLink copied to clipboard!
The following are the options that you can use together with the mta-cli analyze command to adjust the command behavior to your needs.
| Option | Description |
|---|---|
|
| Analyze open-source libraries. |
|
|
Set When you disable Maven search, MTA at first tries to determine dependencies from the the JAR file’s POM file (if any). If this method does not succeed, MTA 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 MTA. You may see more number of incidents because some dependencies may be wrongly classified as internal.
By default, |
|
| The number of lines of source code to include in the output for each incident. The default is 100. |
|
| A directory for dependencies. |
|
|
Run default rulesets with analysis. The default is |
|
|
Display the available flags for the |
|
| An HTTP proxy string URL. |
|
| An HTTPS proxy string URL. |
|
| An expression to select incidents based on custom variables, for example: !package=io.demo.config-utils
|
|
| A path to the application source code or a binary. |
|
| A Jaeger endpoint to collect traces. |
|
| Create analysis and dependence output as a JSON file. |
|
| Run rules based on specified label selector expression. |
|
| List all languages in the source application. This flag is not supported for binary applications. |
|
| List available supported providers. |
|
| List rules for available migration sources. |
|
| List rules for available migration targets. |
|
| A path to the custom Maven settings file to use. |
|
| An analysis mode. Must be set to either of the following values:
|
|
| Proxy-excluded URLs (relevant only with proxy). |
|
| A path to the directory for analysis output. |
|
| Overwrite the output directory. |
|
| A filename or directory that contains rule files. |
|
|
Enable or disable container runtime usage for Java applications. For example, to enable container runtime, set |
|
| Do not generate the static report. |
|
| A source technology to consider for the analysis. To specify multiple sources, repeat the parameter, for example: --source <source_1> --source <source_2> ...
|
|
| A target technology to consider for the analysis. To specify multiple targets, repeat the parameter, for example: --target <target_1> --target <target_2> ...
|
|
| A log level. The default is 4. |
|
| Do not clean up temporary resources. |
Chapter 4. Analyzing applications written in languages other than Java with MTA command-line interface Copy linkLink copied to clipboard!
Starting from Migration Toolkit for Applications (MTA) version 7.1.0, you can run the application analysis on applications written in languages other than Java. 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.
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 Analyzing an application in containerless mode.
4.1. Analyzing an application for the selected supported language provider Copy linkLink copied to clipboard!
You can explicitly set a supported language provider according to your application’s language to run the analysis for.
Prerequisites
- You have the latest version of MTA CLI installed on your system.
Procedure
List language providers supported for the analysis:
mta-cli analyze --list-providers
$ mta-cli analyze --list-providersCopy to Clipboard Copied! Toggle word wrap Toggle overflow Run the application analysis for the selected language provider:
mta-cli analyze --input <path_to_input> --output <path_to_output> --provider <language_provider> --rules <path_to_custom_rules>
$ mta-cli analyze --input <path_to_input> --output <path_to_output> --provider <language_provider> --rules <path_to_custom_rules>Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantNote that if you do not set the
--provideroption, the analysis might fail because it detects unsupported providers. The analysis will complete without--provideronly if all discovered providers are supported.
4.2. Analyzing an application for an unsupported language provider Copy linkLink copied to clipboard!
You can run the analysis for an unsupported language provider. To do so, you must overwrite the existing supported language provider with your own unsupported language provider.
You must create a configuration file for your unsupported language provider before overriding the supported provider.
Prerequisites
You created a configuration file for your unsupported language provider, for example:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Procedure
Override an existing supported language provider with your unsupported provider and run the analysis:
mta-cli analyze --provider-override <path_to_configuration_file> --output <path_to_output> --rules <path_to_custom_rules>
$ mta-cli analyze --provider-override <path_to_configuration_file> --output <path_to_output> --rules <path_to_custom_rules>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 5. Reviewing an analysis report Copy linkLink copied to clipboard!
After analyzing an application, you can access an analysis report to check the details of the application migration effort.
5.1. Accessing an analysis report Copy linkLink copied to clipboard!
When you run an application analysis, a report is generated in the output directory that you specify by using the --output argument in the command line.
Procedure
Copy the path of the
index.htmlfile from the analysis output and paste it in a browser of your choice:Report created: <output_report_directory>/index.html Access it at this URL: file:///<output_report_directory>/index.htmlReport created: <output_report_directory>/index.html Access it at this URL: file:///<output_report_directory>/index.htmlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Alternatively, press Ctrl and click on the path of the
index.htmlfile.
5.2. Analysis report sections Copy linkLink copied to clipboard!
The following are sections of an analysis report that are available after the application analysis is complete. These sections contain additional details about the migration of an application.
You can only review the report applicable to the current application.
Insights is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.
| Section | Description |
|---|---|
| Dashboard | An overview of the incidents and total story points, sorted by category. |
| Issues | A concise summary of all issues and their details that require attention. |
| Dependencies | All Java-packaged dependencies found within the application. |
| Technologies | All embedded libraries grouped by functionality. Use this report to display the technologies used in each application. |
| Insights | Information about a violation generated by a rule with zero effort. Issues are generated by general rules, whereas string tags are generated by the tagging rules. String tags indicate the presence of a technology but do not show the code location. Insights contain information about the technologies used in the application and their usage in the code. Insights do not impact the migration. For example, a rule searching for deprecated API usage in the code that does not impact the current migration but can be tracked and fixed when needed in the future. Unlike with issues, you do not need to fix insights for a successful migration. They are generated by any rule that does not have a positive effort value and category assigned. They might have a message and tag. |
5.3. Reviewing the analysis issues and incidents Copy linkLink copied to clipboard!
After an analysis is complete, you can review issues that might appear during an application migration. 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 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.
Display the incident message by hovering over the line that triggered the incident, for example:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 6. Performing a transformation with the MTA command-line interface Copy linkLink copied to clipboard!
You can use transformation to transform Java applications source code by using the transform openrewrite command.
Performing transformation requires the container runtime to be configured.
6.1. Transforming applications source code Copy linkLink copied to clipboard!
To update Java libraries or frameworks, for example, javax or Spring Boot, you can transform Java application source code by using the transform openrewrite command. The openrewrite subcommand allows running OpenRewrite recipes on source code.
You can only use a single target to run the transform overwrite command.
Prerequisites
- You configured the container runtime.
Procedure
Display the available
OpenRewriterecipes:mta-cli transform openrewrite --list-targets
$ mta-cli transform openrewrite --list-targetsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Transform the application source code:
mta-cli transform openrewrite --input=<path_to_source_code> --target=<target_from_the_list>
$ mta-cli transform openrewrite --input=<path_to_source_code> --target=<target_from_the_list>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
-
Inspect the target application source code
diffto see the transformation.
6.2. Available OpenRewrite recipes Copy linkLink copied to clipboard!
The following are the OpenRewrite recipes that you can use for transforming application source code.
| Migration path | Purpose | The rewrite.config file location | Active recipes |
|---|---|---|---|
| Java EE to Jakarta EE |
Replace import of
Replace |
|
|
| Java EE to Jakarta EE | Rename bootstrapping files. |
|
|
| Java EE to Jakarta EE |
Transform the |
|
|
| Spring Boot to Quarkus |
Replace |
|
|
6.3. The openrewrite command options Copy linkLink copied to clipboard!
The following are the options that you can use together with the mta-cli transform openrewrite command to adjust the command behavior to your needs.
| Option | Description |
|---|---|
|
|
A target goal. The default is |
|
|
Display all |
|
| A path to the application source code directory. |
|
| List all available OpenRewrite recipes. |
|
| A path to a custom Maven settings file. |
|
| A target OpenRewrite recipe. |
|
|
A log level. The default is |
|
| Do not clean up temporary resources. |
Chapter 7. Generating platform assets for application deployment Copy linkLink copied to clipboard!
Starting from MTA version 7.3.0, you can use the discover and generate commands in containerless mode to automatically generate the manifests needed to deploy a Cloud Foundry (CF) application in the OpenShift Container Platform:
Use the
discovercommand to generate the discovery manifest in the YAML format directly from a CF instance or from either of the following manifest files:- A single application manifest
- A CF manifest
- A path to the directory with multiple manifest files, for example, with application manifests, CF manifests, or both of these manifest types.
The discovery manifest preserves the specifications found in the CF manifest. The specifications define the metadata, runtime, and platform configurations.
-
Use the
generatecommand to generate the deployment manifest for OCP deployments by using the discovery manifest. The deployment manifest is generated by using a templating engine, such as Helm, that converts the discovery manifest into a Kubernetes-native format. You can also use this command to generate non-Kubernetes manifests, such as a Dockerfile or a configuration file.
Generating platform assets for application deployment is a Developer Preview feature only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
Benefits of generating deployment assets
Generating deployment assets has the following benefits:
- Generating the Kubernetes and non-Kubernetes deployment manifests.
- Generating deployment manifests by using familiar template engines, for example, Helm, that are widely used for Kubernetes deployments.
- Adhering to Kubernetes best practices when preparing the deployment manifest by using Helm templates.
7.1. Generating a discovery manifest Copy linkLink copied to clipboard!
You can generate the discovery manifest for the Cloud Foundry (CF) application by using the discover command. The discovery manifest preserves configurations, such as application properties, resource allocations, environment variables, and service bindings found in the CF manifest.
Prerequisites
- You have Cloud Foundry (v3) as a source platform.
- You installed MTA CLI version 7.3.0 or later.
Procedure
-
Open the terminal application and navigate to the
<MTA_HOME>/directory. List the supported platforms for the discovery process:
mta-cli discover --list-platforms
$ mta-cli discover --list-platformsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Generate the discovery manifest:
mta-cli discover cloud-foundry --input <path_to_input> --output-dir <path_to_output-directory>
$ mta-cli discover cloud-foundry --input <path_to_input> --output-dir <path_to_output-directory>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.2. Performing a live discovery in a remote CF instance Copy linkLink copied to clipboard!
You can use a live discovery if you want to determine what is deployed in a certain Cloud Foundry (CF) cluster. For example, you can determine how many applications are in the cluster. You can also use the live discovery if you do not have access to manifest YAML files.
You can run the live discovery for a remote CF instance by using the mta-cli discover cloud-foundry --use-live-connection --spaces=<space_name> command.
You must always define Cloud Foundry spaces to analyze during a live discovery by using the --spaces option.
Prerequisites
- You have permission to remotely connect to the CF instance.
Procedure
Optional: Investigate the contents of the remote CF instance
cf spaces cf apps
$ cf spaces $ cf appsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Copy the CF configuration file to the directory of your choice:
mkdir <path_to_the_directory>/.cf
$ mkdir <path_to_the_directory>/.cfCopy to Clipboard Copied! Toggle word wrap Toggle overflow Run the live discovery in a remote CF instance:
mta-cli discover cloud-foundry --use-live-connection --spaces=<space_name> --output-dir <path_to_output_directory> --cf-config=<path_to_CF_config_file>
$ mta-cli discover cloud-foundry --use-live-connection --spaces=<space_name> --output-dir <path_to_output_directory> --cf-config=<path_to_CF_config_file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow The command runs the discovery for each application from each space.
If you want to run the discovery for a specific application, enter, for example:
mta-cli discover cloud-foundry --use-live-connection --app-name=<application_name> --spaces=<space_name> --output-dir <path_to_output_directory> --cf-config=<path_to_CF_config_file>
$ mta-cli discover cloud-foundry --use-live-connection --app-name=<application_name> --spaces=<space_name> --output-dir <path_to_output_directory> --cf-config=<path_to_CF_config_file>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.3. Concealing sensitive information in a discovery manifest Copy linkLink copied to clipboard!
You can conceal sensitive information, for example, services and docker credentials, in a Cloud Foundry (CF) discovery manifest by using the mta-cli discover cloud-foundry --conceal-sensitive-data command. This command generates the following files:
- A discovery manifest
- A file with concealed data
If you do not specify the --conceal-sensitive-data option, the option is automatically set to false.
Procedure
Display the contents of the CF manifest and locate sensitive data:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Generate the discovery manifest for the CF application as an output file and conceal sensitive data:
mta-cli discover cloud-foundry --conceal-sensitive-data=true --input <path_to_application_manifest> --output-dir <path_to_output_directory>
$ mta-cli discover cloud-foundry --conceal-sensitive-data=true --input <path_to_application_manifest> --output-dir <path_to_output_directory>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
Display the repository structure:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Display the contents of the discovery manifest:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The sensitive data was replaced with a UUID (Universally Unique Identifier).
Display the contents of the
secrets_<discovery_manifest_name>.yamlfile:cat secrets_<discovery_manifest_name>.yaml f0e9ea9e-1913-446f-8483-da9301373eef: docker-registry-user
$ cat secrets_<discovery_manifest_name>.yaml f0e9ea9e-1913-446f-8483-da9301373eef: docker-registry-userCopy to Clipboard Copied! Toggle word wrap Toggle overflow The file contains the mapping of the UUID to the concealed sensitive data.
7.4. Generating a deployment manifest Copy linkLink copied to clipboard!
You can auto-generate the Red Hat OpenShift Container Platform 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.
Prerequisites
- You have Cloud Foundry (v3) as a source platform.
- You have OpenShift Container Platform as a target platform.
- You installed MTA CLI version 7.3.0.
- You generated a discovery manifest.
- You created a Helm template with the required configuration for the OCP deployment.
Procedure
-
Open the terminal application and navigate to the
<MTA_HOME>/directory. Generate the deployment manifest as an output file:
mta-cli generate helm --chart-dir helm_sample \ --input <path_to_discovery-manifest> \ --output-dir <location_of_deployment_manifest> \
$ mta-cli generate helm --chart-dir helm_sample \ --input <path_to_discovery-manifest> \ --output-dir <location_of_deployment_manifest> \Copy to Clipboard Copied! Toggle word wrap Toggle overflow Verify the ConfigMap:
mta-cli cd <location_of_deployment_manifest> \ $ cat configmap.yaml cat configmap.yaml cat Dockerfile
$ mta-cli cd <location_of_deployment_manifest> \ $ cat configmap.yaml $ cat DockerfileCopy to Clipboard Copied! Toggle word wrap Toggle overflow Verify the Dockerfile:
mta-cli cd <location_of_deployment_manifest> \ $ cat Dockerfile cat Dockerfile
$ mta-cli cd <location_of_deployment_manifest> \ $ cat DockerfileCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.5. The discover and generate command options Copy linkLink copied to clipboard!
You can use the following options together with the discover or generate command to adjust the command behavior to your needs.
| Command | Option | Description |
|---|---|---|
|
|
| An application to run the discovery for. |
|
| Display details for different command arguments. | |
|
| List the available applications on the source platform, for example: | |
|
| List the supported platforms for the discovery process. | |
|
|
Set the log level, for example, | |
|
| Discover Cloud Foundry applications. | |
|
| Extract sensitive information from a discovery manifest and put it into a separate file. | |
|
| Specify the location of the YAML manifest file to discover the CF applications, for example:
| |
|
| Specify the location to save the <discovery-manifest-name>.yaml file. | |
|
| A comma-separated list of Cloud Foundry spaces to analyze during a live discovery, for example: --spaces=space1,space2,…
| |
|
| Enable real-time discovery by using live platform connections. | |
|
|
| Display details for different command arguments. |
|
| Generate a deployment manifest by using the Helm template. | |
|
| Specify a directory that contains the Helm chart. | |
|
| Specify a location of the <discovery-manifest-name>.yaml file to generate the deployment manifest. | |
|
| Generate only non-Kubernetes templates, such as a Dockerfile. | |
|
| Specify a location to which the deployment manifests are saved. | |
|
| Override values of attributes in the discovery manifest with the key-value pair entered from the CLI. |
7.6. Assets generation example Copy linkLink copied to clipboard!
The following is an example of generating discovery and deployment manifests of a Cloud Foundry (CF) Node.js application.
For this example, the following files and directories are used:
-
CF Node.js application manifest name:
cf-nodejs-app.yaml -
Discovery manifest name:
discover.yaml -
Location of the application Helm chart:
helm_sample - Deployment manifests: a ConfigMap and a Dockerfile
-
Output location of the deployment manifests:
newDir
Assumed that the cf-nodejs-app.yaml is located in the same directory as the MTA CLI binary. If the CF application manifest location is different, you can also enter the location path to the manifest as the input.
Prerequisites
- You installed MTA CLI 7.3.0.
- You have a CF application manifest as a YAML file.
- You created a Helm template with the required configurations for the OCP deployment.
Procedure
-
Open the terminal application and navigate to the
<MTA_HOME>/directory. Verify the content of the CF Node.js application manifest:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Generate the discovery manifest:
mta-cli discover cloud-foundry \ --input cf-nodejs-app.yaml \ --output discover.yaml \
$ mta-cli discover cloud-foundry \ --input cf-nodejs-app.yaml \ --output discover.yaml \Copy to Clipboard Copied! Toggle word wrap Toggle overflow Verify the content of the discover manifest:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Generate the deployment manifest in the
newDirdirectory by using thediscover.yamlfile:mta-cli generate helm \ --chart-dir helm_sample \ --input discover.yaml --output-dir newDir
$ mta-cli generate helm \ --chart-dir helm_sample \ --input discover.yaml --output-dir newDirCopy to Clipboard Copied! Toggle word wrap Toggle overflow Check the contents of the Dockerfile in the
newDirdirectory:cat ./newDir/Dockerfile FROM busybox:latest RUN echo "Hello cf-nodejs!"
$ cat ./newDir/Dockerfile FROM busybox:latest RUN echo "Hello cf-nodejs!"Copy to Clipboard Copied! Toggle word wrap Toggle overflow Check the contents of the ConfigMap in the
newDirdirectory:Copy to Clipboard Copied! Toggle word wrap Toggle overflow In the ConfigMap, override the
nametonodejs-appandINSTANCESto2:mta-cli generate helm \ --chart-dir helm_sample \ --input discover.yaml --set name="nodejs-app" \ --set instances=2 \ --output-dir newDir \
$ mta-cli generate helm \ --chart-dir helm_sample \ --input discover.yaml --set name="nodejs-app" \ --set instances=2 \ --output-dir newDir \Copy to Clipboard Copied! Toggle word wrap Toggle overflow Check the contents of the ConfigMap again:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 8. MTA CLI known issues Copy linkLink copied to clipboard!
This section provides highlighted known issues in MTA CLI.
Limitations with Podman on Microsoft Windows
The CLI is built and distributed with support for Microsoft Windows.
However, when running any container image based on Red Hat Enterprise Linux 9 (RHEL9) or Universal Base Image 9 (UBI9), the following error can be returned when starting the container:
Fatal glibc error: CPU does not support x86-64-v2
Fatal glibc error: CPU does not support x86-64-v2
This error is caused because Red Hat Enterprise Linux 9 or Universal Base Image 9 container images must be run on a CPU architecture that supports x86-64-v2.
For more details, see (Running Red Hat Enterprise Linux 9 (RHEL) or Universal Base Image (UBI) 9 container images fail with "Fatal glibc error: CPU does not support x86-64-v2").
CLI runs the container runtime correctly. However, different container runtime configurations are not supported.
Although unsupported, you can run CLI with Docker instead of Podman, which would resolve this issue.
To achieve this, you replace the CONTAINER_TOOL path with the path to Docker.
For example, if you experience this issue, instead of issuing:
CONTAINER_TOOL=/usr/local/bin/docker mta-cli analyze
CONTAINER_TOOL=/usr/local/bin/docker mta-cli analyze
You replace CONTAINER_TOOL with the path to Docker:
<Docker Root Dir>=/usr/local/bin/docker mta-cli analyze
<Docker Root Dir>=/usr/local/bin/docker mta-cli analyze
While this is not supported, it would allow you to explore CLI while you work to upgrade your hardware or move to hardware that supports x86_64-v2.
Appendix A. Reference material Copy linkLink copied to clipboard!
The following is information that you might find useful when using the Migration Toolkit for Applications (MTA) CLI.
A.1. Supported technology tags Copy linkLink copied to clipboard!
The following technology tags are supported in MTA 8.0.0:
- 0MQ Client
- 3scale
- Acegi Security
- AcrIS Security
- ActiveMQ library
- Airframe
- Airlift Log Manager
- AKKA JTA
- Akka Testkit
- Amazon SQS Client
- AMQP Client
- Anakia
- AngularFaces
- ANTLR StringTemplate
- AOP Alliance
- Apache Accumulo Client
- Apache Aries
- Apache Commons JCS
- Apache Commons Validator
- Apache Flume
- Apache Geronimo
- Apache Hadoop
- Apache HBase Client
- Apache Ignite
- Apache Karaf
- Apache Mahout
- Apache Meecrowave JTA
- Apache Sirona JTA
- Apache Synapse
- Apache Tapestry
- Apiman
- Applet
- Arquillian
- AspectJ
- Atomikos JTA
- Avalon Logkit
- Axion Driver
- Axis
- Axis2
- BabbageFaces
- Bean Validation
- BeanInject
- Blaze
- Blitz4j
- BootsFaces
- Bouncy Castle
- ButterFaces
- Cache API
- Cactus
- Camel
- Camel Messaging Client
- Camunda
- Cassandra Client
- CDI
- Cfg Engine
- Chunk Templates
- Cloudera
- Coherence
- Common Annotations
- Composite Logging
- Composite Logging JCL
- Concordion
- CSS
- Cucumber
- Dagger
- DbUnit
- Demoiselle JTA
- Derby Driver
- Drools
- DVSL
- Dynacache
- EAR Deployment
- Easy Rules
- EasyMock
- Eclipse RCP
- EclipseLink
- Ehcache
- EJB
- EJB XML
- Elasticsearch
- Entity Bean
- EtlUnit
- Eureka
- Everit JTA
- Evo JTA
- Feign
- File system Logging
- FormLayoutMaker
- FreeMarker
- Geronimo JTA
- GFC Logging
- GIN
- GlassFish JTA
- Google Guice
- Grails
- Grapht DI
- Guava Testing
- GWT
- H2 Driver
- Hamcrest
- Handlebars
- HavaRunner
- Hazelcast
- Hdiv
- Hibernate
- Hibernate Cfg
- Hibernate Mapping
- Hibernate OGM
- HighFaces
- HornetQ Client
- HSQLDB Driver
- HTTP Client
- HttpUnit
- ICEfaces
- Ickenham
- Ignite JTA
- Ikasan
- iLog
- Infinispan
- Injekt for Kotlin
- Iroh
- Istio
- Jamon
- Jasypt
- Java EE Batch
- Java EE Batch API
- Java EE JACC
- Java EE JAXB
- Java EE JAXR
- Java EE JSON-P
- Java Transaction API
- JavaFX
- JavaScript
- Javax Inject
- JAX-RS
- JAX-WS
- JayWire
- JBehave
- JBoss Cache
- JBoss EJB XML
- JBoss logging
- JBoss Transactions
- JBoss Web XML
- JBossMQ Client
- JBPM
- JCA
- Jcabi Log
- JCache
- JCunit
- JDBC
- JDBC datasources
- JDBC XA datasources
- Jersey
- Jetbrick Template
- Jetty
- JFreeChart
- JFunk
- JGoodies
- JMock
- JMockit
- JMS Connection Factory
- JMS Queue
- JMS Topic
- JMustache
- JNA
- JNI
- JNLP
- JPA entities
- JPA Matchers
- JPA named queries
- JPA XML
- JSecurity
- JSF
- JSF Page
- JSilver
- JSON-B
- JSP Page
- JSTL
- JTA
- Jukito
- JUnit
- Ka DI
- Keyczar
- Kibana
- KLogger
- Kodein
- Kotlin Logging
- KouInject
- KumuluzEE JTA
- LevelDB Client
- Liferay
- LiferayFaces
- Lift JTA
- Log.io
- Log4J
- Log4s
- Logback
- Logging Utils
- Logstash
- Lumberjack
- Macros
- Magicgrouplayout
- Management EJB
- MapR
- MckoiSQLDB Driver
- Memcached
- Message (MDB)
- Micro DI
- Micrometer
- Microsoft SQL Driver
- MiGLayout
- MinLog
- Mixer
- Mockito
- MongoDB Client
- Monolog
- Morphia
- MRules
- Mule
- Mule Functional Test Framework
- MultithreadedTC
- Mycontainer JTA
- MyFaces
- MySQL Driver
- Narayana Arjuna
- Needle
- Neo4j
- NLOG4J
- Nuxeo JTA/JCA
- OACC
- OAUTH
- OCPsoft Logging Utils
- OmniFaces
- OpenFaces
- OpenPojo
- OpenSAML
- OpenWS
- OPS4J Pax Logging Service
- Oracle ADF
- Oracle DB Driver
- Oracle Forms
- Orion EJB XML
- Orion Web XML
- Oscache
- OTR4J
- OW2 JTA
- OW2 Log Util
- OWASP CSRF Guard
- OWASP ESAPI
- Peaberry
- Pega
- Persistence units
- Petals EIP
- PicketBox
- PicketLink
- PicoContainer
- Play
- Play Test
- Plexus Container
- Polyforms DI
- Portlet
- PostgreSQL Driver
- PowerMock
- PrimeFaces
- Properties
- Qpid Client
- RabbitMQ Client
- RandomizedTesting Runner
- Resource Adapter
- REST Assured
- Restito
- RichFaces
- RMI
- RocketMQ Client
- Rythm Template Engine
- SAML
- Santuario
- Scalate
- Scaldi
- Scribe
- Seam
- Security Realm
- ServiceMix
- Servlet
- ShiftOne
- Shiro
- Silk DI
- SLF4J
- Snippetory Template Engine
- SNMP4J
- Socket handler logging
- Spark
- Specsy
- Spock
- Spring
- Spring Batch
- Spring Boot
- Spring Boot Actuator
- Spring Boot Cache
- Spring Boot Flo
- Spring Cloud Config
- Spring Cloud Function
- Spring Data
- Spring Data JPA
- spring DI
- Spring Integration
- Spring JMX
- Spring Messaging Client
- Spring MVC
- Spring Properties
- Spring Scheduled
- Spring Security
- Spring Shell
- Spring Test
- Spring Transactions
- Spring Web
- SQLite Driver
- SSL
- Standard Widget Toolkit (SWT)
- Stateful (SFSB)
- Stateless (SLSB)
- Sticky Configured
- Stripes
- Struts
- SubCut
- Swagger
- SwarmCache
- Swing
- SwitchYard
- Syringe
- Talend ESB
- Teiid
- TensorFlow
- Test Interface
- TestNG
- Thymeleaf
- TieFaces
- tinylog
- Tomcat
- Tornado Inject
- Trimou
- Trunk JGuard
- Twirl
- Twitter Util Logging
- UberFire
- Unirest
- Unitils
- Vaadin
- Velocity
- Vlad
- Water Template Engine
- Web Services Metadata
- Web Session
- Web XML File
- WebLogic Web XML
- Webmacro
- WebSocket
- WebSphere EJB
- WebSphere EJB Ext
- WebSphere Web XML
- WebSphere WS Binding
- WebSphere WS Extension
- Weka
- Weld
- WF Core JTA
- Wicket
- Winter
- WSDL
- WSO2
- WSS4J
- XACML
- XFire
- XMLUnit
- Zbus Client
- Zipkin
A.2. Rule story points Copy linkLink copied to clipboard!
Story points are an abstract metric commonly used in Agile software development to estimate the level of effort required to implement a feature or change.
The Migration Toolkit for Applications uses story points to express the level of effort needed to migrate particular application constructs, and the application as a whole. It does not necessarily translate to man-hours, but the value must be consistent across tasks.
A.2.1. Guidelines for the level of effort estimation Copy linkLink copied to clipboard!
The following are the general guidelines MTA uses when estimating the level of effort required for a rule.
| Level of Effort | Story Points | Description |
|---|---|---|
| Information | 0 | An informational warning with very low or no priority for migration. |
| Trivial | 1 | The migration is a trivial change or a simple library swap with no or minimal API changes. |
| Complex | 3 | The changes required for the migration task are complex, but have a documented solution. |
| Redesign | 5 | The migration task requires a redesign or a complete library change, with significant API changes. |
| Rearchitecture | 7 | The migration requires a complete rearchitecture of the component or subsystem. |
| Unknown | 13 | The migration solution is not known and may need a complete rewrite. |
A.2.2. Migration tasks categories Copy linkLink copied to clipboard!
In addition to the level of effort, you can categorize migration tasks to indicate the severity of the task. The following categories are used to group issues to help prioritize the migration effort.
- Mandatory
- The task must be completed for a successful migration. If the changes are not made, the resulting application will not build or run successfully. Examples include replacement of proprietary APIs that are not supported in the target platform.
- Optional
- If the migration task is not completed, the application should work, but the results might not be optimal. If the change is not made at the time of migration, it is recommended to put it on the schedule soon after your migration is completed.
- Potential
- The task should be examined during the migration process, but there is not enough detailed information to determine if the task is mandatory for the migration to succeed. An example of this would be migrating a third-party proprietary type where there is no directly compatible type.
- Information
- The task is included to inform you of the existence of certain files. These might need to be examined or modified as part of the modernization effort, but changes are typically not required.
Appendix B. Contributing to the MTA project Copy linkLink copied to clipboard!
You can help the Migration Toolkit for Applications 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 jboss-migration-feedback@redhat.com and let us know what MTA migration rules must cover.
- Provide example applications to test migration rules.
Identify application components and problem areas that might be difficult to migrate:
- Write a short description of the problem migration areas.
- Write a brief overview describing how to solve the problem in migration areas.
- Try Migration Toolkit for Applications on your application. Make sure to report any issues you meet.
- Try Migration Toolkit for Applications on your application. Make sure to report any issues you meet. MTA uses Jira as its issue tracking system. If you encounter an issue executing MTA, submit a Jira issue.
Contribute to the Migration Toolkit for Applications rules repository:
- Write a Migration Toolkit for Applications rule to identify or automate a migration process.
Create a test for the new rule.
For more information, see Rule Development Guide.
Contribute to the project source code:
- Create a core rule.
- Improve MTA performance or efficiency.