Chapter 2. Installing the web console
You can install the web console on Linux, Windows, macOS, or Red Hat OpenShift Container Platform.
2.1. Installing the web console on Linux, Windows, or macOS
You can install the web console on Linux, Windows, or macOS operating systems and access the web console in a browser.
The web console has been tested with Chrome and Firefox.
Java Development Kit (JDK) installed. MTR supports the following JDKs:
- OpenJDK 11
- OpenJDK 17
- Oracle JDK 11
- Oracle JDK 17
- Eclipse Temurin™ JDK 11
- Eclipse Temurin™ JDK 17
- 8 GB RAM
macOS installation: the value of
Navigate to the MTR Download page and download the web console
Local install & OpenShiftfile.
.zipfile to a directory of your choice.Note
If you are installing on a Windows operating system:
.zipfile to a folder named
LC_PSNto avoid a
Path too longerror. Alternatively, extract the file with 7-Zip to a folder of any name you choose.
- If a Confirm file replace window is displayed during extraction, click Yes to all.
When you encounter
<MTR_HOME>in this guide, replace it with the actual path to your MTR installation.
- Extract the
- By default, no authentication is required. If you wish to enable authentication, do this before starting the web console.
Start the web console:
Linux or macOS operating system:
Windows operating system:
Open a browser and navigate to
If authentication is not configured, the Projects screen is displayed in your browser.
Figure 2.1. MTR Projects screen
2.2. Installing the web console on OpenShift Container Platform 4.11 and later
You can install the web console on OpenShift Container Platform 4.11 and later versions with the Migration Toolkit for Runtimes Operator.
- 6 vCPUs, 8 GB RAM, and 40 GB persistent storage.
One or more projects in which you can install the web console.Important
Do not install the web console in a default project.
cluster-adminprivileges to install the Migration Toolkit for Runtimes Operator.
project-admin-userprivileges to install the web console application in a project.
Configuring Red Hat Single Sign-on (SSO)
You must decide at installation time whether the web console requires authentication. If it does, you must first install and configure Red Hat SSO and input some RH SSO settings when instantiating the MTR Operator.
Authentication can not be added or removed after installation.
- Open the Red Hat SSO administration console.
- Add a realm named windup.
- In the realm, create a client named windup-web.
Check that Access Type is set to
public. Set Valid Redirect URIs and Web Origins to
*. Click *Save*.
Note that after the MTR operator has been instantiated, the Valid Redirect URIs and Web Origins fields have to be set to the secure-mtr-web-console route.
- Create a role named user.
- Create a user with any name.
- Set the credentials of the user, disable Temporary, and assign the role "user" to the user.
Installing the MTR Operator
Log in to the OpenShift web console as a user with
- Click Operators → OperatorHub.
- Use the Search by keyword field to locate the Migration Toolkit for Runtimes Operator.
- Click Install.
- Select a project from the Installed Namespace list and click Install.
- Click Operators → Installed Operators to verify that the Operator is installed.
Installing the web console application
Log in to the OpenShift web console as a user with
- Switch to the Migration perspective and click +Add.
- In the Add view, click Operator Backed.
- Click the Migration Toolkit for Runtimes Operator.
- Click Create.
- Review the application settings. If the web console requires authentication, input the RH SSO settings and click Create.
In the Topology view, click the
mtr-web-consoleapplication and then click the Resources tab.
- If authentication is required, set the RH SSO Valid Redirect URIs and Web Origins fields to the secure-mtr-web-console route.
secure-mtr-web-consoleroute to open the web console in a new browser window.
2.2.1. Troubleshooting a web console installation on OpenShift
This section describes how to troubleshoot a web console installation on OpenShift Container Platform.
126.96.36.199. Downloading logs using the OpenShift console
You can download pod logs using the OpenShift console.
- Open the OpenShift console and navigate to Applications → Pods.
- Click Logs.
- Click Download to download and save a log.
188.8.131.52. Downloading logs using the CLI
You can download pod logs using the CLI.
Obtain the pod names:
$ oc get pods -n <project-name>
The output resembles the following:
NAME READY STATUS RESTARTS AGE eap-builder-1-build 0/1 Completed 0 1d mtr-postgresql-1-hfbdn 1/1 Running 0 1d mtr-sso-1-build 0/1 Completed 0 1d mtr-web-console-1-build 0/1 Completed 0 1d mtr-web-console-1-vt7s5 1/1 Running 1 1d sso-1-wjl2n 1/1 Running 1 1d
oc logsto examine the pod log:
$ oc logs <pod>Note
You can redirect the output to obtain a copy of the current log:
$ oc logs <pod> > ./<pod>.log
No route to host error
No route to host error in the
mtr-web-console-executor log indicates that the
mtr-web-console-executor pod cannot connect to the
13:44:03,501 SEVERE [org.jboss.windup.web.messaging.executor.ExecutorBootstrap] (main) Could not start messaging listener due to: Failed to connect to any server. Servers tried: [http-remoting://192.0.2.4:8080 (java.net.NoRouteToHostException: No route to host)]: javax.naming.CommunicationException: Failed to connect to any server. Servers tried: [http-remoting://192.0.2.4:8080 (java.net.NoRouteToHostException: No route to host)]
This error occurs because the
mtr-web-console-executor pod starts running before the
mtr-web-console-executor log after the
mtr-web-console pod has been running for a few minutes.
184.108.40.206. Resolving insufficient resources
The following conditions indicate insufficient resources:
mtr-web-consolepod is not running and the following error is displayed on the Events tab of the Pod Details screen in the OpenShift console:
0/9 nodes are available: 4 Insufficient cpu, 4 MatchNodeSelector, 9 Insufficient memory.
mtr-web-console-postgresql-deploypods time out and the following error is displayed in the logs:
error: update acceptor rejected mtr-web-console-executor-1: Pods for rc 'mtr/mtr-web-console-executor-1' took longer than 600 seconds to become available
- Install and run the cluster capacity tool to determine how many pods you can schedule.
Change the load on the cluster resources by performing one of the following actions:
- Redeploy the web console.
220.127.116.11. Reporting issues
MTR uses Jira as its issue tracking system. If you encounter an issue executing MTR, submit a Jira issue.