Windup Documentation

View on GitHub

User Interface Guide

Table of Contents

Making open source more inclusive

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.

1. Introduction

1.1. About the User Interface Guide

This guide is for architects, engineers, consultants, and others who want to use the Migration Toolkit for Applications (MTA) User Interface to accelerate large-scale application modernization efforts across hybrid cloud environments on Red Hat OpenShift. This solution provides insight throughout the adoption process, at both the portfolio and application levels: inventory, assess, analyze, and manage applications for faster migration to OpenShift via the user interface.

Note

The migration solution that was provided in the Migration Toolkit for Applications 5.x releases (migration and modernization of Java applications) is now available with Migration Toolkit for Runtimes 1.0.

1.2. About the Migration Toolkit for Applications

What is the Migration Toolkit for Applications?

Migration Toolkit for Applications (MTA) accelerates large-scale application modernization efforts across hybrid cloud environments on Red Hat OpenShift. This solution provides insight throughout the adoption process, at both the portfolio and application levels: inventory, assess, analyze, and manage applications for faster migration to OpenShift via the user interface.

MTA uses an extensive questionaire as the the basis for assessing your applications, enabling you to estimate the difficulty, time, and other resources needed to prepare an application for containerization. You can use the results of an assessment as the basis for discussions between stakeholders to determine which applications are good candidates for containerization, which require significant work first, and which are not suitable for containerization.

MTA analyzes applications by applying one or more rulesets to each application considered to determine which specific lines of that application must be modified before it can be modernized.

MTA examines application artifacts, including project source directories and application archives, and then produces an HTML report highlighting areas needing changes. MTA supports many migration paths including the following:

  • Upgrading to the latest release of Red Hat JBoss Enterprise Application Platform

  • Migrating from Oracle WebLogic or IBM WebSphere Application Server to Red Hat JBoss Enterprise Application Platform

  • Containerizing applications and making them cloud-ready

  • Migrating from Java Spring Boot to Quarkus

  • Upgrading from OpenJDK 8 to OpenJDK 11

  • Upgrading from OpenJDK 11 to OpenJDK 17

  • Migrating EAP Java applicatons to Azure App Service

  • Migrating Spring Boot Java applications to Azure App Service

For more information about use cases and migration paths, see the MTA for developers web page.

How does the Migration Toolkit for Applications simplify migration?

The Migration Toolkit for Applications looks for common resources and known trouble spots when migrating applications. It provides a high-level view of the technologies used by the application.

MTA generates a detailed report evaluating a migration or modernization path. This report can help you to estimate the effort required for large-scale projects and to reduce the work involved.

1.3. About the User Interface

The User Interface for the Migration Toolkit for Applications allows a team of users to assess and analayze applications for risks and suitability for migration to hybrid cloud environments on Red Hat OpenShift.

Use the User Interface to assess and analyze your applications to get insights about potential pitfalls in the adoption process, at both the portfolio and application levels as you inventory, assess, analyze, and manage applications for faster migration to OpenShift.

2. User interface views

The Migration Toolkit for Applications (MTA) User Interface has two views:

  • Administrator view

  • Developer view

In Administrator view, you configure the instance environment, working with credentials, repositories, and HTTP and HTTPS proxy definitions.

In Developer view, you perform application assessments and analyses, review reports, and add applications for assessment and analysis.

3. Installing the Migration Toolkit for Applications User Interface

You install the Migration Toolkit for Applications (MTA) User Interface as part of the process of installing the MTA Operator on the OpenShift Container Platform.

The MTA Operator is a structural layer that manages resources deployed on Kubernetes (database, front end, back end) to automatically create an MTA instance instead of you doing it manually.

3.1. Persistent volume requirements

The MTA Operator requires a total of 5 persistent volumes (PVs) used by different components to successfully deploy, 3 RWO volumes and 2 RWX volumes that are requested via PVCs. The 5 PVs are described in the table below:

Table 1. Required persistent volumes
Name Default size Access mode Description

hub database

5 Gi

RWO

Hub database

hub bucket

100 Gi

RWX

Hub file storage

keycloak postgresql

1 Gi

RWO

Keycloak back end database

pathfinder postgresql

1 Gi

RWO

Pathfinder back end database

maven

100 Gi

RWX

Maven m2 repository

3.2. Installing the Migration Toolkit for Applications Operator and the User Interface

You can install the Migration Toolkit for Applications (MTA) and the User Interface on OpenShift Container Platform versions 4.9-4.11 when you install the Migration Toolkit for Applications Operator.

Prerequisites

  • 4 vCPUs, 8 GB RAM, and 40 GB persistent storage.

  • OpenShift Container Platform 4.9-4.11 installed.

  • You must be logged in as a user with cluster-admin permissions.

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.

  8. Review options - the default selections should be OK, but be sure to validate the system requirements for storage, memory, and cores - and then click Create.

  9. In Administrator view, click Workloads → Pods to verify that the MTA pods are running.

  10. Access the User Interface from your browser by using the route exposed by the mta-web-console application within OpenShift.

  11. Use the following credentials to log in:

    • User name: admin

    • Password: Passw0rd!

  12. When prompted, create a new password.

4. Configuring the instance environment

You can configure the following in Administrator view:

  • Credentials

  • Repositories

  • HTTP and HTTPS proxy settings

4.1. Configuring credentials

You can configure the following types of credentials in Administrator view:

  • Source control

  • Maven

  • Proxy

4.1.1. Configuring source control credentials

You can configure source control credentials in the Credentials view of the Migration Toolkit for Applications (MTA) User Interface.

Procedure

  1. In Administrator view, click Credentials.

  2. Click Create new.

  3. Enter the following information:

    • Name

    • Description (Optional)

  4. In the Type list, select Source Control.

  5. In the User credentials list, select Credential Type and enter the requested information:

    • Username/Password

      • Username

      • Password (hidden)

    • SCM Private Key/Passphrase

      • SCM Private Key

      • Private Key Passphrase (hidden)

        Note

        Type-specific credential information such as keys and passphrases is either hidden or shown as [Encrypted].

  6. Click Create.

    MTA validates the input and creates a new credential. SCM keys must be parsed and checked for validity. If the validation fails, the following error message is displayed: “not a valid key/XML file”.

4.1.2. Configuring Maven credentials

You can configure new Maven credentials in the Credentials view of the Migration Toolkit for Applications (MTA) User Interface.

Procedure

  1. In Administrator view, click Credentials.

  2. Click Create new.

  3. Enter the following information:

    • Name

    • Description (Optional)

  4. In the Type list, select Maven Settings File.

  5. Upload the settings file or paste its contents.

  6. Click Create.

    MTA validates the input and creates a new credential. The Maven settings.xml file must be parsed and checked for validity. If the validation fails, the following error message is displayed: “not a valid key/XML file”.

4.1.3. Configuring proxy credentials

You can configure proxy credentials in the Credentials view of the Migration Toolkit for Applications (MTA) User Interface.

Procedure

  1. In Administrator view, click Credentials.

  2. Click Create new.

  3. Enter the following information:

    • Name

    • Description (Optional)

  4. In the Type list, select Proxy.

  5. Enter the following information.

    • Username

    • Password

      Note

      Type-specific credential information such as keys and passphrases is either hidden or shown as [Encrypted].

  6. Click Create.

    MTA validates the input and creates a new credential.

4.2. Configuring repositories

You can configure the following types of repositories in Administrator view:

  • Git

  • Subversion

  • Maven

4.2.1. Configuring Git repositories

You can configure Git respositories in the Repositories view of the Migration Toolkit for Applications (MTA) User Interface.

Procedure

  1. In Administrator view, click Repositories and then click Git.

  2. Toggle the Consume insecure Git repositories switch to the right.

4.2.2. Configuring subversion repositories

You can configure subversion respositories in the Repositories view of the Migration Toolkit for Applications (MTA) User Interface.

Procedure

  1. In Administrator view, click Repositories and then click Subversion.

  2. Toggle the Consume insecure Subversion repositories switch to the right.

4.2.3. Configuring a Maven repository and reducing its size

You can use the MTA User Interface to both configure a Maven repository and to reduce its size.

Configuring a Maven repository

You can configure a Maven repository in the Repositories view of the Migration Toolkit for Applications (MTA) User Interface.

Procedure

  1. In Administrator view, click Repositories and then click Maven.

  2. Toggle the Consume insecure artifact repositories switch to the right.

Reducing the size of a Maven repository

You can reduce the size of a Maven repository in the Repositories view of the Migration Toolkit for Applications (MTA) User Interface.

Procedure

  1. In Administrator view, click Repositories and then click Maven.

  2. Click the Clear repository link.

    Note

    Depending on the size of the repository, the size change may not be evident despite the function working properly.

4.3. Configuring HTTP and HTTPS proxy settings

You can configure HTTP and HTTPS proxy settings with this management module.

Procedure

  1. In the Administrator 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.

4.4. Seeding an instance

If you are a project architect, you can configure the instance’s key parameters in the Controls window, before migration. The parameters can be added and edited as needed. The following parameters define applications, individuals, teams, verticals or areas within an organization affected or participating in the migration:

  • Stakeholders

  • Stakeholder groups

  • Job functions

  • Business services

  • Tag types

  • Tags

You can create and configure an instance in any order. However, the suggested order below is the most efficient for creating stakeholders and tags.

Stakeholders:

  1. Create stakeholder groups

  2. Create job functions

  3. Create stakeholders

Tags:

  1. Create tag types

  2. Create tags

Stakeholders and defined by:

  • Email

  • Name

  • Job function

  • Stakeholder groups

4.4.1. Creating a new stakeholder group

There are no default stakeholder groups defined. You can create a new stakeholder group by following the procedure below.

Procedure

  1. In Developer view, click Controls.

  2. Click Stakeholder groups.

  3. Click Create new.

  4. Enter the following information:

    • Name

    • Description

    • Member(s)

  5. Click Create.

4.4.2. Creating a new job function

Migration Toolkit for Applications (MTA) uses the job function attribute to classify stakeholders and provides a list of default values that can be expanded.

You can create a new job function, which is not in the default list, by following the procedure below.

Procedure

  1. In Developer view, click Controls.

  2. Click Job functions.

  3. Click Create new.

  4. Enter a job function title in the Name text box.

  5. Click Create.

4.4.3. Creating a new stakeholder

You can create a new migration project stakeholder by following the procedure below.

Procedure

  1. In Developer view, click Controls.

  2. Click Stakeholders.

  3. Click Create new.

  4. Enter the following information:

    • Email

    • Name

    • Job function - custom functions can be created

    • Stakeholder group

  5. Click Create.

4.4.4. Creating a new business service

Migration Toolkit for Applications (MTA) uses the business service attribute to specify the departments within the organization that use the application and that are affected by the migration.

You can create a new business service by following the procedure below.

Procedure

  1. In Developer view, click Controls.

  2. Click Business services.

  3. Click Create new.

  4. Enter the following information:

    • Name

    • Description

    • Owner

  5. Click Create.

4.4.5. Creating new tag types

Migration Toolkit for Applications (MTA) uses tags in multiple categories and provides a list of default values. You can create a new tag type by following the procedure below.

Procedure

  1. In Developer view, click Controls.

  2. Click Tags.

  3. Click Create tag type.

  4. Enter the following information:

    • Name

    • Rank - the order in which the tags appear on the applications

    • Color

  5. Click Create.

Creating new tags

You can create a new tag, which is not in the default list, by following the procedure below.

Procedure

  1. In Developer view, click Controls.

  2. Click Tags.

  3. Click Create tag.

  4. Enter the following information:

    • Name

    • Tag type

  5. Click Create.

5. Assessing and analyzing applications

You can use the Migration Toolkit for Applications (MTA) User Interface to both assess and to analyze applications.

Assessing applications refers to estimating the risks and costs involved in preparing applications for containerization, including time, personnel, and other factors. The results of an assessment can be used as the basis for discussions between stakeholders to determine which applications are good candidates for containerization, which require significant work, and which are not suitable for containerization.

Analyzing applications refers to using rules to determine which specific lines in an application must be modified before the application can be migrated or modernized.

5.1. Assessing applications

You can use the Migration Toolkit for Applications (MTA) User Interface to determine the risks involved in containerizing an application.

Procedure

  1. In Development 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 Developers view.

  5. Click Next.

  6. Answer each question and then click Next.

  7. Click Save and Review to view the assessment.

5.2. Applying assessments to other applications

Many applications are similar enough to each other that you might want to apply a completed assessment of one application to another application. This can save time and provide consistent answers to assessment questions for similar applications.

Procedure

  1. In Development view, click Application inventory.

  2. Select the application with the completed assessment to copy.

  3. Click the Options menu kebab at the right of the selected application.

  4. Select Copy assessment or Copy assessment and review.

  5. Select the application(s) to which you want to apply the completed assessment.

  6. Click Copy.

5.3. Configuring and running an application analysis

You can analyze more than one application at a time against more than one transformation target in the same analysis.

Procedure

  1. In Development 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, set Custom rules by typing a name or by searching and clicking Add Rules.

  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.

      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

      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.

5.4. Reviewing an analysis report

An MTA analysis report contains a variety of sections, including a listing of the technologies used by the application, the dependencies of the application, and the lines of code that must be changed to successfully migrate or modernize the application.

For more information on the contents of an MTA analysis report, see the Reviewing the reports

Procedure

  1. In Development view, click Application inventory.

  2. Expand the application with a completed analysis.

  3. Click Report.

  4. Click the dependencies or source links.

  5. Click the tabs to review the report.

6. Working with Applications

You can use the Migration Toolkit for Applications (MTA) User Interface to do the following:

  • Add applications

  • Assign application credentials

  • Import a list of applications

  • Download a CSV template for importing application lists

6.1. Application attributes

You can add applications to the Migration Toolkit for Applications (MTA) User Interface manually or by importing a list of applications.

MTA User Interface applications have the following attributes:

  • Name (Free text)

  • Description (Optional; free text)

  • Business service (Optional; chosen from a list)

  • Tags (Optional; chosen from a list)

  • Source code (Path entered by user)

  • Binary (Path entered by user)

6.2. Adding applications

You can add an application to the Application Inventory for assessment and analysis.

Tip

Before creating an application, it is helpful to set up business services, check tags and tag types, and create additions as needed.
Procedure

  1. In Developer 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)

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

6.3. Assigning application credentials

You can assign credentials to one or more applications.

Procedure

  1. In Developer view, click Application inventory.

  2. Click the Analysis tab.

  3. Click the Options menu kebab 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.

6.4. Importing a list of applications

You can import a .csv file containing a list of applications and their attributes to the Migration Toolkit for Applications (MTA) User Interface.

Note

Importing a list of applications only adds applications, it does not overwrite any existing ones.
Procedure

  1. Review the import file to ensure it contains all the required information in the required format.

  2. In Developer view, click Application Inventory.

  3. Click the Options menu kebab 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.

6.5. Downloading a CSV template for importing application lists

You can download a CSV template for importing application lists.

Procedure

  1. In Developer view, click Application inventory.

  2. Click the Options menu kebab to the right of Review.

  3. Click Manage imports to open the Application imports page.

  4. Click the Options menu kebab to the right of Import and then click Download CSV template.





Revised on 2023-01-25 09:16:56 UTC