User Interface Guide

Procedure

1. In the OpenShift Container Platform web console, click Operators → OperatorHub.
2. Use the Filter by keyword field to search for MTA.
3. Click the Migration Toolkit for Applications Operator and then click Install.
4. On the Install Operator page, click Install.
5. Click Operators → Installed Operators to verify that the MTA Operator appears in the openshift-mta project with the status Succeeded.
6. Click the MTA Operator.

7. Under Provided APIs, locate Tackle, and click Create Instance.

   The Create Tackle window opens in Form view.

8. Review the CR settings. The default choices should be acceptable, but make sure to check the system requirements for storage, memory, and cores.

9. To work directly with the YAML file, click YAML view and review the CR settings that are listed in the spec section of the YAML file.

   The most commonly used CR settings are listed in this table:

   Table 3.2. Tackle CR settings

   Name	Default	Description
   cache_data_volume_size	100 GiB	Size requested for the cache volume; ignored when rwx_supported=false
   cache_storage_class	Default storage class	Storage class used for the cache volume; ignored when rwx_supported=false
   feature_auth_required	True	Flag to indicate whether keycloak authorization is required (single user/“noauth”)
   feature_isolate_namespace	True	Flag to indicate whether namespace isolation using network policies is enabled
   hub_database_volume_size	5 GiB	Size requested for the Hub database volume
   hub_bucket_volume_size	100 GiB	Size requested for the Hub bucket volume
   hub_bucket_storage_class	Default storage class	Storage class used for the bucket volume
   keycloak_database_data_volume_size	1 GiB	Size requested for the Keycloak database volume
   pathfinder_database_data_volume_size	1 GiB	Size requested for the Pathfinder database volume
   maven_data_volume_size	100 GiB	Size requested for the Maven m2 cache volume; deprecated in MTA 6.0.1
   rwx_storage_class	NA	Storage class requested for the Tackle RWX volumes; deprecated in MTA 6.0.1
   rwx_supported	True	Flag to indicate whether the cluster storage supports RWX mode
   rwo_storage_class	NA	Storage class requested for the Tackle RW0 volumes
   rhsso_external_access	False	Flag to indicate whether a dedicated route is created to access the MTA managed RHSSO instance
   windup_container_limits_cpu	1	Maximum number of CPUs the pod is allowed to use
   windup_container_limits_memory	6Gi	Maximum amount of memory the pod is allowed to use. You can increase this limit if the pod displays OOMKilled errors.
   windup_container_requests_cpu	1	Minimum number of CPUs the pod needs to run
   windup_container_requests_memory	4Gi	Minimum amount of memory the pod needs to run

   Example YAML file

   kind: Tackle
   apiVersion: tackle.konveyor.io/v1alpha1
   metadata:
     name: mta
     namespace: openshift-mta
   spec:
     hub_bucket_volume_size: "25Gi"
     maven_data_volume_size: "25Gi"
     rwx_supported: "false"

10. Edit the CR settings if needed, and then click Create.
11. In Administration view, click Workloads → Pods to verify that the MTA pods are running.
12. Access the user interface from your browser by using the route exposed by the mta-ui application within OpenShift.

13. Use the following credentials to log in:

    • User name: admin
    • Password: Passw0rd!
14. When prompted, create a new password.

Procedure

1. In the Administration view, click Proxy.
2. Toggle HTTP proxy or HTTPS proxy to enable the proxy connection.

3. Enter the following information:

   • Proxy host
   • Proxy port
4. Optional: Toggle HTTP proxy credentials or HTTPS proxy credentials to enable authentication.
5. Click Insert.

1. Create Stakeholder groups
2. Create Job functions
3. Create Stakeholders

1. Create Tag categories
2. Create Tags

Procedure

1. In Administration view, click Credentials.

   The Credentials page opens.

2. Click Create new.

3. Enter the following information:

   • Name
   • Description (optional)

4. In the Type list, select Basic Auth (Jira) or Bearer Token (Jira):

   • If you selected Basic Auth (Jira), proceed as follows:

     1. In the Email field, enter your email.

     2. In the Token field, depending on the specific Jira configuration, enter either your token generated on the Jira site or your Jira login password.

        Note

        To obtain a Jira token, you need to log in to the Jira site.

     3. Click Save.

        The new credential appears on the Credentials page.

   • If you selected Bearer Token (Jira), proceed as follows:

     1. In the Token field, enter your token generated on the Jira site.

     2. Click Save.

        The new credential appears on the Credentials page.

Procedure

1. In Administration view, under Issue Management, click Jira.

   The Jira configuration page opens.

2. Click Create new.

   The New instance window opens.

3. Enter the following information:

   • Name of the instance
   • URL of the web interface of your Jira account
   • Instance type - select either Jira Cloud or Jira Server/Data center from the list

   • Credentials - select from the list

     Note

     If the selected instance type is Jira Cloud, only Basic Auth credentials are displayed in the list.

     If the selected instance type is Jira Server/Data center, both Basic Auth and Token Bearer credentials are displayed. Choose the type that is appropriate for the particular configuration of your Jira server or data center.

4. By default, a connection cannot be established with a server with an invalid certificate. To override this restriction, toggle the Enable insecure communication switch.

5. Click Create.

   The new connection instance appears on the Jira configuration page.

   Once the connection has been established and authorized, the status in the Connection column becomes Connected.

   If the Connection status becomes Not connected, click the status to see the reason for the error.

Procedure

1. In Migration view, click Application inventory.

2. Select the application you want to assess.

   Note

   Only one application can be assessed at a time.

3. Click Assess.

4. Select Stakeholders and Stakeholder groups from the lists to track who contributed to the assessment for future reference.

   Note

   You can add Stakeholder Groups or Stakeholders on the Controls screen of Migration view.

5. Click Next.
6. Answer each question and then click Next.
7. Click Save and Review to view the assessment.

Procedure

1. In Migration view, click Application inventory.

2. Select the application you want to review.

   Note

   Only one application can be reviewed at a time.

3. Click Review.
4. Select Proposed action and Effort estimate from the lists. Set Business criticality and Work priority.

5. Click Submit review.

   The fields from Review are now populated on the Application details page.

Procedure

1. In Migration view, click Application inventory.
2. Click the Analysis tab.
3. Select the applications you want to analyze.
4. Review the credentials assigned to the application.
5. Click Analyze.

6. Select the Analysis mode from the list. Valid options are:

   • Binary.
   • Source code.
   • Source code and dependencies.
   • Upload a local binary. This option only appears if you are analyzing a single application.
7. If you choose Upload a local binary, a window opens and you are prompted to Upload a local binary. Either drag and drop a file into the area provided or click Upload and then select the file to upload.
8. Click Next.

9. Select one or more target options for the analysis:

   • Application server migration to:

     • JBoss EAP 7
     • JBoss EAP 6
   • Containerization
   • Quarkus
   • OracleJDK to OpenJDK

   • OpenJDK - upgrades to one of the following JDK versions:

     • OpenJDK 11
     • OpenJDK 17
   • Linux - ensures there are no Microsoft Windows paths hard-coded into your applications
   • Jakarta EE 9 - for migrating from Java EE 8 to Jakarta EE 9
   • Spring Boot on Red Hat Runtimes
   • Open Liberty
   • Camel - for migrating from Apache Camel 2 to Apache Camel 3

   • Azure

     • Azure App Service
10. Click Next.

11. Select one of the following Scope options to better focus the analysis:

    • Application and internal dependencies only.
    • Application and all dependencies, including known Open Source libraries.
    • Select the list of packages to be analyzed manually. If you choose this option, type the file name and click Add.
    • Exclude packages. If you choose this option, type the name of the package name and click Add.
12. Click Next.

13. In Advanced, you can attach additional custom rules to the analysis. Select Manual or Repository.

    Note

    Attaching custom rules is optional if you have already attached a migration target to the analysis. If you have not attached any migration target, you must attach rules.

    • In Manual mode, click Add Rules. Then either drag and drop the relevant files or select them from their directory and click Add.
    • In Repository mode, you can add rule files from a Git or Subversion repository.

14. Set any of the following options, if needed:

    • Target
    • Source(s)
    • Excluded rules tags: Rules with these tags are not processed. Add or delete as needed.
    • Enable transaction report: Select the checkbox to generate a DIVA report that displays the call stack, which executes operations on relational database tables.

    • Enable automated tagging: Select the checkbox to automatically attach tags to the application. This checkbox is selected by default.

      Note

      The Transactions report 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.

      Note

      Note that the automatically attached tags are displayed only after you run the analysis.

      You can attach tags to the application manually, instead of enabling automated tagging or in addition to it.

      Note

      Analysis engines use standard rules for a comprehensive set of migration targets, but if the target is not included or is a customized framework, custom rules can be added. Custom rules files are validated.

15. Click Next.
16. In Review, verify the analysis parameters.

17. Click Run.

    Analysis status is Scheduled as MTA downloads the image for the container to execute. When the image is downloaded, the status changes to In-progress.

    Note

    Analysis takes minutes to hours to run depending on the size of the application and the capacity and resources of the cluster.

    Tip

    MTA relies on Kubernetes scheduling capabilities to determine how many analyzer instances are created based on cluster capacity. If several applications are selected for analysis, by default, only one analyzer can be provisioned at a time. With more cluster capacity, more analysis processes can be executed in parallel.

18. When analysis is complete, you can click the Report link to see the results of the analysis.

Procedure

1. In Administration view, click Custom migration targets.
2. Click Create new.
3. Fill in the name and description of the target.
4. In the Image section, upload an image file for the target’s icon. The file can be in either PNG or JPEG format, up to 1 MB. If you do not upload any file, a default icon is used.

5. In the Custom rules section, select either Upload manually or Retrieve from a repository.

   • If you have selected Upload manually, upload or drag and drop the required rule files from your local drive.

   • If you have selected Retrieve from a repository, proceed as follows:

     1. Choose Git or Subversion.
     2. Fill in Source repository, Branch and Root path.
     3. If the repository requires credentials, enter them in the Associated credentials field.

6. Click Create.

   The new migration target appears on the Custom migration targets page. It can now be used by non-admin users in Migration view.

Procedure

1. In Migration view, click Application inventory.
2. Expand the application with a completed analysis.
3. Click Reports.
4. Click the dependencies or source links.
5. Click the tabs to review the report.

Procedure

1. In Migration view, click Application Inventory.
2. Click Create new.

3. Enter the following information or choose from a list:

   • Name
   • Description (optional)
   • Business service (optional)
   • Tags (optional; one or more)
   • Owner (optional)
   • Contributors (optional; one or more)
   • Comments (optional)
4. Click the arrow to the left of Source Code.

5. Enter the following information or choose from a list:

   • Repository type
   • Source repository
   • Branch
   • Root path
6. Click the arrow to the left of Binary.

7. Enter the following information:

   • Group
   • Artifact
   • Version
   • Packaging
8. Click Create.

Procedure

1. In Migration view, click Application inventory.
2. Click the Analysis tab.
3. Click the Options menu to the right of Analyze and select Manage credentials.
4. Select one credential each from the Source credentials list and from the Maven settings list.
5. Click Save.

Procedure

1. Review the import file to ensure it contains all the required information in the required format.
2. In Migration view, click Application Inventory.
3. Click the Options menu to the right of Review.
4. Click Import.
5. Browse to the desired file and click Open.
6. Optional: Select Enable automatic creation of missing entities. By default, this option is selected.
7. Verify the import has completed and check the number of rows accepted or rejected.

8. Review the imported applications by clicking the arrow to the left of the checkbox.

   Important

   Rows accepted may not match the number of applications in the Application inventory list because some rows are dependencies. To verify, check the Record Type column of the CSV file for applications defined as 1 and dependencies as 2.

Procedure

1. In Migration view, click Application inventory.
2. Click the Options menu to the right of Review.
3. Click Manage imports to open the Application imports page.
4. Click the Options menu to the right of Import and then click Download CSV template.

Procedure

1. In Migration view, click Migration waves.

2. Click Create new.

   The New migration wave window opens.

3. Enter the following information or select from drop-down lists:

   • Name (optional; if not given, you can use the start and end dates to identify migration waves)
   • Potential start date; it must be later than the current date
   • Potential end date; it must be later than the start date
   • Stakeholders (optional)
   • Stakeholder groups (optional)

4. Click Create.

   The new migration wave appears in the list of existing migration waves.

5. To assign applications to a migration wave, click the Options menu ( ) to the right of the migration wave and select Manage applications from the menu.

   The Manage applications window opens. The window displays the list of applications that are not assigned to any other migration wave.

6. Select the checkboxes of the applications that you want to assign to the migration wave and click Save.

   Note

   The owner and the contributors of each application associated with the migration wave are automatically added to the migration wave’s list of stakeholders.

7. To update a migration wave, select Update from its Options menu (three dots).

   The Update migration wave window opens.

Procedure

1. In Migration view, click Migration waves.

2. Click the Options menu ( ) to the right of the migration wave for which you want to create Jira issues and select Export to Issue Manager.

   The Export to Issue Manager window opens.

3. Select the instance type (Jira Cloud or Jira Server/Datacenter).
4. Select the instance, project and issue type from the lists.

5. Click Export.

   The status of the migration wave on the Migration waves page changes to Issues Created. To see the status of each individual application of a migration wave, click the Status column.

   A separate Jira issue is created for each application associated with the migration wave. The following fields of each issue are filled in automatically:

   • Title: Migrate <application name>
   • Reporter: Username of the token owner
   • Description: Created by Konveyor