Skip to content

MTA-6607 Download and configure custom analyzer RPC binary #311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Pkylas007 wants to merge 5 commits into
base: main
Choose a base branch
from
Open

MTA-6607 Download and configure custom analyzer RPC binary #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
16c6b90
MTA-6607 Download and configure custom analyzer RPC binary
Feb 13, 2026
69eb666
Added Developer Preview admonition for C#, Go, Javascipt, and extensi…
Mar 13, 2026
d5dba8a
Modified lower case to upper case
Mar 13, 2026
d6dfe20
Removed outdated languages from the analysis chapter
Mar 13, 2026
ca8c3e8
Merge branch 'main' into mta-6607-analyzer-rpc-download-fallback
Pkylas007 Mar 13, 2026
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
6 changes: 3 additions & 3 deletions docs/topics/templates/document-attributes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ ifdef::mta[]
:WebNameTitle: User Interface
:WebNameURL: user_interface_guide
:WebConsoleBookName: {WebNameTitle} Guide
:ProductVersion: 8.0.1
:ProductVersion: 8.1.0
:PluginName: MTA plugin
:mta-dl-full: Red Hat Developer Lightspeed for migration toolkit for applications
:mta-dl-plugin: Red Hat Developer Lightspeed for MTA
:mta-URL: https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/{DocInfoProductNumber}/html-single

:ProductDistributionVersion: 8.0.1.GA-redhat
:ProductDistribution: mta-8.0.1.GA-cli-offline.zip
:ProductDistributionVersion: 8.1.0.GA-redhat
:ProductDistribution: mta-8.1.0.GA-cli-offline.zip
:DevDownloadPageURL: https://developers.redhat.com/products/mta/download
:JiraWindupURL: https://issues.redhat.com/projects/MTA/issues
// OpenShift
Expand Down
36 changes: 36 additions & 0 deletions docs/topics/vscode/proc_installing-analyzer-binary-locally.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
:_mod-docs-content-type: PROCEDURE
[id="installing-analyzer-rpc_{context}"]
= Configuring and using the {ProductShortName} analyzer RPC binary in your system

[role="_abstract"]
The {ProductFullName} Visual Studio Code extension consists of an analyzer RPC binary that runs an analysis.

When you install the {ProductShortName} Visual Studio Code extension, the extension downloads the analyzer RPC binary of the latest version from the Red Hat Developer portal.

In a restricted network environment where the {ProductShortName} extension cannot access the link to download the analyzer RPC binary, you can download the binary in your system and configure its path in the Visual Studio Code extension.

.Prerequisites

* You installed the Java Development Kit (JDK). {ProductShortName} supports the following JDKs:

** Oracle JDK 17 or later
** Eclipse Temurin™ JDK 17 or later
** OpenJDK 17 or later

* You have 8 GB of RAM available.

* For macOS installation, you have the value of `maxproc` set to `2048` or greater.

.Procedure

. Download the {ProductShortName} {ProductVersion} analyzer RPC from link:https://developers.redhat.com/content-gateway/rest/browse/pub/mta/[Red Hat Developer portal] to your system.
. Access the {ProductShortName} extension settings in either of the following ways:
.. Click `Extensions > MTA Extension for VSCode > Settings`.
.. Type `Preferences: Open User Settings (JSON)` in the Command Palette to open the `settings.json` file.
. Configure the analyzer RPC binary path for the extension in one of the following ways:
.. Enter the analyzer RPC binary path in the `Analyzer Path` field in the {ProductShortName} extension settings.
.. Configure the path to the local analyzer RPC binary in the `mta-vscode-extension.analyzerPath` field in the `settings.json` file.
.. Type `{ProductShortName}: Override Analyzer Binary` in the Command Palette to select the analyzer binary in your system.
. Reload the Visual Studio Code window by typing `Developer: Reload Window` in the Command Palette.
. Open the extension analysis view by typing `MTA: Open Analysis View` in the Command Palette.
. Click *Start* to use the analyzer RPC binary to perform an analysis.
25 changes: 23 additions & 2 deletions docs/topics/vscode/proc_installing-vscode-extension.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,27 @@
= Installing the {ProductShortName} extension for Visual Studio Code

[role="_abstract"]
You can use the {ProductFullName} Visual Studio Code plugin to perform a standard application analysis. You can also enable Red Hat Developer Lightspeed for the {ProductName} to use Generative AI (GenAI) capabilities to fix code issues before migrating to target technologies. Note that Developer Lightspeed for {ProductShortName} is enabled by default. For more information, see link:{mta-URL}/configuring_and_using_red_hat_developer_lightspeed_for_mta/index[Configuring and using Developer Lightspeed for {ProductShortName}].
You can use the {ProductFullName} Visual Studio Code plugin to perform a standard application analysis.

You can download the {ProductShortName} plugin version 8.1.0 as an extension pack that bundles the Core extension along with all the supported language-specific extensions. You can use this extension even when you want to analyze a project in a specific programming language.
Copy link
Collaborator Author

@Pkylas007 Pkylas007 Feb 25, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@djzager Could you review the MTA VS Code extension description, please?

Copy link

@djzager djzager Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.


Alternatively, you can also download the {ProductShortName} `Core` extension and one language-specific extension to analyze a project coded in the programming language supported by the extension.

The following language-specific {ProductShortName} Visual Studio Code extensions are available in the Visual Studio Code Marketplace:

* `Java`
* `Javascript` to analyze `javascript` and `node.js` applications
* `C#` to analyze `C#` and `.NET` applications
* `Go`

:FeatureName: `Extension pack`, `C#`, `Javascript`, and `Go` extensions

Copy link
Collaborator Author

@Pkylas007 Pkylas007 Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dymurray Can you please review the developer preview note for the extensions? Many thanks!

[subs="attributes+"]
{FeatureName} are Developer Preview features only. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to upcoming product features in advance of their possible inclusion in a Red Hat product offering, enabling customers to test functionality and provide feedback during the development process. These features might not have any documentation, are subject to change or removal at any time, and testing is limited. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.

:!FeatureName:

You can also enable Red Hat Developer Lightspeed for the {ProductName} to use Generative AI (GenAI) capabilities to fix code issues before migrating to target technologies. Note that Developer Lightspeed for {ProductShortName} is enabled by default. For more information, see link:{mta-URL}/configuring_and_using_red_hat_developer_lightspeed_for_mta/index[Configuring and using Developer Lightspeed for {ProductShortName}].

.Prerequisites

Expand All @@ -19,4 +39,5 @@

.Procedure

* Install the {ProductShortName} {ProductVersion} Visual Studio Code plugin from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit&target=VSCode&category=All%20categories&sortBy=Relevance[Visual Studio Code marketplace].
* Install the {ProductShortName} {ProductVersion} Visual Studio (VS) Code plugin extension pack from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit%20for%20application&target=VSCode&category=All%20categories&sortBy=Relevance[VS Code marketplace].

Check failure on line 42 in docs/topics/vscode/proc_installing-vscode-extension.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsErrors] Use 'versus' or 'compared to' rather than 'VS'.

Raw Output:
{"message": "[RedHat.TermsErrors] Use 'versus' or 'compared to' rather than 'VS'.", "location": {"path": "docs/topics/vscode/proc_installing-vscode-extension.adoc", "range": {"start": {"line": 42, "column": 66}}}, "severity": "ERROR"}
* Alternatively, install the {ProductShortName} 8.1.0 Core plugin along with the {ProductShortName} extension for a supported language from the link:https://marketplace.visualstudio.com/search?term=migration%20toolkit%20for%20application&target=VSCode&category=All%20categories&sortBy=Relevance[VS Code marketplace]
2 changes: 2 additions & 0 deletions docs/vs-code-extension-guide/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ include::topics/vscode/con_intro-to-vscode-for-mta.adoc[leveloffset=+1]

include::topics/vscode/proc_installing-vscode-extension.adoc[leveloffset=+1]

include::topics/vscode/proc_installing-analyzer-binary-locally.adoc[leveloffset=+1]

include::topics/vscode/proc_configuring-lighstspeed-ide-settings.adoc[leveloffset=+1]

include::topics/vscode/proc_configuring-profile-settings.adoc[leveloffset=+1]
Expand Down
Loading