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
19 changes: 10 additions & 9 deletions assemblies/cli-guide/assembly_analyzing-applications-mta-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,20 @@ endif::[]
[role="_abstract"]
To assess and prioritize migration and modernization efforts for applications written in different languages, analyze your applications by using the {ProductFullName} {CLINameTitle}.

{ProductShortName} CLI supports running source code and binary analysis by using `analyzer-lsp`. `analyzer-lsp` is a tool that evaluates rules by using language providers.

Depending on your scenario, you can use the {ProductShortName} CLI to perform the following actions:

* Run the analysis against a single application.
* Run the analysis against multiple applications:
** In {ProductShortName} versions earlier than 7.1.0, you can enter a series of `--analyze` commands, each against an application and each generating a separate report. For more information, see xref:analyzing-single-app-wth-mta-cli_analyzing-applications-mta-cli[Running the {ProductShortName} {CLINameTitle} against an application].
** In {ProductShortName} version 7.1.0 and later, you can use the `--bulk` option to analyze multiple applications at once and generate a single report. Note that this feature is a Developer Preview feature only. For more information, see xref:analyzing-multiple-apps-with-mta-cli_analyzing-applications-mta-cli[Analyzing multiple applications].
* Run the analysis against multiple applications in either of the following ways:
** Enter a series of `--analyze` commands, each against an application and each generating a separate report.
** Use the `--bulk` option to analyze multiple applications at once and generate a single report. Note that this feature is a Developer Preview feature only.
Comment thread
mpershina marked this conversation as resolved.

[IMPORTANT]
====
Comment thread
mpershina marked this conversation as resolved.
Starting from {ProductShortName} version 7.2.0, you can run the application analysis for Java applications in the containerless mode. Note that this option is set by default and is used automatically only if all requirements are met. For more information, see xref:running-the-containerless-mta-cli_analyzing-applications-mta-cli[Analyzing an application in the containerless mode].

However, if you want to analyze applications in languages other than Java or, for example, use xref:performing-transformation_cli-guide[transformation commands], you still need to use containers.
====
* Run the analysis for Java applications in the containerless mode. Note that this option is set by default and is used automatically only if all requirements are met.
+
However, if you want to analyze applications in languages other than Java or, for example, use transformation commands, you still need to use containers.

////
[NOTE]
====
The analysis output in the disconnected environment usually results in fewer incidents because a dependency analysis does not run accurately without access to Maven.
Expand All @@ -47,6 +47,7 @@ include::topics/mta-cli/proc_running-the-containerless-mta-cli.adoc[leveloffset=

include::topics/mta-cli/ref_mta-cli-analyze-flags.adoc[leveloffset=+1]


ifdef::parent-context-of-analyzing-applications-mta-cli[:context: {parent-context-of-analyzing-applications-mta-cli}]
ifndef::parent-context-of-analyzing-applications-mta-cli[:!context:]

Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,16 @@ You can perform the analysis in either of the following ways:
* Overwrite the existing supported language provider with your own unsupported language provider, and then run the analysis on it.


IMPORTANT: Analyzing applications written in languages other than Java is only possible in container mode. You can use the containerless CLI only for Java applications. For more information, see xref:running-the-containerless-mta-cli_analyzing-applications-mta-cli[Analyzing an application in containerless mode].
IMPORTANT: Analyzing applications written in languages other than Java is only possible in container mode. You can use the containerless CLI only for Java applications.


include::topics/mta-cli/proc_analyze-selected-provider.adoc[leveloffset=+1]

include::topics/mta-cli/proc_analyze-unsupported-provider.adoc[leveloffset=+1]

[role="_additional-resources"]
== Additional resources
* xref:running-the-containerless-mta-cli_analyzing-applications-mta-cli[Analyzing an application in containerless mode]

ifdef::parent-context-of-analyzing-multi-language-applications[:context: {parent-context-of-analyzing-multi-language-applications}]
ifndef::parent-context-of-analyzing-multi-language-applications[:!context:]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ endif::[]
:context: red-hat-build-of-keycloak

[role="_abstract"]
Starting from version 7.3.0, the {ProductFullName} uses a link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0[Red Hat build of Keycloak (RHBK)] instance for user authentication and authorization. A RHBK instance is installed during the installation of the {ProductShortName} user interface. The {ProductShortName} Operator manages the RHBK instance and configures a dedicated realm with necessary roles and permissions.
The {ProductFullName} uses a Red Hat build of Keycloak (RHBK) instance for user authentication and authorization. A RHBK instance is installed during the installation of the {ProductShortName} user interface. The {ProductShortName} Operator manages the RHBK instance and configures a dedicated realm with necessary roles and permissions.

You can use the {ProductShortName}-managed RHBK instance to perform advanced RHBK configurations, such as link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/server_administration_guide/user-storage-federation#adding_a_provider[adding a provider for User Federation] or link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/server_administration_guide/identity_broker[integrating identity providers].
You can use the {ProductShortName}-managed RHBK instance to perform advanced RHBK configurations, such as adding a provider for User Federation or integrating identity providers.

include::topics/mta-install/proc_accessing-rhbk-admin-console.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ To use multiple rule files, you can either:
* Place the rule files in a directory and add a ruleset.yaml file. {ProductShortName} treats the directory as a ruleset, and you can pass the directory path as input to the `--rules` option.
* Specify multiple rules files by using the `--rules` option when you run an analysis.

Note that if you want to use the `--target` or `--source` option in the CLI, the engine will only select rules that match the label for that target. Therefore, make sure that you have added target or source labels on your rules. See xref:reserved-label_rule-yaml-metadata[Reserved labels] for more details.
Comment thread
mpershina marked this conversation as resolved.

include::topics/rules-development/yaml-rulesets.adoc[leveloffset=+1]

ifdef::parent-context-of-rule-rulesets[:context: {parent-context-of-rule-rulesets}]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ You can use rule actions to generate information about the source code. The rule

Rules can include the following types of actions:

* `Message`: use message action to display an informative message in the static report that contains the violation triggered by the rule. See xref:yaml-message-actions_rule-yaml-actions[Message action] for more information.
* `Tag`: use tags to categorize parts of the source code. For example, Backend=Java, where Backend is the key and Java is the value. See xref:yaml-tag-actions_rule-yaml-actions[Tag actions] for more information.
* `Message`: use message action to display an informative message in the static report that contains the violation triggered by the rule.
* `Tag`: use tags to categorize parts of the source code. For example, Backend=Java, where Backend is the key and Java is the value.

Each rule includes either one of them or both of them.

include::topics/rules-development/yaml-tag-actions.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,7 @@ Currently, {ProductShortName} supports the following providers:
You can use the generic provider binary to create an external provider for any language that is compliant with link:https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/[LSP 3.17 specifications].
====

== Using the provider capability in custom rules
Comment thread
mpershina marked this conversation as resolved.

In a rule, the when block is where the conditions for matching the rule are specified. Each provider offers a series of capabilities to do matching. The search query in the rule condition can contain patterns, code locations, specific dependencies to be found, and so on, to evaluate the source code and dependencies. The provider sends the LSP server a request to check the search query against the application being analyzed. When the LSP server returns a match for the search in the source code, the analyzer triggers a violation.

The `when` block has one condition, but that condition can have multiple conditions nested under it.

----
when:
<condition>
<nested-condition>
----
include::topics/rules-development/con_provider-capability-in-custom-rules.adoc[leveloffset=+1]

include::topics/rules-development/yaml-provider-conditions.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ endif::[]
[role="_abstract"]
This guide is intended for software engineers who want to create custom YAML-based rules for {ProductName} ({ProductShortName}) tools.

See the link:{ProductDocIntroToMTAGuideURL}[_{IntroToMTABookName}_] for an overview and the link:{ProductDocUserGuideURL}[_{UserCLIBookName}_] for details.

include::topics/rules-development/about-rules.adoc[leveloffset=+1]

include::topics/rules-development/yaml-rule-structure-syntax.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ endif::[]
:context: assessment-questionnaires

[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.
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 the default questionnaire or a 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 @@ -40,11 +40,6 @@ include::topics/mta-ui/proc_configuring-proxy-settings.adoc[leveloffset=+1]
include::topics/mta-ui/proc_creating-custom-migration-targets.adoc[leveloffset=+1]


== Next steps

* xref:configuring-mta-instance_user-interface-guide[Configure a {ProductName} instance].


ifdef::parent-context-of-configuring-mta-instance-environment[:context: {parent-context-of-configuring-mta-instance-environment}]
ifndef::parent-context-of-configuring-mta-instance-environment[:!context:]

4 changes: 2 additions & 2 deletions assemblies/ui-guide/assembly_tagging-applications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ endif::[]
:context: tagging-applications

[role="_abstract"]
To classify applications and instantly identify application information, for example, an application type, data center location, and technologies used within the application, attach tags to applications in the {ProductFullName} user interface (UI). You can also use tagging to associate xref:working-with-archetypes_user-interface-guide[archetypes] to applications for automatic assessment.
To classify applications and instantly identify application information, for example, an application type, data center location, and technologies used within the application, attach tags to applications in the {ProductFullName} user interface (UI). You can also use tagging to associate archetypes to applications for automatic assessment.

You can either set an xref:automatic-tagging-of-an-application_tagging-applications[automated] tagging or tag applications xref:manual-tagging-of-an-application_tagging-applications[manually].
You can either use automated tagging or tag applications manually.

NOTE: Not all tags can be assigned automatically. For example, an analysis can only tag the application based on its technologies. If you want to tag the application also with the location of the data center where it is deployed, you need to tag the application manually.

Expand Down
11 changes: 0 additions & 11 deletions docs/topics/about-home-var.adoc

This file was deleted.

39 changes: 0 additions & 39 deletions docs/topics/available-openrewrite-recipes.adoc

This file was deleted.

Loading
Loading