Skip to content

Commit c019c9b

Browse files
author
Prabha Kylasamiyer Sundara Rajan
committed
Created procedures for initial kai configuration
1 parent 0de6fce commit c019c9b

File tree

9 files changed

+176
-0
lines changed

9 files changed

+176
-0
lines changed

‎assemblies/developer-lightspeed-guide/assembly_configuring-dev-lightspeed-ide.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2025-04-08
3+
4+
ifdef::context[:parent-context-of-configuring-dev-lightspeed-ide: {context}]
5+
6+
:_mod-docs-content-type: ASSEMBLY
7+
8+
ifndef::context[]
9+
[id="configuring-dev-lightspeed-ide"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="configuring-dev-lightspeed-ide_{context}"]
13+
endif::[]
14+
= Using {ProductShortName} with Developer Lightspeed in IDE
15+
16+
17+
:context: configuring-dev-lightspeed-ide
18+
19+
You must configure the following settings in {mta-dl-plugin}:
20+
21+
* Visual Studio Code IDE settings for all analysis.
22+
* Profile settings that provide context for a particular analysis.
23+
24+
include::topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc[leveloffset=+1]
25+
26+
include::topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc[leveloffset=+1]
27+
28+
29+
ifdef::parent-context-of-configuring-dev-lightspeed-ide[:context: {parent-context-of-configuring-dev-lightspeed-ide}]
30+
ifndef::parent-context-of-configuring-dev-lightspeed-ide[:!context:]
31+

‎assemblies/developer-lightspeed-guide/topics

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../topics/

‎docs/developer-lightspeed-guide/assemblies

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../assemblies/

‎docs/developer-lightspeed-guide/master-docinfo.xml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<title>Developer Lightspeed Guide</title>
2+
<productname>{DocInfoProductName}</productname>
3+
<productnumber>{DocInfoProductNumber}</productnumber>
4+
<subtitle>Using the {ProductName} Developer Lightspeed to modernize your applications</subtitle>
5+
<abstract>
6+
<para>you can use {ProductFullName} Developer Lightspeed for application modernization in your organization by running Artificial Intelligence-driven static code analysis for Java applications.</para>
7+
</abstract>
8+
<authorgroup>
9+
<orgname>Red Hat Customer Content Services</orgname>
10+
</authorgroup>
11+
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

‎docs/developer-lightspeed-guide/master.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:mta:
2+
include::topics/templates/document-attributes.adoc[]
3+
:_mod-docs-content-type: ASSEMBLY
4+
[id="mta-developer-lightspeed"]
5+
= MTA Developer Lightspeed
6+
7+
:toc:
8+
:toclevels: 4
9+
:numbered:
10+
:imagesdir: topics/images
11+
:context: mta-developer-lightspeed
12+
:mta-developer-lightspeed:
13+
14+
//Inclusive language statement
15+
include::topics/making-open-source-more-inclusive.adoc[]
16+
17+
18+
:!mta-developer-lightspeed:

‎docs/developer-lightspeed-guide/topics

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/home/pkylasam/Documents/repos/mta-documentation/docs/topics

‎docs/topics/developer-lightspeed/proc_configuring-developer-lightspeed-ide-settings.adoc

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2025-02-26
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="configuring-developer-lightspeed-ide-settings_{context}"]
6+
= Configuring the {mta-dl-plugin} IDE settings
7+
8+
After you install the {ProductShortName} extension in Visual Studio (VS) Code, you must provide your large language model (LLM) credentials to activate {mta-dl-plugin} settings in Visual Studio (VS) Code.
9+
10+
{mta-dl-plugin} settings are applied to all AI-assisted analysis that you perform by using the {ProductShortName} extension. The extension settings can be broadly categorized into debugging and logging, {mta-dl-plugin} settings, analysis related settings, and solution server settings.
11+
12+
.Prerequisites
13+
14+
* You installed the {ProductFullName} extension version 8.0.0 in VS Code.
15+
//need to check how the user provides LLM credentials and write a new proc if needed
16+
* You provided LLM credentials to enable generative AI for the {ProductShortName} extension in `settings.json` file.
17+
* You installed the {ProductShortName} distribution version 8.0.0 in your system.
18+
* You installed the latest version of Language Support for Java(TM) by Red Hat extension in VS Code.
19+
* You installed Jave 17+ and Maven 3.9.9+ in your system.
20+
21+
.Procedure
22+
23+
. Go to the {mta-dl-plugin} settings in one of the following ways:
24+
+
25+
.. Click `Extensions > MTA CLI Extension for VSCode > Settings`
26+
+
27+
.. Type `Ctrl + Shift + P` on the search bar to open the Command Palette and enter `Preferences: Open Settings (UI)`. Go to `Extensions > MTA` to open the settings page.
28+
+
29+
. Configure the settings described in the following table:
30+
31+
.{mta-dl-plugin} settings
32+
[cols="40%,60%a",options="header",]
33+
|====
34+
|Settings |Description
35+
|Log level|Set the log level for the {ProductShortName} binary. The default log level is `debug`. The log level increases or decreases the verbosity of logs.
36+
|RPC Server Path|Displays the path to the solution server binary. If you do not modify the path, {mta-dl-plugin} uses the bundled binary.
37+
|Analyzer path|Specify a {ProductShortName} custom binary path. If you do not provide a path, {mta-dl-plugin} uses the default path to the binary.
38+
|Solution Server:URL|Configure the URL of the Solution Server end point. This field comes with the default URL.
39+
|Solution Server:enabled|Enable the Solution Server client ({ProductShortName} extension) to connect with the Solution Server to perform analysis.
40+
|Analyze on save|Enable this setting for {mta-dl-plugin} to run an analysis on a file that is saved after code modification. This setting is enabled automatically when you enable Agentic AI mode.
41+
|Agent mode|Enable the experimental Agentic AI flow for analysis. {mta-dl-plugin} runs an automated analysis of a file to identify issues and suggest resolutions. After you accept the solutions, {mta-dl-plugin} makes the changes in the code and re-analyzes the file.
42+
|Super agent mode|
43+
|Diff editor type|Select from diff or merge view to review the suggested solutions after running an analysis. The diff view shows the old code and a copy of the code with changes side-by-side. The merge view overlays the changes in the code in a single view.
44+
|Excluded diagnostic sources|Add diagnostic sources in the `settings.json` file. The issues generated by such diagnostic sources are excluded from the automated Agentic AI analysis.
45+
|Get solution max effort|Select the effort level for generating solutions. This can be adjusted depending on the type of incidents. Higher values increase processing time.
46+
|Get solution max LLM queries|Specify the maximum number of LLM queries made per solution request.
47+
|Get solution max priority|Specify the maximum priority level of issues to be considered in a solution request.
48+
//need more info
49+
|Cache directory|Specify the path to a directory in your filesystem to store cached responses from the LLM.
50+
|Demo mode|Enable to run {mta-dl-plugin} in demo mode that uses the LLM responses saved in the `cache` directory for analysis.
51+
|Trace enabled|Enable to trace {ProductShortName} communication with the LLM model. Traces are stored in the `/.vscode/konveyor-logs/traces` path in your IDE project.
52+
|Debug:Webview|Enable debug level logging for Webview message handling in VS Code.
53+
|Analyze dependencies|Enable {mta-dl-plugin} to analyze dependency-related errors detected by the LLM in your project.
54+
|Analyze known libraries|Enable {mta-dl-plugin} to analyze well-known open-source libraries in your code.
55+
|Code snip limit|Set the maximum number of lines of code that are included in incident reports.
56+
|Context lines|Configure the number of context lines included in incident reports. The greater the number, the more the LLM accuracy.
57+
|Incident limit|Specifies the maximum number of incidents to be reported. If you enter a higher value, it increases the coverage of incidents in your report.
58+
|====
59+

‎docs/topics/developer-lightspeed/proc_configuring-developer-profile-settings.adoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2025-02-26
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="configuring-developer-lightspeed-profile-settings_{context}"]
6+
= Configuring the {mta-dl-plugin} profile settings
7+
8+
To run an analysis using {mta-dl-plugin}, you must configure a profile that contains all the necessary configurations for an analysis, such as source and target technologies and API key to connect with your chosen large language model (LLM).
9+
10+
.Prerequisites
11+
12+
* You installed the {ProductShortName} extension version 8.0.0 in Visual Studio (VS) Code.
13+
//need to check how the user provides LLM credentials and write a new proc if needed
14+
* You provided LLM credentials to enable generative AI for the {ProductShortName} extension in `settings.json` file.
15+
* You installed the {ProductShortName} distribution version 8.0.0 in your system.
16+
* You installed the latest version of Language Support for Java(TM) by Red Hat extension in VS Code.
17+
//check if users still need Java 17+ in their system since Language Support extension is already a req.
18+
* You installed Jave 17+ and Maven 3.9.9+ in your system.
19+
* You opened a Java project in your VS Code workspace.
20+
21+
.Procedure
22+
23+
. Open the `Konveyor View Analysis` page in either of the following ways:
24+
+
25+
.. Click the screen icon on the `Konveyor Issues` pane of the {ProductShortName} extension.
26+
.. Type `Ctrl + Shift + P` on the search bar to open the Command Palette and enter `Konveyor:Open Konveyor Analysis View`.
27+
+
28+
. Click the settings button on the `Konveyor View Analysis` page to configure a profile for your project.
29+
The `Get Ready to Analyze` pane lists the follwoing basic configurations required for an analysis:
30+
+
31+
32+
.Verification
33+
34+
After you complete the profile configuration, close the `Get Ready to Analyze` pane. You can verify that your configuration works by running an analysis. See run an analysis.
35+
36+
.{mta-dl-plugin} profile settings
37+
[cols="20%,80%a",options="header",]
38+
|====
39+
|Profile settings |Description
40+
|Select profile|Create a profile that you can reuse for multiple analyses. The profile name is part of the context provided to the LLM for analysis.
41+
|Configure label selector|A label selector filters rules for analysis based on the source or target technology.
42+
43+
Specify one or more target or source technologies (for example, cloud-readiness). {mta-dl-plugin} uses this configuration to determine the rules that are applied to a project during analysis.
44+
45+
If you mentioned a new target or a source technology in your custom rule, you can type that name to create and add the new item to the list.
46+
47+
[NOTE]
48+
====
49+
You must configure either target or source tehcnologies before running an analysis.
50+
====
51+
|Set rules|Enable default rules and Select your custom rule that you want {mta-dl-plugin} to use for an analysis. You can use the custom rules in addition to the default rules.
52+
|Configure generative AI|This option opens the `provider-settings.yaml` file that contains API keys and other parameters for all supported LLMs. By default, {mta-dl-plugin} is configured to use OpenAI LLM. To change the model, update the anchor `&active` to the desired block. Modify this file with the required arguments, such as the model and API key, to complete the setup.
53+
|====

‎docs/topics/templates/document-attributes.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ ifdef::mta[]
2828
:WebConsoleBookName: {WebNameTitle} Guide
2929
:ProductVersion: 7.3.1
3030
:PluginName: MTA plugin
31+
:mta-dl-plugin: MTA with Developer Lightspeed
3132
// :MavenProductVersion: 7.0.0.GA-redhat-00001
3233
:ProductDistributionVersion: 7.3.1.GA-redhat
3334
:ProductDistribution: mta-7.3.1.GA-cli-offline.zip

0 commit comments

Comments
 (0)