Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions assemblies/ui-guide/assembly_asset-generation-ui.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,30 @@ To create different assets (manifests) required to deploy applications from Clou

To generate assets, familiarize yourself with the following entities:

* Archetypes - Archetypes contain one or more criteria tags to identify technologies such as EAP 6. An archetype helps you to classify applications based on technologies common to them. For asset generation, you can plan your migration paths by archetypes because you configure the other asset generation entities in the archetype (for example, target profiles that contain the generators).
Archetypes::
An archetype contains criteria tags that identify technologies, such as JBoss EAP 6.
+
You can use archetypes to classify applications by their common technologies. For asset generation, you plan migration paths by archetype because you configure the other asset generation entities, such as target profiles that contain the generators, directly within the archetype.

* Generators - A generator takes a templating engine, such as Helm, along with a set of templates as input configuration. Generators use the templates that are defined for a target platform and a migration path to generate deployment assets. When you run an asset generation process, the generator parses the application discovery manifest to create deployment assets.
Generators::
A generator uses a templating engine, such as Helm, and a set of templates as its input configuration.
+
For example, the migration path for an EAP 6 application is EAP 8 and the target platform is Kubernetes. A generator can generate the required assets to migrate the EAP 6 application to EAP 8 that is to be deployed on Kubernetes. The assets are generated by parsing the discovery manifest of the EAP 6 application.
When you run an asset generation process, the generator parses the application discovery manifest and uses templates defined for your target platform and migration path to create deployment assets. For example, if you migrate a JBoss EAP 6 application to JBoss EAP 8 on Kubernetes, the generator parses the application's discovery manifest to create the required deployment assets.

* Target profiles - A target profile represents the target platform to which you want to migrate. It contains a sequence of generators. Through target profiles, you can run more than one generator, with each generator creating assets for a specific migration path. Thus, a target profile enables you to generate assets for multiple migration path-target platform combinations at the same time for a given archetype.
Target profiles::
A target profile represents your target migration platform and contains a sequence of generators.
+
For example, if you want to create assets to migrate an EAP 6 application as an OpenJDK 21 application _and_ as an EAP 8 application in {ocp-short} (target platform), you can achieve this through a target profile that has two generators, one for each migration path.
You can use the target profile to run multiple generators simultaneously, where each generator creates assets for a specific migration path. For example, to migrate a JBoss EAP 6 application to both OpenJDK 21 and JBoss EAP 8 on {ocp-short}, you can use a target profile with two generators, one for each migration path.

* Application - The application includes the discovery manifest, tags, and the asset repository.
Applications::
An application includes the discovery manifest, tags, and the asset repository.
+
//provide the retrieve configuration link after publishing the doc
The configuration retrieval process generates a discovery manifest that contains the platform and runtime configurations of an application deployed in the source platform (CF) instances. During asset generation, the discovery manifest is parsed by generator templates that produce the final assets for deployment.
The configuration retrieval process generates a discovery manifest that contains the platform and runtime configurations of an application deployed in the source platform (CF) instances. During asset generation, generator templates parse the discovery manifest to create the final deployment assets.
+
The application also contains tags that you must configure as criteria tags in an Archetype.
The application also contains tags that you must configure as criteria tags in an archetype.
+
The asset repository is where you find the generated assets for deployment in the target platform.

You can reuse generators in different archetypes.
You can find the assets generated for deployment in the target platform in the asset repository.

include::topics/mta-ui/proc_configuring-generators.adoc[leveloffset=+1]

Expand Down
10 changes: 5 additions & 5 deletions assemblies/ui-guide/assembly_configuring-credentials.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@

You can set up the following credential types to configure the {ProductShortName} instance environment:

* Source control
* Maven settings file
* Proxy
* Basic auth (Jira)
* Bearer token (Jira)
* *Source Control*
* *Maven Settings File*
* *Proxy*
* *Basic Auth (Jira)*

Check failure on line 25 in assemblies/ui-guide/assembly_configuring-credentials.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.TermsErrors] Use 'Basic HTTP authentication' or 'Basic authentication' rather than 'Basic Auth'. Raw Output: {"message": "[RedHat.TermsErrors] Use 'Basic HTTP authentication' or 'Basic authentication' rather than 'Basic Auth'.", "location": {"path": "assemblies/ui-guide/assembly_configuring-credentials.adoc", "range": {"start": {"line": 25, "column": 4}}}, "severity": "ERROR"}
* *Bearer Token (Jira)*

include::topics/mta-ui/proc_configuring-source-control-credentials.adoc[leveloffset=+1]

Expand Down
12 changes: 6 additions & 6 deletions assemblies/ui-guide/assembly_configuring-mta-instance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ endif::[]
[role="_abstract"]
To use the {ProductFullName} for migration assessment and analysis, configure an {ProductShortName} instance. By configuring the instance, you ensure that {ProductShortName} considers key parameters during the migration process and generates comprehensive modernization reports.

If you are a project architect, you can configure the instances key parameters before migration. The following parameters define applications, individuals, teams, verticals, or areas within an organization affected or participating in the migration:
If you are a project architect, you can configure the instance's key parameters before migration. 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 categories
* Stakeholders
* Stakeholder groups
* Job functions
* Business services
* Tag categories
* Tags

include::topics/mta-ui/proc_creating-a-stakeholder.adoc[leveloffset=+1]
Expand Down
8 changes: 4 additions & 4 deletions assemblies/ui-guide/assembly_configuring-repositories.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ endif::[]
[role="_abstract"]
To allow the {ProductFullName} access to the data required for the migration tasks, configure source and binary repositories in the user interface (UI).

You can configure the following repository types for the {ProductFullName} instance environment:
You can configure the following repository types for the {ProductFullName} instance environment:

* Git
* Subversion
* Maven
* *Git*
* *Subversion*
* *Maven*

include::topics/mta-ui/proc_configuring-git-repos.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion assemblies/ui-guide/assembly_managing-applications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can use the {ProductShortName} UI to perform the following tasks:
* Add applications
* Assign application credentials
* Import a list of applications
* Download a CSV template for importing application lists
* Download a comma-separated values (CSV) file template for importing application lists
* Create application migration waves
* Create Jira issues for migration waves

Expand Down
8 changes: 4 additions & 4 deletions assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The YAML syntax supports including or excluding questions based on tags existing
questions:
- order: 4
text: Are you currently using any form of container orchestration?
explanation: Determine if the application utilizes container orchestration tools like Kubernetes, Docker Swarm, etc.
explanation: Determine if the application utilizes container orchestration tools such as Kubernetes or Docker Swarm.
excludeFor:
- category: Deployment
tag: Serverless
Expand All @@ -55,7 +55,7 @@ The YAML syntax supports including or excluding questions based on tags existing
----

Automated answers based on tags present on the assessed application or archetype::
Automated answers are selected based on the tags existing on the application or archetype. For example, if an application or archetype has the `Runtime/Quarkus` tag, the `Quarkus` answer is automatically selected, and if an application or archetype has the `Runtime/Spring Boot` tag, the `Spring Boot` answer is automatically selected:
The {ProductShortName} selects automated answers based on the tags that exist on the application or archetype. For example, if an application or archetype has the `Runtime/Quarkus` tag, the {ProductShortName} automatically selects the `Quarkus` answer. Similarly, if an application or archetype has the `Runtime/Spring Boot` tag, the {ProductShortName} automatically selects the `Spring Boot` answer:
+
[source,yaml]
----
Expand All @@ -80,14 +80,14 @@ Automated answers are selected based on the tags existing on the application or


Automatic tagging of applications based on answers::
During the assessment, tags are automatically applied to the application or archetype based on the answer if this answer is selected. Note that the tags are transitive. Therefore, the tags are removed if the assessment is discarded. Each tag is defined by the following elements:
During the assessment, the {ProductShortName} automatically applies tags to the application or archetype based on the answer if this answer is selected. Because these tags are transitive, the {ProductShortName} removes them if you discard the assessment. The following elements define each tag:
+
--
* *category*: Category of the target tag (`String`).
* *tag*: Definition for the target tag as (`String`).
--
+
For example, if the selected answer is `Quarkus`, the `Runtime/Quarkus` tag is applied to the assessed application or archetype. If the selected answer is `Spring Boot`, the `Runtime/Spring Boot` tag is applied to the assessed application or archetype:
For example, if the selected answer is `Quarkus`, the {ProductShortName} applies the `Runtime/Quarkus` tag to the assessed application or archetype. If the selected answer is `Spring Boot`, the {ProductShortName} applies the `Runtime/Spring Boot` tag to the assessed application or archetype:
+
[source,yaml]
----
Expand Down
12 changes: 6 additions & 6 deletions assemblies/ui-guide/assembly_working-with-archetypes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ endif::[]
[role="_abstract"]
To assess multiple applications at once in the {ProductFullName} user interface (UI), use archetypes.

An *archetype* is a group of applications with common characteristics. Application archetypes are defined by criteria tags and the application taxonomy. Each archetype defines how the _assessment module_ assesses the application according to the characteristics defined in that archetype. If the tags of an application match the criteria tags of an archetype, the application is associated with the archetype.
An archetype is a group of applications with common characteristics. Tags and the application taxonomy define application archetypes. Each archetype defines how the assessment module assesses the application based on the archetype's characteristics. If an application's tags match an archetype's criteria tags, the system associates the application with that archetype.

Creation of an archetype is defined by a series of *tags*, *stakeholders*, and *stakeholder groups*. The tags include the following types:
The tags include the following types:

* *Criteria tags* are tags that the archetype requires to include an application as a member.
* Criteria tags: Tags that the archetype requires to include an application as a member.
+
NOTE: An application must have all of the archetype's criteria tags to be a member. For example, if the application _a_ only has tag _a_, but the archetype _a_ criteria tags include tags _a_ AND _b_, the application _a_ will not be a member of the archetype _a_.
NOTE: An application must have all of the archetype's criteria tags to be a member. For example, if the application _a_ only has tag _a_, but the archetype _a_ criteria tags include tags _a_ and _b_, the application _a_ will not be a member of the archetype _a_.

* *Archetype tags* are tags that are applied to the archetype entity.
* Archetype tags: Tags applied to the archetype entity.

NOTE: All applications associated with the archetype inherit the _assessment_ and _review_ from the archetype groups to which these applications belong. This is the default setting. You can override inheritance for the application by completing an individual assessment and review.
NOTE: All applications associated with the archetype inherit the assessment and review from the archetype groups to which these applications belong. This is the default setting. You can override inheritance for the application by completing an individual assessment and review.

include::topics/mta-ui/proc_defining-an-archetype.adoc[leveloffset=+1]

Expand Down
12 changes: 6 additions & 6 deletions docs/topics/mta-ui/con_assessment-module-features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,18 @@
= The Assessment module features

[role="_abstract"]
The assessment module in the {ProductFullName} user interface (UI) uses customizable questionnaires to evaluate the suitability of applications for modernization. Understanding these features allows you to identify migration risks, estimate effort, and prioritize applications within your portfolio.
You can use the assessment module in the {ProductFullName} user interface (UI) to evaluate the suitability of applications for modernization. These evaluations help you identify migration risks, estimate modernization effort, and prioritize applications in your portfolio.

The {ProductFullName} *Assessment* module offers the following features for assessing and analyzing applications:

Assessment hub::
The *Assessment* hub integrates with the *Application inventory*.

Assessment questionnaires::
The *Assessment* module supports assessment questionnaires relevant to one or more applications.

Enhanced assessment questionnaire capabilities::
In {ProductShortName} 7.0, you can import and export assessment questionnaires. You can also design custom questionnaires with a downloadable template by using the YAML syntax, which includes the following features:
You can import and export assessment questionnaires. You can also design custom questionnaires with a downloadable template by using the YAML syntax, which includes the following features:

* Conditional questions: You can include or exclude questions based on the application or archetype if a certain tag is present on this application or archetype.
* Application auto-tagging based on answers: You can define tags to be applied to applications or archetypes if a certain answer was provided.
Expand All @@ -23,11 +26,8 @@ In {ProductShortName} 7.0, you can import and export assessment questionnaires.
+
NOTE: You can customize and save the default questionnaire.

Multiple assessment questionnaires::
The *Assessment* module supports multiple questionnaires, relevant to one or more applications.

Archetypes::
You can group applications with similar characteristics into archetypes. This allows you to assess multiple applications at once. Each archetype has a shared taxonomy of tags, stakeholders, and stakeholder groups. All applications inherit assessment and review from their assigned archetypes.
You can use archetypes to assess a group applications with similar characteristics. Each archetype has a shared taxonomy of tags, stakeholders, and stakeholder groups. All applications inherit assessment and review from their assigned archetypes.


[role="_additional-resources"]
Expand Down
10 changes: 5 additions & 5 deletions docs/topics/mta-ui/con_mta-default-questionnaire.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
= The default assessment questionnaire

[role="_abstract"]
_Legacy Pathfinder_ is the default {ProductFullName} questionnaire. Pathfinder is a questionnaire-based tool that you can use to evaluate the suitability of applications for modernization in containers on an enterprise Kubernetes platform. 
_Legacy Pathfinder_ is the default {ProductFullName} questionnaire. Pathfinder is a questionnaire-based tool that you can use to evaluate the suitability of applications for modernization in containers on an enterprise Kubernetes platform.

Through interaction with the default questionnaire and the review process, the system is enriched with application knowledge exposed through the collection of assessment reports.
By completing the default questionnaire and review process, you enrich the system with application knowledge that assessment reports include.

You can export the default questionnaire to a YAML file:

Expand Down Expand Up @@ -568,7 +568,7 @@ sections:
rationale: ''
mitigation: ''
- order: 2
text: TCP/IP, with host name or IP address encapsulated in the payload
text: TCP/IP, with hostname or IP address encapsulated in the payload
risk: red
rationale: ''
mitigation: ''
Expand Down Expand Up @@ -964,7 +964,7 @@ sections:
- order: 2
text: >-
Configuration files are stored externally (example: in a database)
and accessed using specific environment keys (examples: host name,
and accessed using specific environment keys (examples: hostname,
IP address)
risk: red
rationale: ''
Expand Down Expand Up @@ -1060,7 +1060,7 @@ sections:
rationale: ''
mitigation: ''
- order: 3
text: 'Private cloud (example: red Hat OpenStack Platform)'
text: 'Private cloud (example: Red Hat OpenStack Platform)'
risk: green
rationale: ''
mitigation: ''
Expand Down
Loading
Loading