Skip to content

Commit 2917c03

Browse files
author
Prabha Kylasamiyer Sundara Rajan
committed
MTA-6288 Centralized Configuration for UI
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
1 parent a846fa9 commit 2917c03

File tree

6 files changed

+191
-4
lines changed

6 files changed

+191
-4
lines changed
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
:_newdoc-version: 2.18.5
2+
:_template-generated: 2025-09-12
3+
:_mod-docs-content-type: ASSEMBLY
4+
5+
ifdef::context[:parent-context-of-centralized-configurations: {context}]
6+
7+
ifndef::context[]
8+
[id="centralized-configurations"]
9+
endif::[]
10+
ifdef::context[]
11+
[id="centralized-configurations_{context}"]
12+
endif::[]
13+
= Analyzing an application with centralized profiles
14+
15+
:context: centralized-configurations
16+
17+
[role="_abstract"]
18+
Use standardized configurations across components of {ProductFirstRef} such as the {WebName}, {CLIName}, and the Visual Studio Code {PluginName} by using the centralized configuration management in {ProductFullName}.
19+
20+
As an Architect, you can create, edit, and delete custom migration targets and configurations. For example, analysis profiles and custom rulesets in the {ProductShortName} {WebName}. The analysis profiles contain the following details:
21+
22+
* Analysis configuration
23+
.. Mode of analysis (for example, `source code`)
24+
.. Scope of an analysis (for example, application analysis that includes all dependencies, including known Open Source libraries)
25+
.. Migration targets (default or custom)
26+
* Advanced configuration
27+
.. Custom rules
28+
.. Rule labels to include or exclude rules for an analysis
29+
30+
As a Migrator, can use these profiles to perform an application analysis.
31+
32+
The {ProductShortName} Hub stores and syncs the profile configurations. {ProductShortName} components periodically sync with the Hub and pull the analysis profiles that contain the latest updates to the configuration.
33+
34+
35+
:FeatureName: Analysis Profile
36+
[IMPORTANT]
37+
====
38+
[subs="attributes+"]
39+
{FeatureName} 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.
40+
41+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
42+
====
43+
:!FeatureName:
44+
45+
include::topics/mta-ui/proc_configuring-profile-for-an-application-analysis.adoc[leveloffset=+1]
46+
47+
include::topics/mta-ui/proc_creating-custom-migration-targets.adoc[leveloffset=+1]
48+
49+
include::topics/mta-ui/proc_running-an-analysis-using-profile.adoc[leveloffset=+1]
50+
51+
ifdef::parent-context-of-centralized-configurations[:context: {parent-context-of-centralized-configurations}]
52+
ifndef::parent-context-of-centralized-configurations[:!context:]
53+
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="configuring-profile-application-analysis_{context}"]
7+
= Configuring an analysis profile
8+
9+
10+
[role="_abstract"]
11+
As an architect, you can configure a profile that has the configuration needed to analyze an application for a specific migration target.
12+
13+
.Procedure
14+
15+
. In the *Migration* view, click *Analysis Profiles*.
16+
17+
. Click *Create new* to open the *Create Analysis Profile* window.
18+
19+
. Enter a unique name for the configuration profile in the *Profile Details* page.
20+
21+
. Click *Next* to go to the *Configure analysis* section. You can configure the analysis source, target platforms, and the scope of the dependency analysis.
22+
. Select the *Analysis source* from the list:
23+
* Binary
24+
* Source code
25+
* Source code and dependencies
26+
* Upload a local binary. This option only appears if you are analyzing a single application. If you chose this option, you must *Upload a local binary*. Either drag a file into the area provided or click *Upload* and select the file to upload.
27+
. Click *Next*.
28+
. Select one or more target options in *Set targets* for the analysis:
29+
30+
* Application server migration to either of the following platforms:
31+
** JBoss EAP 7
32+
** JBoss EAP 8
33+
* Containerization
34+
* Quarkus
35+
* OracleJDK to OpenJDK
36+
* OpenJDK. Use this option to upgrade to either of the following JDK versions:
37+
** OpenJDK 11
38+
** OpenJDK 17
39+
** OpenJDK 21
40+
* Linux. Use this option to ensure that there are no Microsoft Windows paths hard-coded into your applications.
41+
* Jakarta EE 9. Use this option to migrate from Java EE 8.
42+
* Spring Boot on Red Hat Runtimes
43+
* Open Liberty
44+
* Camel. Use this option to migrate from Apache Camel 2 to Apache Camel 3 or from Apache Camel 3 to Apache Camel 4.
45+
* Azure App Service
46+
. Click *Next*.
47+
. Select one of the following *Scope* options to better focus the analysis:
48+
49+
* Application and internal dependencies only.
50+
* Application and all dependencies, including known Open Source libraries.
51+
* Select the list of packages that you want to analyze manually. If you choose this option, type the file name and click *Add*.
52+
* Exclude packages. If you toggle this option on, type the name of the package and click *Add*.
53+
54+
. Click *Next*.
55+
. In *Advanced*, you can attach custom rules to the analysis by selecting the *Manual* or *Repository* mode:
56+
** In the *Manual* mode, click *Add Rules*. Drag the relevant files or select the files from their directory and click *Add*.
57+
** In the *Repository* mode, you can add rule files from a *Git* or *Subversion* repository.
58+
+
59+
IMPORTANT: 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.
60+
61+
. Optional: Set any of the following options:
62+
* Additional target labels
63+
* Additional source labels
64+
* Excluded rules labels. Rules with these labels are not processed. Add or delete as needed.
65+
66+
. Click *Next*.
67+
. In *Review*, verify the analysis parameters.
68+
. Click *Save*.
69+
+
70+
{ProductShortName} saves the analysis profile on the *Analysis Profiles* page.

docs/topics/mta-ui/proc_configuring-target-profiles.adoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ The target profile contains one or more generators. Each generator generates ass
1212

1313
You can configure more than one target profile for the archetype based on the target platforms to which you want to migrate applications of the specific archetype.
1414

15-
//what does priority order mean?
1615
The generators are run in a priority order, in which manifests generated by lower priority generators do not override manifests generated by other generators.
1716

1817
.Procedure
@@ -25,7 +24,17 @@ The *Target profiles for <archetype-name>* appears.
2524
. In the *Name* field in the opened dialogue, enter a unique name for the target profile.
2625
. Click the *Tag category* field and select the category tag to associate with the tag.
2726
. Select specific generators and click the right arrow to move the generator from the *Available generators* list to the *Chosen generators* list.
27+
. (Optional) Select an analysis profile for the application from the list. You can download this profile configuration from the {ProductShortName} {CLIName} only if you select the profile from this list.
2828
. Click *Create*.
2929

30+
<<<<<<< HEAD:docs/topics/web-console/proc_configuring-target-profiles.adoc
31+
You can click on the archetype row to open the archetype detail view where the target profiles for the archetype are listed.
32+
33+
[NOTE]
34+
====
35+
If you delete a target profile, {ProductShortName} also automatically deletes the analysis profile associated with the target profile.
36+
====
37+
=======
3038
+
31-
You can click on the archetype row to open the archetype detail view where the target profiles for the archetype are listed.
39+
You can click on the archetype row to open the archetype detail view where the target profiles for the archetype are listed.
40+
>>>>>>> 2a7a567 ([DITA] Vale DITA fixes and short descriptions for the UI title (#289)):docs/topics/mta-ui/proc_configuring-target-profiles.adoc

docs/topics/mta-ui/proc_creating-custom-migration-targets.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ By using ready-made custom migration targets, you can avoid configuring custom r
1919
2020
.Procedure
2121

22-
. In the *Administration* view, click *Custom migration targets*.
22+
. In the *Migration* view, click *Custom migration targets*.
2323
. Click *Create new*.
2424
. Enter the name and description of the target.
2525
. Click the *Provider* drop-down menu and choose the language provider.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * docs/web-console-guide/master.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="profile-application-analysis_{context}"]
7+
= Using a profile to run an application analysis
8+
9+
[role="_abstract"]
10+
As a Migrator, you can use a pre-configured analysis profile to analyze an application for a target platform.
11+
12+
.Procedure
13+
14+
. In the *Migration* view, click *Application inventory*.
15+
. Select an application that you want to analyze.
16+
+
17+
. Review the credentials assigned to the application.
18+
. Click *Analyze*.
19+
. In the *Mode* section, select *Use analysis profile*.
20+
. Select a pre-configured profile from the list for running an analysis.
21+
. Click *Next*
22+
. *Enable automated tagging*. Select the checkbox to automatically attach tags to the application. This checkbox is selected by default.
23+
+
24+
NOTE: {ProductShortName} displays automatically attached tags only _after_ you run the analysis. You can attach tags to the application manually instead of enabling automated tagging or in addition to it.
25+
+
26+
. *Enable enhanced analysis details*.
27+
+
28+
29+
//need more information on the above option.
30+
. Click *Next*.
31+
. In *Review*, verify the analysis parameters.
32+
. Click *Run*.
33+
+
34+
The analysis status is `Scheduled` as {ProductShortName} downloads the image for the container. When {ProductShortName} downloads the image, the status changes to `In-progress.`
35+
+
36+
NOTE: Analysis takes minutes to hours to run depending on the size of the application and the capacity and resources of the cluster.
37+
+
38+
NOTE: {ProductShortName} 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.
39+
40+
. Optional: To track the status of your active analysis task, open the *Task Manager* view by clicking the notifications button.
41+
+
42+
Alternatively, hover over the application name to display the pop-over window.
43+
44+
.Verification
45+
46+
To check the report after the analysis is complete:
47+
48+
. Open the application view by clicking on the application name.
49+
. Click the *Reports* tab to download the results in *HTML* or *YAML*.
50+
+
51+
52+
[NOTE]
53+
====
54+
You can download the report if the {ProductShortName} Administrator has enabled the option to download reports after running an analysis on the *General configuration* page in the *Administration* view.
55+
====

docs/web-console-guide/master.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ include::assemblies/ui-guide/assembly_tagging-applications.adoc[leveloffset=+1]
2626

2727
include::assemblies/ui-guide/assembly_working-with-archetypes.adoc[leveloffset=+1]
2828

29-
//include::topics/mta-web-applying-assessments-to-other-apps.adoc[leveloffset=+3]
29+
include::assemblies/ui-guide/assembly_centralized-configurations-analysis.adoc[leveloffset=+1]
3030

3131
include::assemblies/ui-guide/assembly_analyzing-applications.adoc[leveloffset=+1]
3232

0 commit comments

Comments
 (0)