Skip to content

Commit 1fba562

Browse files
anarnold97anarnold97
committed
Updating
Signed-off-by: Andy Arnold <[email protected]>
1 parent 255e6af commit 1fba562

14 files changed

+535
-14
lines changed

‎docs/topics/mtr-about-console-guide.adoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="about-console-guide_{context}"]
7+
= About the {WebNameTitle}
8+
9+
This guide is for engineers, consultants, and others who want to use the {ProductName} ({ProductShortName}) to migrate or modernize Java applications or other components. It describes how to install and use the {WebName} to manage migration or modernization projects and analyze applications.

‎docs/topics/mtr-configuring-web-console-authentication-for-linux-windows-macos.adoc‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="configuring-web-console-authentication-for-linux-windows-macos_{context}"]
7+
= Configuring authentication for the {WebName} on Linux, Windows, or macOS
8+
9+
You can configure the {WebName} to require authentication for access. To enable authentication, you have to install Red Hat Single Sign-On (SSO).
10+
11+
[discrete]
12+
[id="enabling-authentication_{context}"]
13+
== Enabling authentication
14+
15+
.Procedure
16+
17+
. Adjust the port number that the Red Hat SSO server opens to avoid conflicts with the port that the {WebName} uses by entering the following:
18+
+
19+
** For Linux and macOS:
20+
+
21+
----
22+
$ ./standalone.sh -Djboss.socket.binding.port-offset=<offset_value>
23+
----
24+
** For Windows:
25+
+
26+
----
27+
> ...\bin\standalone.bat -Djboss.socket.binding.port-offset=<offset_value>
28+
----
29+
30+
. Open the Red Hat SSO administration console from `\http://localhost:8180`:
31+
* Username: `admin`
32+
* Password: `admin`
33+
. Add a realm named *windup*.
34+
. In the realm, create a client named *windup-web*.
35+
. Check that *Access Type* is set to `public`.
36+
. Set *Valid Redirect URIs* to `\http://localhost:8080/windup-ui/*`.
37+
. Set *Web Origins* to `+*+` and click *Save*.
38+
. Create a role named *user*.
39+
. Create a user with any name.
40+
. Set the credentials of the user, disable *Temporary*, and assign the role "user" to the user.
41+
. Switch the {WebName} to *Authentication required* mode by doing the following:
42+
.. Export the following ENV variables:
43+
** For Linux and macOS:
44+
+
45+
----
46+
export SSO_AUTH_SERVER_URL=http://localhost:8180/auth
47+
export SSO_REALM=windup
48+
export SSO_SSL_REQUIRED=EXTERNAL
49+
export SSO_CLIENT_ID=windup-web
50+
----
51+
** For Windows:
52+
+
53+
----
54+
set SSO_AUTH_SERVER_URL=http://localhost:8180/auth
55+
set SSO_REALM=windup
56+
set SSO_SSL_REQUIRED=EXTERNAL
57+
set SSO_CLIENT_ID=windup-web
58+
----
59+
+
60+
[NOTE]
61+
====
62+
Environment variables that are set by the `set` command in CMD are local, available to the current CMD session only. Use the Windows Control Panel to permanently set the environment variables.
63+
====
64+
65+
.. Run the following script:
66+
** For Linux and macOS:
67+
+
68+
----
69+
$ <MTR_HOME>/switch_to_authentication_required.sh
70+
----
71+
** For Windows:
72+
+
73+
----
74+
C:\<MTR_HOME>\switch_to_authentication_required.bat
75+
----
76+
. Start the {WebName} by entering the following:
77+
** For Linux and macOS:
78+
+
79+
----
80+
$ <MTR_HOME>/run_windup.sh
81+
----
82+
** For Windows:
83+
+
84+
----
85+
C:\<MTR_HOME>\run_windup.bat
86+
----
87+
. Open the browser at `\http://localhost:8080/windup-ui`.
88+
89+
[discrete]
90+
[id="disabling-authentication_{context}"]
91+
== Disabling authentication
92+
93+
.Procedure
94+
. Run the following script:
95+
** For Linux and macOS:
96+
+
97+
----
98+
$ <MTR_HOME>/switch_to_automatic_authentication.sh
99+
----
100+
** For Windows:
101+
+
102+
----
103+
C:\<MTR_HOME>\switch_to_automatic_authentication.bat
104+
----

‎docs/topics/mtr-installing-web-console-on-openshift.adoc‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="installing-web-console-on-openshift_{context}"]
7+
= Installing the {WebName} on {ocp-short} 4.11 and later
8+
9+
You can install the {WebName} on {ocp-short} 4.11 and later versions with the {ProductName} Operator.
10+
11+
.Prerequisites
12+
13+
* 6 vCPUs, 8 GB RAM, and 40 GB persistent storage.
14+
* One or more projects in which you can install the {WebName}.
15+
+
16+
[IMPORTANT]
17+
====
18+
Do not install the {WebName} in a default project.
19+
====
20+
21+
* `cluster-admin` privileges to install the {DocInfoProductName} Operator.
22+
* `project-admin-user` privileges to install the {WebName} application in a project.
23+
24+
.Configuring Red Hat Single Sign-on (SSO)
25+
26+
You must decide at installation time whether the {WebName} 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.
27+
28+
[NOTE]
29+
====
30+
Authentication can not be added or removed after installation.
31+
====
32+
33+
. Open the Red Hat SSO administration console.
34+
. Add a realm named *windup*.
35+
. In the realm, create a client named *windup-web*.
36+
. Check that *Access Type* is set to `public`. Set *Valid Redirect URIs* and *Web Origins* to `\*`. Click *Save*.
37+
+
38+
Note that after the {ProductShortName} operator has been instantiated, the *Valid Redirect URIs* and *Web Origins* fields have to be set to the secure-mtr-web-console route.
39+
. Create a role named *user*.
40+
. Create a user with any name.
41+
. Set the credentials of the user, disable *Temporary*, and assign the role "user" to the user.
42+
43+
.Installing the {ProductShortName} Operator
44+
45+
. Log in to the OpenShift web console as a user with `cluster-admin` privileges.
46+
. Click *Operators* -> *OperatorHub*.
47+
. Use the *Search by keyword* field to locate the *{DocInfoProductName}* Operator.
48+
. Click *Install*.
49+
. Select a project from the *Installed Namespace* list and click *Install*.
50+
. Click *Operators* -> *Installed Operators* to verify that the Operator is installed.
51+
52+
.Installing the {WebName} application
53+
54+
. Log in to the OpenShift web console as a user with `project-admin-user` privileges.
55+
. Switch to the *Migration* perspective and click *+Add*.
56+
. In the *Add* view, click *Operator Backed*.
57+
. Click the *{DocInfoProductName}* Operator.
58+
. Click *Create*.
59+
. Review the application settings. If the {WebName} requires authentication, input the RH SSO settings and click *Create*.
60+
. In the *Topology* view, click the `mtr-web-console` application and then click the *Resources* tab.
61+
. If authentication is required, set the RH SSO *Valid Redirect URIs* and *Web Origins* fields to the secure-mtr-web-console route.
62+
. Click the `secure-mtr-web-console` route to open the {WebName} in a new browser window.

‎docs/topics/mtr-proc_web-downloading-logs-cli.adoc‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="proc_web-downloading-logs-cli_{context}"]
7+
= Downloading logs using the CLI
8+
[role="_abstract"]
9+
10+
You can download pod logs using the CLI.
11+
12+
.Procedure
13+
14+
. Obtain the pod names:
15+
+
16+
----
17+
$ oc get pods -n <project-name>
18+
----
19+
+
20+
The output resembles the following:
21+
+
22+
[source,terminal,subs="attributes+"]
23+
----
24+
NAME READY STATUS RESTARTS AGE
25+
eap-builder-1-build 0/1 Completed 0 1d
26+
{LC_PSN}-postgresql-1-hfbdn 1/1 Running 0 1d
27+
{LC_PSN}-sso-1-build 0/1 Completed 0 1d
28+
{LC_PSN}-web-console-1-build 0/1 Completed 0 1d
29+
{LC_PSN}-web-console-1-vt7s5 1/1 Running 1 1d
30+
sso-1-wjl2n 1/1 Running 1 1d
31+
----
32+
33+
. Use `oc logs` to examine the pod log:
34+
+
35+
----
36+
$ oc logs <pod>
37+
----
38+
+
39+
[NOTE]
40+
====
41+
You can redirect the output to obtain a copy of the current log:
42+
----
43+
$ oc logs <pod> > ./<pod>.log
44+
----
45+
====

‎docs/topics/mtr-web-adding-global-custom-labels.adoc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="web-adding-global-custom-labels_{context}"]
7+
= Adding global custom labels
8+
9+
{ProductShortName} includes a preconfigured set of global labels, which apply to all projects.
10+
11+
You can define your own custom global labels.
12+
13+
.Procedure
14+
15+
. In the {WebName}, click *Labels configuration*.
16+
. Click *Add label*.
17+
. To upload a labelset file, click the *Upload* tab, click *Browse*, select one or more files, and click *Close*.
18+
+
19+
A labelset file must have a `.windup.label.xml` extension. The uploaded file is stored on the {ProductShortName} server.
20+
+
21+
. To register the server path of a labelset file, click the *Server path* tab, enter the *Labels* path, and click *Save*.
22+
+
23+
Registering the server path ensures that the {ProductShortName} server always uses the latest version of the labelset files.
24+
+
25+
The *Custom labels* list displays the labels.

‎docs/topics/mtr-web-adding-global-custom-rules.adoc‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="web-adding-global-custom-rules_{context}"]
7+
= Adding global custom rules
8+
9+
{ProductShortName} includes a preconfigured set of global rules, which apply to all projects.
10+
11+
You can define your own custom global rules.
12+
13+
For information on writing custom {ProductShortName} rules, see the {ProductShortName} link:{ProductDocRulesGuideURL}[_{RulesDevBookName}_].
14+
15+
.Procedure
16+
17+
. In the {WebName}, click *Rules configuration*.
18+
. Click *Add rules*.
19+
. To upload a ruleset file, click the *Upload* tab, click *Browse*, select one or more files, and click *Close*.
20+
+
21+
A ruleset file must have a `.windup.xml` extension. The uploaded file is stored on the {ProductShortName} server.
22+
+
23+
. To register the server path of a ruleset file, click the *Server path* tab, enter the *Rules* path, and click *Save*.
24+
+
25+
Registering the server path ensures that the {ProductShortName} server always uses the latest version of the ruleset files.
26+
+
27+
The *Custom rules* list displays the rules.

‎docs/topics/mtr-web-create-project.adoc‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="web-create-project_{context}"]
7+
= Creating a project
8+
9+
You can create a project in the {WebName} with the *Create project* wizard.
10+
11+
.Procedure
12+
13+
. In the {WebName}, click *Projects*.
14+
. Click *Create project*.
15+
. Enter a unique name for the project, an optional description, and click *Next*.
16+
+
17+
. To upload applications, click the *Upload* tab, click *Browse*, select the application files you want to upload, and click *Close*.
18+
+
19+
Uploading applications stores them directly on the {ProductShortName} server.
20+
21+
. To register a server path, click the *Server path* tab and enter the *Server-side path* of the application in the field.
22+
+
23+
Registering the server path of an application ensures that {ProductShortName} always uses the latest version.
24+
. Click *Next*.
25+
. Click one or more transformation targets.
26+
+
27+
image::web-console-transformation-targets.png[Transformation targets]
28+
. Click *Next*.
29+
. Select packages and click *>* to include them in the analysis.
30+
. Click *Next*.
31+
+
32+
. If you want to add a custom rule, click *Add rule*.
33+
+
34+
See the link:{ProductDocRulesGuideURL}[{RulesDevBookName}] for more information.
35+
36+
* To upload a ruleset file, click the *Upload* tab, click *Browse*, select one or more files, and click *Close*.
37+
+
38+
A ruleset file must have a `.windup.xml` extension. The uploaded file is stored on the {ProductShortName} server.
39+
+
40+
* To register the server path of a ruleset file, click the *Server path* tab, enter the *Rules* path, and click *Save*.
41+
+
42+
Registering the server path ensures that the {ProductShortName} server always uses the latest version of the ruleset files.
43+
+
44+
. Click *Next*.
45+
+
46+
. If you want to add a custom label, click *Add label*.
47+
* To upload a labelset file, click the *Upload* tab, click *Browse*, select one or more files, and click *Close*.
48+
+
49+
A labelset file must have a `.windup.label.xml` extension. The uploaded file is stored on the {ProductShortName} server.
50+
+
51+
* To register a server path, click the *Server path* tab, enter the *Labels path* of the label files in the field, and click *Save*.
52+
+
53+
Registering the server path ensures that the {ProductShortName} server always uses the latest version of the labelset files.
54+
+
55+
. Click *Next*.
56+
+
57+
. Review the following *Advanced options* and make any necessary changes:
58+
59+
* *Target*
60+
* *Source*
61+
* *Exclude tags*: Rules with these tags are not processed.
62+
* *Additional classpath*: Enter a space-delimited list of additional `.jar` files or directories so that they are available for decompilation or other analysis.
63+
* *Application name*
64+
* *Mavenize group ID*
65+
* *Ignore path*: Enter a path for files to exclude from analysis.
66+
* *Export CSV*: Exports the report data as a CSV file.
67+
* *Export Summary*: Generates an `analysisSummary.json` export file in the output directory. The file contains analysis summary information for each application analyzed, including the number of incidents and story points by category, and all of the technology tags associated with the analyzed applications.
68+
* *Export reports zip*: Creates a `reports.zip` file in the output folder. The file contains the analysis output, typically, the reports. If requested, it can also contain the CSV export files.
69+
* *Disable Tattletale*: Disables generation of a Tattletale report for each application.
70+
* *Class Not Found analysis*: Enables analysis of Java files that are not available on the class path.
71+
+
72+
[NOTE]
73+
====
74+
This option should not be used if some classes are unavailable for analysis.
75+
====
76+
77+
* *Compatible Files report*: Generating a Compatible Files report might take a long time for large applications.
78+
* *Exploded app*: The input directory contains the unpackaged source files of an application.
79+
* *Keep work dirs*: Retains temporary files, for example, the graph database or extracted archive files, for debugging purposes.
80+
* *Skip reports*: HTML reports are not generated. Must be enabled if you enabled *Export CSV*.
81+
* *Allow network access*: Validates any XML files within the analyzed applications against their schema.
82+
+
83+
[NOTE]
84+
====
85+
This option might reduce performance.
86+
====
87+
* *Mavenize*: Creates a Maven project directory structure based on the structure and content of the application.
88+
* *Source mode*: Indicates that the application files are raw source files, not compiled binaries. The sourceMode argument has been deprecated. There is no longer the need to specify it. MTR can intuitively process any inputs that are presented to it. In addition, project source folders can be analyzed with binary inputs within the same analysis execution.
89+
* *Analyze known libraries*: Analyze known software artifacts embedded within your application. By default, {ProductShortName} only analyzes application code.
90+
+
91+
[NOTE]
92+
====
93+
This option might result in a longer execution time and a large number of migration issues being reported.
94+
====
95+
* *Transaction analysis*: [Tech Preview] Generates a Transactions report that displays the call stack, which executes operations on relational database tables. The Enable Transaction Analysis feature supports Spring Data JPA and the traditional `preparedStatement()` method for SQL statement execution. It does not support ORM frameworks, such as Hibernate.
96+
+
97+
[NOTE]
98+
====
99+
Transaction analysis 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
100+
in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
101+
====
102+
* *Skip source code reports:* Adding this option skips generating a _Source code report_ when generating the application analysis report. Use this advanced option when concerned about source code information appearing in the application analysis.
103+
104+
. Click *Next*.
105+
+
106+
. Review your project and click *Save* or *Save and run*.
107+
+
108+
The project is displayed in the *Projects* screen.

0 commit comments

Comments
 (0)