Chapter 3. Installing the Migration Toolkit for Applications user interface
You can install the Migration Toolkit for Applications (MTA) user interface (UI) on all Red Hat OpenShift cloud services and Red Hat OpenShift self-managed editions.
To create MTA instances, you must first install the MTA Operator. The MTA Operator is a structural layer that manages resources deployed on OpenShift, such as database, front end, and back end, to automatically create an MTA instance.
3.1. Persistent volume requirements Copy linkLink copied to clipboard!
To successfully deploy, the MTA Operator requires two ReadWriteOnce (RWO) persistent volumes (PVs) used by different components. If the rwx_supported
configuration option is set to true
, the MTA Operator requires two additional ReadWriteMany (RWX) PVs that are used by Maven and the hub file storage.
Name | Default size | Access mode | Description |
---|---|---|---|
|
| RWO | Hub database |
|
| RWX |
Hub file storage; required if the |
|
| RWO | Keycloak backend database |
|
| RWX |
Maven m2 cache; required if the |
|
| RWO | Red Hat Developer Lightspeed for MTA database required to run an AI-assisted code resolution. |
3.2. Red Hat Build of Keycloak Copy linkLink copied to clipboard!
Starting from version 7.3.0, MTA uses the Red Hat Build of Keycloak (RHBK) instance for user authentication and authorization. An RHBK instance is installed during the installation of the MTA user interface. The MTA Operator manages the RHBK instance and configures a dedicated realm with necessary roles and permissions.
You can use the MTA-managed RHBK instance to perform advanced RHBK configurations, such as adding a provider for User Federation or integrating identity providers.
3.2.1. Accessing the RHBK Admin Console Copy linkLink copied to clipboard!
To perform advanced configurations to an RHBK instance, you must be logged in to the RHBK Admin Console.
Procedure
Retrieve your admin credentials:
oc get secret mta-keycloak-rhbk -n openshift-mta -o json| jq -r '.data.password | @base64d'
$ oc get secret mta-keycloak-rhbk -n openshift-mta -o json| jq -r '.data.password | @base64d'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The admin credentials for RHBK are stored in the
mta-keycloak-rhbk
secret file in the namespace where you installed MTA.Enter the following URL in your browser:
https://<web_console_address>/auth/admin
https://<web_console_address>/auth/admin
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Access the RHBK Admin Console by entering your credentials.
3.2.2. Roles, personas, users, and permissions Copy linkLink copied to clipboard!
The Migration Toolkit for Applications (MTA) uses three roles, each corresponds to a persona. The roles are already defined in your RHBK instance. You do not need to create them. If you are an MTA administrator, you can create users in your RHBK and assign each user one or more roles, one role per persona.
A user can have more than one role. Each role must correspond to a specific persona:
-
The
tackle-admin
role corresponds to the Administrator persona. The administrator has all the permissions that architects and migrators have, along with the ability to create some application-wide configuration parameters that other users can consume but cannot change or view, for example, Git credentials or Mavensettings.xml
files. -
The
tackle-architect
role corresponds to the Architect persona. An architect is a technical lead for the migration project who can run assessments and can create and modify applications and information related to them. The architect cannot modify or delete sensitive information but can consume it. For example, the architect can associate an existing credential to the repository of a specific application. -
The
tackle-migrator
role corresponds to the Migrator persona. A migrator is a user who can analyze applications but not create, modify, or delete them.
MTA has two views, Administration and Migration. Only administrators can access the Administration view. Architects and migrators have no access to Administration view, they cannot even see it. Administrators can perform all actions supported by Migration view. Architects and migrators can see all elements of Migration view but their ability to perform actions in Migration view depends on the permissions granted to their role.
3.3. Installing the MTA Operator Copy linkLink copied to clipboard!
To create Migration Toolkit for Applications (MTA) instances, you must first install the MTA Operator.
The MTA Operator is a structural layer that manages resources deployed on OpenShift, such as the database, front end, and back end, to automatically create an MTA instance.
Prerequisites
- 4 vCPUs, 8 GB RAM, and 40 GB persistent storage.
- Any cloud services or self-hosted edition of Red Hat OpenShift on versions 4.13-4.15.
- 2 RWO persistent volumes (PVs) used by different components. For more information, see Persistent volume requirements.
-
You are logged in as a user with
cluster-admin
permissions.
Procedure
- In the Red Hat OpenShift web console, click Operators and then click OperatorHub.
- Type MTA in the Filter by keyword field to search for the MTA Operator.
- Click the Migration Toolkit for Applications Operator and then click Install.
- On the Install Operator page, click Install.
Optional: Review and edit the custom resource (CR) settings.
A window for creating CR settings opens automatically after the installation of MTA Operator is complete. The default settings are acceptable. However, make sure to check the system requirements for storage, memory, and cores.
Alternatively, to work directly with the YAML file, click the YAML view and review the CR settings that are listed in the spec section of the YAML file. For more details about commonly used CR settings, see Custom resource settings.
The
spec
section of the YAML file can have the following configuration:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Verify that the MTA pods are running by clicking Workloads and then Pods in the Administration view.
Verification
-
Verify that the MTA Operator appears in the
openshift-mta
project with the status Succeeded by clicking Operators and then Installed Operators.
3.4. Creating an MTA instance Copy linkLink copied to clipboard!
You can use the Migration Toolkit for Applications (MTA) user interface (UI) to assess and analyze your applications to get insights about the adoption process at both the portfolio and application levels as you inventory, assess, analyze, and manage applications for faster migration to Red Hat OpenShift.
To use the MTA UI for assessing and analyzing your applications, you must create a MTA instance first.
Prerequisites
- You installed the MTA Operator on your system. For more information, see Installing the Migration Toolkit for Applications Operator.
- 4 vCPUs, 8 GB RAM, and 40 GB persistent storage.
- Any cloud services or self-hosted edition of Red Hat OpenShift on versions 4.13-4.15.
-
You are logged in as a user with
cluster-admin
permissions.
Procedure
- Click MTA Operator.
- Under Provided APIs, search for Tackle and click Create Instance.
-
Access the user interface from your browser by using the route exposed by the
mta-ui
application within OpenShift. Log in to the user interface instance by using the default credentials:
-
User name:
admin
-
Password:
Passw0rd!
-
User name:
- When prompted, create a new password.
3.5. Custom resource settings Copy linkLink copied to clipboard!
When installing the {ProductrFullName} Operator, you might need to create custom resource (CR) settings. The default settings are acceptable. However, make sure to check the system requirements for storage, memory, and cores.
The following are the most commonly used CR settings that you can find in the spec
section of the YAML file.
CR name | Default size | Description |
---|---|---|
| 100GB |
A size requested for the cache volume. This CR is ignored when the |
| Default storage class |
A storage class used for the cache volume. This CR is ignored when the |
| True |
A flag to indicate whether keycloak authorization is required. When set to |
| True | A flag to indicate whether namespace isolation by using network policies is enabled. |
| 10GB | A size requested for the Hub database volume. |
| 100GB | A size requested for the Hub bucket volume. |
| Default storage class | A storage class used for the bucket volume. |
| 1GB | A size requested for the Keycloak database volume. |
| 1GB | A size requested for the Pathfinder database volume. |
| True | A flag to indicate whether the cluster storage supports RWX mode. |
| NA | A storage class requested for the Tackle RW0 volumes. |
| False | A flag to indicate whether a dedicated route is created to access the MTA managed RHSSO instance. |
| 1 | A maximum number of CPUs the pod is allowed to use. |
| 4GB |
Maximum amount of memory the pod is allowed to use. You can increase this limit if the pod displays |
| 1 | A minimum number of CPUs the pod needs to run. |
| 4GB | Minimum amount of memory the pod needs to run. |