Skip to content
Closed
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
8 changes: 8 additions & 0 deletions .github/styles/MTA/SessionID.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Merge blocker: do not use "SessionID" or "Session ID" in MTA documentation.
extends: existence
message: "Do not use '%s' in documentation. Use the approved term instead."
level: error
ignorecase: true
tokens:
- SessionID
- Session ID
8 changes: 6 additions & 2 deletions assemblies/cli-guide/assembly_generating-assets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You can use the `discover` and `generate` commands in containerless mode to auto
+
The discovery manifest preserves the specifications found in the CF manifest. The specifications define the metadata, runtime, and platform configurations.

* Use the `generate` command to generate the deployment manifest for {ocp} deployments by using the discovery manifest. The deployment manifest is generated by using a templating engine, such as Helm, that converts the discovery manifest into a Kubernetes-native format. You can also use this command to generate non-Kubernetes manifests, such as a Dockerfile or a configuration file.
* Use the `generate` command to generate the deployment manifests for {ocp} deployments by using the discovery manifest. The deployment manifests are generated by using a templating engine, such as Helm, that converts the discovery manifest into a Kubernetes-native format. You can also use this command to generate non-Kubernetes manifests, such as a Dockerfile or a configuration file.

:FeatureName: Generating platform assets for application deployment

Expand All @@ -44,18 +44,22 @@ Generating deployment assets has the following benefits:

* Generating the Kubernetes and non-Kubernetes deployment manifests.
* Generating deployment manifests by using familiar template engines, for example, Helm, that are widely used for Kubernetes deployments.
* Adhering to Kubernetes best practices when preparing the deployment manifest by using Helm templates.
* Adhering to Kubernetes best practices when preparing the deployment manifests by using Helm templates.



include::topics/mta-cli/proc_generating-discovery-manifest.adoc[leveloffset=+1]

include::topics/mta-cli/ref_discovery_manifest_sample.adoc[leveloffset=+1]

include::topics/mta-cli/proc_performing-a-live-discovery.adoc[leveloffset=+1]

include::topics/mta-cli/proc_concealing-sensitive-information.adoc[leveloffset=+1]

include::topics/mta-cli/proc_generating-deployment-manifest.adoc[leveloffset=+1]

include::topics/mta-cli/proc_generate_deployment_assets_values_file.adoc[leveloffset=+1]

include::topics/mta-cli/proc_assets-generation-example.adoc[leveloffset=+1]

include::topics/mta-cli/ref_discover-generate-command-options.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ endif::[]
You can resolve issues by doing one of the following:

* Using a _Quick Fix_ to fix a code snippet that has a hint
* Editing the code of a file that appears in a classification
* Editing the code of a file that is displayed in a classification

include::topics/mta-intellij-plugin/proc_quick-fix.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Additionally, {ProductShortName} provides a built-in provider with abilities suc

Currently, {ProductShortName} supports the following providers:

* Builtin
* builtin
* Java
* Go
* External providers (for `Python`, `Dotnet` and `Node.js` applications) initialized by the generic provider binary
Expand Down
5 changes: 3 additions & 2 deletions assemblies/ui-guide/assembly_analyzing-applications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ endif::[]
ifdef::context[]
[id="analyzing-applications_{context}"]
endif::[]
= Analyzing an application with MTA
= Analyzing applications with {ProductShortName}

:context: analyzing-applications

You can use the {ProductFullName} user interface (UI) to configure and run an application analysis. The analysis determines which specific lines in the application must be modified before the application can be migrated or modernized.
[role="_abstract"]
To identify potential risks and modernization requirements, run an analysis on your applications in the {ProductFullName} user interface (UI).

include::topics/mta-ui/proc_configuring-and-running-an-application-analysis.adoc[leveloffset=+1]

Expand Down
5 changes: 3 additions & 2 deletions assemblies/ui-guide/assembly_assessing-applications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ endif::[]
ifdef::context[]
[id="assessing-applications_{context}"]
endif::[]
= Assessing applications with the MTA
= Assessing applications with {ProductShortName}

:context: assessing-applications

You can use the {ProductFullName} user interface (UI) to assess applications. When assessing applications, {ProductShortName} estimates the risks and costs involved in preparing applications for containerization, including time, personnel, and other factors. You can use the results of an assessment for discussions between stakeholders to determine whether applications are suitable for containerization.
[role="_abstract"]
Estimate the risks and costs involved in preparing applications for containerization, including time, personnel, and other factors, by assessing applications with the {ProductFullName} user interface (UI). You can use the results of an assessment for discussions between stakeholders to determine whether applications are suitable for containerization.


include::topics/mta-ui/con_assessment-module-features.adoc[leveloffset=+1]
Expand Down
5 changes: 2 additions & 3 deletions assemblies/ui-guide/assembly_assessment-questionnaires.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ endif::[]

:context: assessment-questionnaires

The {ProductFullName} uses an assessment questionnaire, either xref:mta-default-questionnaire_assessment-questionnaires[default] or xref:mta-custom-questionnaire_assessment-questionnaires[custom], to assess the risks involved in containerizing an application.

The assessment report provides information about applications and risks associated with migration. The report also generates an adoption plan informed by the prioritization, business criticality, and dependencies of the applications submitted for assessment.
[role="_abstract"]
To determine the readiness of your portfolio for modernization, use assessment questionnaires to provide the {ProductFullName} user interface (UI) with the details required for the migration process. The {ProductFullName} uses either xref:mta-default-questionnaire_assessment-questionnaires[default] or xref:mta-custom-questionnaire_assessment-questionnaires[custom] assessment questionnaire.

include::topics/mta-ui/con_mta-default-questionnaire.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ endif::[]

:context: asset-generation-ui

[role=_abstract]
Starting with 8.0.0, asset generation in {ProductShortName} {WebName} allows you to create different assets (manifests) required to deploy applications from Cloud Foundry (CF) instances to {ocp-full} or Kubernetes.
[role="_abstract"]
To create different assets (manifests) required to deploy applications from Cloud Foundry (CF) instances to {ocp-full} or Kubernetes, use asset generation in {ProductShortName} {WebName}.

To generate assets, you must become familiar with the following entities:
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).

* 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.
+
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.

* Target profiles - A target profile represents the target platform to which you want to migrate. It contains a seqeuence 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 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.
+
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.

Expand All @@ -41,13 +41,13 @@ The asset repository is where you find the generated assets for deployment in th

You can reuse generators in different archetypes.

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

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

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

include::proc_generating-deployment-assets.adoc[leveloffset=+1]
include::topics/mta-ui/proc_generating-deployment-assets.adoc[leveloffset=+1]

ifdef::parent-context-of-generating-assets[:context: {parent-context-of-asset-generation-ui}]
ifndef::parent-context-of-asset-generation-ui[:!context:]
5 changes: 4 additions & 1 deletion assemblies/ui-guide/assembly_configuring-credentials.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ endif::[]

:context: configuring-credentials

You can set up the following credential types to configure the {ProductFullName} instance environment:
[role="_abstract"]
To provide the {ProductFullName} instance environment with secure access to your private source code and repositories, configure credentials in the user interface (UI).

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

* Source control
* Maven settings file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ endif::[]

:context: configuring-mta-instance-environment

You can configure the {ProductFullName} instance environment by setting up the following parameters:
[role="_abstract"]
To adjust migration projects to specific requirements, configure the {ProductFullName} instance environment.

You can configure the {ProductShortName} instance environment by setting up the following parameters:

* General
* Credentials
Expand Down
6 changes: 5 additions & 1 deletion assemblies/ui-guide/assembly_configuring-mta-instance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ endif::[]

:context: configuring-mta-instance

If you are a project architect, you can configure the instance’s key parameters before migration. You can add and edit these parameters as needed. The following parameters define applications, individuals, teams, verticals, or areas within an organization affected or participating in the migration:

[role="_abstract"]
To adjust the {ProductFullName} to your needs, configure a {ProductShortName} instance. By configuring the instance, you ensure {ProductShortName} considers key parameters during the migration process and generates comprehensive modernization reports.

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
Expand Down
3 changes: 3 additions & 0 deletions assemblies/ui-guide/assembly_configuring-repositories.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ endif::[]

:context: configuring-repositories

[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:

* Git
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,27 @@ endif::[]
ifdef::context[]
[id="controlling-tasks-with-task-manager_{context}"]
endif::[]
= Controlling {ProductShortName} tasks by using Task Manager
= Managing {ProductShortName} tasks by using Task Manager

:context: controlling-tasks-with-task-manager

*Task Manager* provides precise information about the {ProductFullName} tasks queued for execution. *Task Manager* handles the following types of tasks:

[role="_abstract"]
To get information about the {ProductFullName} tasks queued for execution, access *Task Manager*.

*Task Manager* handles the following types of tasks:

* Application analysis
* Language discovery
* Technology discovery

You can display task-related information either of the following ways:

* To display active tasks, open the *Task Manager* drawer by clicking the notifications button.
* To display all tasks, open the *Task Manager* page in the *Migration* view.

[WARNING]
====
There are no multi-user access restrictions on resources. For example, an analyzer task created by a user can be canceled by any other user.
Multi-user access restrictions are not enforced on resources. For example, an analyzer task created by a user can be canceled by any other user.
====

include::topics/mta-ui/proc_displaying-mta-tasks.adoc[leveloffset=+1]

include::topics/mta-ui/proc_reviewing-a-task-log.adoc[leveloffset=+1]

include::topics/mta-ui/proc_controlling-task-order-with-task-manager.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ endif::[]

:context: creating-and-configuring-a-jira-connection

You can track application migrations by creating a Jira issue for each migration within the {ProductFullName} user interface (UI).
[role="_abstract"]
To track application migrations, create and configure a Jira issue for each migration within the {ProductFullName} user interface (UI).

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

Expand Down
7 changes: 5 additions & 2 deletions assemblies/ui-guide/assembly_managing-applications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ endif::[]
ifdef::context[]
[id="managing-applications_{context}"]
endif::[]
= Managing applications with {MTA}
= Managing applications with {ProductShortName}

:context: managing-applications

You can use the {ProductFullName} user interface (UI) to perform the following tasks to prepare your applications for the assessment and analysis:
[role="_abstract"]
Configure your portfolio for modernization and migration by preparing your applications for assessment and analysis in the {ProductFullName} user interface (UI).

You can use the {ProductShortName} UI to perform the following tasks:

* Add applications
* Assign application credentials
Expand Down
5 changes: 4 additions & 1 deletion assemblies/ui-guide/assembly_mta-custom-questionnaire.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ endif::[]

:context: mta-custom-questionnaire

You can use the {ProductFullName} to import a custom assessment questionnaire by using a custom YAML syntax to define the questionnaire. The YAML syntax supports the following features:
[role="_abstract"]
To determine the readiness of your portfolio for modernization, use a custom assessment questionnaire to provide the {ProductFullName} user interface (UI) with the details required for the migration process.

You can import the custom assessment questionnaire by using a custom YAML syntax to define the questionnaire. The YAML syntax supports the following features:

Conditional questions::
The YAML syntax supports including or excluding questions based on tags existing on the application or archetype, for example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,19 @@ endif::[]

:context: platform-awareness

Starting with 8.0.0, {ProductShortName} supports platform awareness to import all or selective applications directly from source platform instances.
[role="_abstract"]
To import all or selective applications directly from source platform instances, use platform awareness in {ProductFullName} user interface (UI).

You can associate applications to source platforms in two ways:
You can associate applications with source platforms in the following ways:

* By manually configuring source platforms for applications that are available in {ProductShortName} inventory
* Manually configure source platforms for applications that are available in {ProductShortName} inventory.

* By discovering (importing) applications from a source platform instance.
* Discover (import) applications from a source platform instance.
In this case, the applications are connected with the source platform when they are imported in the {ProductShortName} inventory.

In {ProductShortName} 8.0.0, Red Hat supports Cloud Foundry (CF) as the source platform.

After you import applications, you can retrieve platform and runtime configurations (also known as discovery). Discovery is the process of fetching configurations of the imported applications that are connected to their source platform instances. The retrieval or discovery generates the discovery manifest that contain application configurations.
After you import applications, you can retrieve platform and runtime configurations, also known as discovery. Discovery is the process of fetching configurations of the imported applications that are connected to their source platform instances. The retrieval or discovery generates a discovery manifest that contains application configurations.

You can later use the discovery manifest to generate the final set of assets required to deploy the applications in the target platform.

Expand All @@ -36,15 +37,15 @@ You can perform the following tasks in the {ProductShortName} {WebName}:
. Link an application created in the {ProductShortName} {WebName} to the source platform.
. Fetch the discovery manifest. You can generate the discovery manifests per application or in bulk.

include::proc_creating-source-platform.adoc[leveloffset=+1]
include::topics/mta-ui/proc_creating-source-platform.adoc[leveloffset=+1]

include::proc_discovering-apps-source-platform-administration-view.adoc[leveloffset=+1]
include::topics/mta-ui/proc_discovering-apps-source-platform-administration-view.adoc[leveloffset=+1]

include::proc_discovering-apps-source-platform-migration-view.adoc[leveloffset=+1]
include::topics/mta-ui/proc_discovering-apps-source-platform-migration-view.adoc[leveloffset=+1]

include::proc_adding-source-platform-application.adoc[leveloffset=+1]
include::topics/mta-ui/proc_adding-source-platform-application.adoc[leveloffset=+1]

include::proc_generating-discovery-manifest-web.adoc[leveloffset=+1]
include::topics/mta-ui/proc_generating-discovery-manifest-web.adoc[leveloffset=+1]

ifdef::parent-context-of-platform-awareness[:context: {parent-context-of-platform-awareness}]
ifndef::parent-context-of-platform-awareness[:!context:]
Loading