Skip to content

MTA-6288 Centralized configuration through LLM proxy#324

Open
Pkylas007 wants to merge 2 commits intomainfrom
mta-6288-llm-proxy
Open

MTA-6288 Centralized configuration through LLM proxy#324
Pkylas007 wants to merge 2 commits intomainfrom
mta-6288-llm-proxy

Conversation

@Pkylas007
Copy link
Copy Markdown
Collaborator

@Pkylas007 Pkylas007 commented Mar 2, 2026

JIRA

Version

  • 8.1.0

Preview

What Changed

Restructured the following section to introduce sub section for readability:

Summary by CodeRabbit

  • Documentation
    • Expanded Developer Lightspeed docs with explicit Solution Server, Agent mode, and LLM proxy workflows and step-by-step setup.
    • Added a how-to for enabling an LLM proxy and surfaced LLM-proxy setup and secret guidance in Getting Started; removed a now-redundant secret reference elsewhere.
    • Clarified restart guidance and Agent AI behavior (iteration/previews, approval phrasing) and expanded context description and solved-example guidance.
    • Updated Podman Desktop/LLM provider configuration examples.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 2, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds an AsciiDoc procedure to enable the LLM proxy in the Tackle CR and inserts it into the Getting Started assembly; expands Developer Lightspeed docs with explicit Solution Server, Agent mode, and LLM proxy workflows; updates introductory context guidance and Podman Desktop provider example.

Changes

Cohort / File(s) Summary
LLM proxy procedure & Getting Started
docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc, docs/topics/developer-lightspeed/assembly_getting-started.adoc
Adds a new procedure showing how to enable kai_llm_proxy_enabled in the Tackle CR (YAML snippet, vi/oc apply commands) and inserts it into the Getting Started assembly via include directives.
Pathways / workflow guide
docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc
Reworks the Pathways doc: shortens abstract, removes explicit plugin coupling, adds Solution Server, Agent mode, and LLM proxy workflows with step-by-step configuration and restart guidance.
Introductory concepts & flows
docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc
Expands context description sections, revises wording for request/agent flows, standardizes manual review phrasing, documents agentic AI iteration/preview behavior, and adds demo-mode commentary.
Podman Desktop provider config
docs/topics/developer-lightspeed/proc_configuring-llm-podman-desktop.adoc
Adds OPENAI_API_BASE export example, a podman_mistral provider YAML snippet (env/model), a NOTE about OPENAI_API_KEY irrelevance for this setup, and fixes indentation.
Solution Server assembly adjustment
docs/topics/developer-lightspeed/assembly_solution-server-configurations.adoc
Removes an include for proc_tackle-llm-secret.adoc from the Solution Server configurations assembly and tightens adjacent content.

Sequence Diagram(s)

mermaid
sequenceDiagram
participant Admin as Admin (operator)
participant CLI as CLI (oc/kubectl)
participant Tackle as Tackle CR
participant Proxy as LLM Proxy
participant Provider as LLM Provider

Admin->>CLI: oc login / oc edit tackle_hub.yaml
CLI->>Tackle: set kai_llm_proxy_enabled: true
Admin->>CLI: oc apply -f tackle_hub.yaml
CLI->>Tackle: update applied
Tackle->>Proxy: enable proxy configuration
Proxy->>Provider: forward/auth requests
Provider-->>Proxy: respond
Proxy-->>Tackle: proxy ready

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Suggested reviewers

  • mpershina

Poem

🐰 I hopped through pages, tidy and spry,

A proxy snugged in, beneath the sky,
Workflows aligned like carrots in row,
Context and configs ready to go—
Hop on, let's sprint where the doc carrots grow! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'MTA-6288 Centralized configuration through LLM proxy' directly reflects the main change—introducing LLM proxy centralized configuration to the documentation, which is evident from the addition of new files (proc_tackle-enable-llm-proxy.adoc) and workflow restructuring.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mta-6288-llm-proxy

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc`:
- Around line 14-15: The sentence "You can complete one of the following
workflow depending on if you want to use the Solution Server or the Agent AI."
is awkward; update it in the document to read "You can complete one of the
following workflows depending on whether you want to use the Solution Server or
Agent AI." — change "workflow" to "workflows" and "depending on if" to
"depending on whether" in the paragraph containing that sentence.

In `@docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc`:
- Line 54: Update the sentence "The Solution Server acts as an institutional
memory that stores changes to source codes after analyzing applications in your
organization." by replacing the phrase "source codes" with "source code" so it
reads "stores changes to source code"; locate this exact sentence in the
document (the sentence beginning "The Solution Server acts as an institutional
memory...") and make the single-word plural-to-collective change.
- Around line 64-65: The bullet "Works with the LLM to generate fix suggestions.
The LLM displays the reasoning transcript and files to be changed." is missing a
list marker; update the document so that this line begins with the same list
marker as the surrounding items (add a leading "*" and match indentation) so it
renders as a list item in the agentic workflow list.

In `@docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc`:
- Around line 26-53: The procedure mixes live-edit and file-based flows (uses
"oc edit tackle" but later runs "oc apply -f tackle_hub.yaml" and references
both tackle_hub.yml and tackle_hub.yaml) — choose one flow and make filenames
consistent: either keep the live-edit flow (use "oc edit tackle mta" in
namespace openshift-mta and remove the "oc apply" step and any mention of
tackle_hub.yaml), or convert to a file-based flow by exporting the resource with
"oc get tackle mta -o yaml > tackle_hub.yaml", edit the exported tackle_hub.yaml
to set spec.kai_llm_proxy_enabled: true (ensure key is exactly
kai_llm_proxy_enabled), and then apply with "oc apply -f tackle_hub.yaml"; also
normalize the filename to tackle_hub.yaml everywhere.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6565201 and 1778e86.

📒 Files selected for processing (5)
  • docs/topics/developer-lightspeed/assembly_getting-started.adoc
  • docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc
  • docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc
  • docs/topics/developer-lightspeed/proc_configuring-llm-podman-desktop.adoc
  • docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc (1)

41-47: ⚠️ Potential issue | 🟡 Minor

Tighten grammar for subject-verb agreement in the context section.

On Line 41 and Line 47, singular verbs are used with plural subjects, which hurts readability.

Suggested fix
-More instances of solved examples for an issue enhances the context and improve the success metrics of rules that trigger the issue. A higher success metrics of an issue refers to the higher confidence level associated with the accepted resolutions for that issue in previous analyses.
+More instances of solved examples for an issue enhance the context and improve the success metrics of rules that trigger the issue. Higher success metrics for an issue refer to a higher confidence level associated with the accepted resolutions for that issue in previous analyses.
...
-This cyclical improvement of resolution pattern from the Solution Server and improved migration hints lead to more reliable code changes as you migrate applications in different migration waves.
+This cyclical improvement of resolution patterns from the Solution Server and improved migration hints leads to more reliable code changes as you migrate applications in different migration waves.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc`
around lines 41 - 47, Fix subject-verb agreement in the added sentences: change
"This cyclical improvement of resolution pattern from the Solution Server and
improved migration hints lead to more reliable code changes..." to use the
singular verb ("leads") so it reads "...leads to more reliable code changes,"
and verify any other occurrences in the nearby sentences (e.g., the sentence
beginning "The improvement in the quality of migration hints..." and the
sentence starting "Accurate code resolutions from the LLM...") maintain correct
singular/plural agreement.
♻️ Duplicate comments (3)
docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc (1)

14-14: ⚠️ Potential issue | 🟡 Minor

Fix awkward grammar in workflow selection sentence.

The phrase "one of the following workflows depending on if" is grammatically awkward. Change "depending on if" to "depending on whether."

✏️ Proposed fix
-The configuration that you complete to use {mta-dl-plugin} depends on how you prefer to request code resolutions. You can complete one of the following workflows depending on if you want to use the Solution Server or the Agent AI. 
+The configuration that you complete to use {mta-dl-plugin} depends on how you prefer to request code resolutions. You can complete one of the following workflows depending on whether you want to use the Solution Server or Agent AI.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc` at
line 14, Replace the awkward phrase in the sentence that begins "The
configuration that you complete to use {mta-dl-plugin}..." — specifically change
"one of the following workflows depending on if you want to use the Solution
Server or the Agent AI." to use "depending on whether" (i.e., "one of the
following workflows depending on whether you want to use the Solution Server or
the Agent AI.") so the sentence reads grammatically correct.
docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc (2)

26-31: ⚠️ Potential issue | 🔴 Critical

Critical: Procedure contains incorrect command that doesn't match the described workflow.

Line 26 states "Create the Tackle CR in the tackle_hub.yaml file" but line 30 shows vi tackle (without the .yaml extension). This mismatch makes the procedure impossible to follow correctly, as users will edit a file named tackle but later try to apply tackle_hub.yaml (line 54).

Additionally, the procedure doesn't explain how to obtain the existing Tackle CR before editing. You need to export it first.

📝 Recommended fix: Use consistent file-based workflow
-. Create the Tackle CR in the `tackle_hub.yaml` file with the following command:
+. Export the existing Tackle CR to a local file:
 +
 [source, terminal]
 ----
-vi tackle
+oc get tackle mta -n openshift-mta -o yaml > tackle_hub.yaml
 ----
++
+. Edit the exported `tackle_hub.yaml` file:
++
+[source, terminal]
+----
+vi tackle_hub.yaml
+----
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc` around
lines 26 - 31, The procedure is inconsistent: it references creating/editing the
Tackle CR in "tackle_hub.yaml" but shows the edit command "vi tackle" and omits
exporting the existing CR; update the steps to consistently use the same
filename (tackle_hub.yaml) and add the export command to fetch the existing
Tackle CR before editing (e.g., use kubectl get <TackleCRKind> <name> -o yaml >
tackle_hub.yaml), then edit tackle_hub.yaml with your editor (replace "vi
tackle" with "vi tackle_hub.yaml") and ensure subsequent steps (like apply)
reference tackle_hub.yaml and not a different filename so Tackle CR export, edit
(tackle_hub.yaml), and apply are consistent.

50-50: ⚠️ Potential issue | 🟡 Minor

Fix grammatical error.

"Apply the Tackle CR by in the openshift-mta project" contains a grammatical error with "by in."

✏️ Proposed fix
-. Apply the Tackle CR by in the `openshift-mta` project using the following command.
+. Apply the updated Tackle CR in the `openshift-mta` project using the following command:
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc` at line
50, The sentence "Apply the Tackle CR by in the `openshift-mta` project using
the following command." has an extra "by"; remove it and change the sentence to
"Apply the Tackle CR in the `openshift-mta` project using the following
command." so the line in
docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc reads
correctly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc`:
- Line 12: The xref target "tackle-enable-llm-proxy_getting-started" in
con_developer-lightspeed-pathways.adoc is resolving incorrectly because the
assembly inclusion doesn't set the context to "getting-started"; either change
the xref to the actual resolved ID "tackle-enable-llm-proxy_" or ensure the
include/assembly sets the context variable to "getting-started" when pulling in
assembly_getting-started.adoc (or update master.adoc to provide the parent
context), so update the xref target or the assembly context accordingly to match
the real ID.

In `@docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc`:
- Line 63: The attribute token {nta-dl-plugin} on the sentence mentioning the
sub agent is likely a typo and should match the rest of the file; replace
{nta-dl-plugin} with the correct attribute {mta-dl-plugin} so the reference
resolves consistently (search for occurrences of {mta-dl-plugin} and update the
instance in the sentence "Chooses a suitable sub agent..." to use that same
attribute).

---

Outside diff comments:
In `@docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc`:
- Around line 41-47: Fix subject-verb agreement in the added sentences: change
"This cyclical improvement of resolution pattern from the Solution Server and
improved migration hints lead to more reliable code changes..." to use the
singular verb ("leads") so it reads "...leads to more reliable code changes,"
and verify any other occurrences in the nearby sentences (e.g., the sentence
beginning "The improvement in the quality of migration hints..." and the
sentence starting "Accurate code resolutions from the LLM...") maintain correct
singular/plural agreement.

---

Duplicate comments:
In `@docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc`:
- Line 14: Replace the awkward phrase in the sentence that begins "The
configuration that you complete to use {mta-dl-plugin}..." — specifically change
"one of the following workflows depending on if you want to use the Solution
Server or the Agent AI." to use "depending on whether" (i.e., "one of the
following workflows depending on whether you want to use the Solution Server or
the Agent AI.") so the sentence reads grammatically correct.

In `@docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc`:
- Around line 26-31: The procedure is inconsistent: it references
creating/editing the Tackle CR in "tackle_hub.yaml" but shows the edit command
"vi tackle" and omits exporting the existing CR; update the steps to
consistently use the same filename (tackle_hub.yaml) and add the export command
to fetch the existing Tackle CR before editing (e.g., use kubectl get
<TackleCRKind> <name> -o yaml > tackle_hub.yaml), then edit tackle_hub.yaml with
your editor (replace "vi tackle" with "vi tackle_hub.yaml") and ensure
subsequent steps (like apply) reference tackle_hub.yaml and not a different
filename so Tackle CR export, edit (tackle_hub.yaml), and apply are consistent.
- Line 50: The sentence "Apply the Tackle CR by in the `openshift-mta` project
using the following command." has an extra "by"; remove it and change the
sentence to "Apply the Tackle CR in the `openshift-mta` project using the
following command." so the line in
docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc reads
correctly.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1778e86 and 522c1e1.

📒 Files selected for processing (3)
  • docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc
  • docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc
  • docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc`:
- Line 29: The doc uses inconsistent casing for the product name: replace the
lowercase occurrences of "solution server" with the proper capitalized term
"Solution Server" (specifically the instances shown in the diff where "solution
server" appears) to match the rest of the document; search for the literal
string "solution server" in con_developer-lightspeed-pathways.adoc and update
each to "Solution Server" so all references are consistent.

In `@docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc`:
- Around line 63-64: The sentence "The LLM displays the reasoning transcript and
files to be changed" is misleading; update the text to attribute display
responsibilities to the extension/agent UI rather than the model. Edit the
bullet containing "{mta-dl-plugin}" and the line with "The LLM displays the
reasoning transcript and files to be changed" to say that the agent/extension
(or {mta-dl-plugin}) presents the reasoning transcript and proposed file changes
in the UI while the LLM generates suggestions, ensuring the distinction between
the model (LLM) and the UI/agent is clear.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 89958ccd-98ba-4911-8952-c51056301b72

📥 Commits

Reviewing files that changed from the base of the PR and between 522c1e1 and c8152f2.

📒 Files selected for processing (5)
  • docs/topics/developer-lightspeed/assembly_getting-started.adoc
  • docs/topics/developer-lightspeed/assembly_solution-server-configurations.adoc
  • docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc
  • docs/topics/developer-lightspeed/con_intro-to-developer-lightspeed.adoc
  • docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc
💤 Files with no reviewable changes (1)
  • docs/topics/developer-lightspeed/assembly_solution-server-configurations.adoc
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/topics/developer-lightspeed/assembly_getting-started.adoc
  • docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

♻️ Duplicate comments (1)
docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc (1)

27-29: ⚠️ Potential issue | 🟡 Minor

Use consistent product-term capitalization for “Solution Server.”

Line 27, Line 29, and Line 67 still use lowercase “solution server,” while the rest of the page uses “Solution Server.” Please standardize all occurrences to the same casing.

Suggested doc fix
-== Workflow to use the solution server
+== Workflow to use the Solution Server

-Solution server is an optional component. As a migrator, complete the following workflow to use the Solution Server for code resolutions:
+The Solution Server is an optional component. As a migrator, complete the following workflow to use the Solution Server for code resolutions:

-NOTE: If you want to use the Solution Server, you must also enable solution server in the Tackle CR.
+NOTE: If you want to use the Solution Server, you must also enable the Solution Server in the Tackle CR.

Also applies to: 67-67

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc`
around lines 27 - 29, The document uses inconsistent casing for the product term
“Solution Server” (e.g., the header text "Workflow to use the solution server"
and occurrences of the phrase "solution server" at/around the lines noted);
update all occurrences of the lowercase phrase "solution server" to the
standardized "Solution Server" throughout the document (including the header and
the instances called out around lines 27, 29, and 67) so the term is capitalized
consistently.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc`:
- Around line 27-29: The document uses inconsistent casing for the product term
“Solution Server” (e.g., the header text "Workflow to use the solution server"
and occurrences of the phrase "solution server" at/around the lines noted);
update all occurrences of the lowercase phrase "solution server" to the
standardized "Solution Server" throughout the document (including the header and
the instances called out around lines 27, 29, and 67) so the term is capitalized
consistently.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: acd0158d-affe-4f7e-b51c-920f53e2b4c6

📥 Commits

Reviewing files that changed from the base of the PR and between c8152f2 and 5a78067.

📒 Files selected for processing (2)
  • docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc
  • docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/topics/developer-lightspeed/proc_tackle-enable-llm-proxy.adoc

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

♻️ Duplicate comments (1)
docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc (1)

27-29: ⚠️ Potential issue | 🟡 Minor

Keep “Solution Server” capitalization consistent.

Line 27/29 and Line 67 still mix casing (“solution server” vs “Solution Server”). Please standardize on Solution Server throughout this module.

Also applies to: 67-67

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc`
around lines 27 - 29, The document mixes casing for the term "Solution Server";
standardize all occurrences to "Solution Server" (capital S on both words).
Locate uses of "solution server" and replace them with "Solution Server" in this
file, including the heading "Workflow to use the solution server" and the
instance around line 67, and scan the rest of
con_developer-lightspeed-pathways.adoc to ensure every mention of the component
uses the exact "Solution Server" capitalization consistently.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc`:
- Line 22: The document uses inconsistent terminology: "Agent AI" on line with
the phrase “Whether you want to use Retrieval Augmented Generation (RAG) or
Agent AI” and "agent mode" in the later block (lines 44–47). Pick one canonical
term (e.g., "Agent mode" or "Agent AI") and replace all occurrences so they
match across the file—update the phrase in the RAG/Agent line and the
description in the block that currently reads "agent mode" to the chosen term so
the wording is consistent.
- Line 57: The sentence starting "The LLM proxy service authenticates the
{ProductShortName} Visual Studio Code extension (clients) by using the Hub
credentials..." is long and contains an extra space before "for more
information."; split it into two sentences for clarity (one describing how the
LLM proxy authenticates clients and a second describing the proxy's separate
authentication to access the LLM via an admin-controlled endpoint) and remove
the stray space before the xref:tackle-enable-llm-proxy_getting-started[Enabling
LLM proxy in the Tackle custom resource] reference so the final text reads as
two concise sentences with correct spacing.

---

Duplicate comments:
In `@docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc`:
- Around line 27-29: The document mixes casing for the term "Solution Server";
standardize all occurrences to "Solution Server" (capital S on both words).
Locate uses of "solution server" and replace them with "Solution Server" in this
file, including the heading "Workflow to use the solution server" and the
instance around line 67, and scan the rest of
con_developer-lightspeed-pathways.adoc to ensure every mention of the component
uses the exact "Solution Server" capitalization consistently.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4d1899ed-3a9a-4d0a-a0e7-19984943fc12

📥 Commits

Reviewing files that changed from the base of the PR and between 5a78067 and 97dc069.

📒 Files selected for processing (1)
  • docs/topics/developer-lightspeed/con_developer-lightspeed-pathways.adoc

@Pkylas007 Pkylas007 requested a review from djzager March 4, 2026 11:17
@Pkylas007
Copy link
Copy Markdown
Collaborator Author

@fabianvf Could you review the documentation for LLM proxy, please?

@Pkylas007 Pkylas007 force-pushed the mta-6288-llm-proxy branch from 22d7ccf to fd70c4a Compare March 10, 2026 07:58

* Enable the generative AI option in the {ProductShortName} extension settings.

* Add the Solution Server configuration in the `settings.json` file.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The solution server configuration is now automatically discovered upon connection to the hub, no manual entry is required

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Image

So you configure connection to the hub via the panel in the analysis page. You additionally enable the solution server (or configuration sync) as feature toggles on the same panel.

Copy link
Copy Markdown
Collaborator Author

@Pkylas007 Pkylas007 Mar 20, 2026

Choose a reason for hiding this comment

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

Hi @fabianvf @djzager Thank you! My bad, this is a workflow to use Solution Server when the users do not want to connect with the Hub. I'll update the title to add that detail. If this workflow is possible, will the users be able to enter the Solution Server config in settings.json as they used to in 8.0.0?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

You must configure the hub in order to enable the solution server. It can no longer be configured solo in the settings.json.

A little context, you were always connecting to the hub when using the solution server. We pulled it into the hub configuration because the profile sync is using the same coordinates.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@fabianvf @djzager Got it, thanks :) Please could you take a look at the topic to see if the updates are ok?

+
[NOTE]
====
As a migrator, you can configure Solution Server and LLM provider settings in the {ProductShortName} Visual Studio Code extension only when LLM proxy is not enabled in the {ocp-name} cluster.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@djzager is this true? I think solution server configuration is always pulled from the hub now, and I think the setting to use it is changeable whether or not the llm-proxy is deployed.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

solution server is it's own feature flag in the settings screen. Will see if I can get a screenshot when I get back online tonight.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Image

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Hi @djzager Can you please confirm if the users do not connect the VS Code extension with the Hub, then they can still configure Solution Server in settings.json as they used in 8.0.0?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@fabianvf @djzager May I know if users have any way to configure Solution Server in their local IDE in 8.1? When LLM proxy is not deployed in the cluster.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Yes, if the solution server is deployed in the cluster, you can connect to it by configuring the hub connection. Neither LLM proxy nor solution server are accessible without configuring the hub connection

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I have added details about deploying the proxy, SS, and connecting to the Hub to use the Solution Server. Could you go through the updates, please?

To use the agent mode for code fix suggestions:
As a migrator, complete the following workflow to use the agent mode for code resolutions:

* Create a secret for your LLM key in the Red Hat {ocp-name} cluster.
Copy link
Copy Markdown

@fabianvf fabianvf Mar 19, 2026

Choose a reason for hiding this comment

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

This is something only administrators should need/will be able to do, and the agentic workflow will work with or without the hub connection enabled.

Copy link
Copy Markdown
Collaborator Author

@Pkylas007 Pkylas007 Mar 23, 2026

Choose a reason for hiding this comment

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

Mentioned this as a task that the admin completes, thanks!

* Enable the generative AI and the agent mode in the {ProductShortName} extension settings.

* Configure the profile settings and activate the LLM provider in the `provider-settings.yaml` file. No newline at end of file
* Configure the profile settings and activate the LLM provider in the `provider-settings.yaml` file.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

If they enable the hub connection, they will also be able to use agent mode through the llm-proxy when available

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

So either they'd need to configure their local settings, or they'd need to connect to a hub with a running llm-proxy

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I've corrected the pathway section..Please could you take a look at it again?

Copy link
Copy Markdown

@fabianvf fabianvf left a comment

Choose a reason for hiding this comment

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

Couple comments but everything else looked good

Copy link
Copy Markdown

@djzager djzager left a comment

Choose a reason for hiding this comment

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

A few comments, just me adding context to comments that @fabianvf made, that I forgot to associate with a review :(. Overall though it looks good to me.

@Pkylas007 Pkylas007 requested review from djzager and fabianvf March 23, 2026 14:12
[id="solution-server-workflow_{context}"]
== Workflow to use the solution server without the LLM proxy

As an administrator, you must complete the following workflow to enable migrators to use the Solution Server in the {ProductShortName} extension:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

see previous PRs, use capitalization for role titles consistently

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Got it, fixed it in the current assembly :)


* You deployed an additional RWO volume for the `{mta-dl-plugin}-database` if you want to use {mta-dl-plugin}. See link:{mta-URL}/installing_the_migration_toolkit_for_applications/index#persistent-volume-requirements_installing-mta-ui[Persistent volume requirements] for more information.

* You installed the {ProductShortName} Operator v8.0.0.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

please check which version of the operator as 8.0.0 seems a bit weird

Copy link
Copy Markdown
Collaborator Author

@Pkylas007 Pkylas007 Mar 26, 2026

Choose a reason for hiding this comment

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

Aw...yes, fixed it 👍, thanks!

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
@Pkylas007 Pkylas007 force-pushed the mta-6288-llm-proxy branch from 8c3df4b to 05d16f8 Compare March 26, 2026 07:49
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants