Skip to content

Commit 2e16072

Browse files
author
Prabha Kylasamiyer Sundara Rajan
committed
Modified profile settings
1 parent 6329afa commit 2e16072

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

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

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
[id="configuring-developer-lightspeed-profile-settings_{context}"]
66
= Configuring the {mta-dl-plugin} profile settings
77

8-
Starting from {ProductFullName} 7.2.0, you can perform an application analysis in the containerless mode. Before running the analysis, you must create and configure the `.kantra` directory.
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).
99

1010
.Prerequisites
1111

12-
* You installed the {ProductShortName} extension version 8.0.0 in VS Code.
12+
* You installed the {ProductShortName} extension version 8.0.0 in Visual Studio (VS) Code.
1313
//need to check how the user provides LLM credentials and write a new proc if needed
1414
* You provided LLM credentials to enable generative AI for the {ProductShortName} extension in `settings.json` file.
1515
* You installed the {ProductShortName} distribution version 8.0.0 in your system.
@@ -26,19 +26,28 @@ Starting from {ProductFullName} 7.2.0, you can perform an application analysis i
2626
.. Type `Ctrl + Shift + P` on the search bar to open the Command Palette and enter `Konveyor:Open Konveyor Analysis View`.
2727
+
2828
. Click the settings button on the `Konveyor View Analysis` page to configure a profile for your project.
29-
The `Get Ready to Analyze` pane has the basic configurations required for an analysis. All configurations can be edited on the `Profile Manager` page.
29+
The `Get Ready to Analyze` pane lists the follwoing basic configurations required for an analysis:
3030
+
31-
. Create a profile that you can reuse for multiple analyses. The profile name is part of the context provided to the LLM for analysis.
32-
+
33-
. Configuring analysis arguments such as source or target technologies is necessary to determine which rules apply to the project during analysis. If you want to use a custom rule that specifies a label for a new source or a target technology, you can enter the same label to create the source/target technology for Kai.
34-
+
35-
. User has an option to enable default rules and select custom rules. The Konveyor extension allows you to add custom rules to the analyzer. This is useful when you want to apply your own rules during analysis.
36-
+
37-
. Set up the Generative AI key for your project. This step will open the `provider-settings.yaml` file. By default, Kai is configured to use OpenAI. 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.
38-
+
39-
. Once the profile configuration is done, close the `Get Ready to Analyze` pane, select the profile from the dropdown, and click the start server button.
40-
Logs are collected at output channel named konveyor-analyzer.
4131

4232
.Verification
4333

44-
* Verify that you created and configured the `.kantra` directory correctly by running the application analysis. For more information, see xref:analyzing-projects-with-vs-code-extension_vsc-extension-guide[Analyzing your projects with the MTA extension].
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+
|====

0 commit comments

Comments
 (0)