Skip to content

MCP-OCP-Lightspeed#894

Draft
Jenny-Anne wants to merge 15 commits into
kubev2v:mainfrom
Jenny-Anne:MTV-2749-mcp-ocp-lightspeed
Draft

MCP-OCP-Lightspeed#894
Jenny-Anne wants to merge 15 commits into
kubev2v:mainfrom
Jenny-Anne:MTV-2749-mcp-ocp-lightspeed

Conversation

@Jenny-Anne

@Jenny-Anne Jenny-Anne commented Mar 31, 2026

Copy link
Copy Markdown
Collaborator

https://redhat.atlassian.net/browse/MTV-2749

Previews:

Planning guide chapter on Lightspeed:
Red Hat OpenShift Lightspeed integration with MTV: https://forklift-documentation-git-fork-je-e9e16c-yaacov-8047s-projects.vercel.app/downstream/documentation/doc-Planning_your_migration/master.html#assembly_lightspeed-integration_mtv

Migrating guide troubleshooting topic for Lightspeed:
Using Red Hat OpenShift Lightspeed to troubleshoot migration issues: https://forklift-documentation-git-fork-je-e9e16c-yaacov-8047s-projects.vercel.app/downstream/documentation/doc-Migrating_your_virtual_machines/master.html#proc_using-lightspeed-troubleshooting_mtv

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Lightspeed integration docs: overview, setup, enabling, and verification steps in the migration planning guide.
    • Added a new user-facing procedure for using Lightspeed as an AI-assisted troubleshooting assistant, with example prompts and verification guidance.
    • Expanded migration troubleshooting flow and updated must-gather and diagnostic guidance.
    • Introduced reusable documentation attributes for consistent Lightspeed naming and links to additional resources.

@vercel

vercel Bot commented Mar 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
forklift-documentation Ready Ready Preview, Comment Jun 12, 2026 2:11pm

Comment thread documentation/modules/proc_enabling-lightspeed-mtv-integration.adoc Outdated
Comment thread documentation/modules/proc_enabling-lightspeed-mtv-integration.adoc Outdated
Comment thread documentation/modules/proc_using-lightspeed-troubleshooting.adoc Outdated
Comment thread documentation/modules/proc_using-lightspeed-troubleshooting.adoc Outdated
@Jenny-Anne Jenny-Anne requested a review from mnecas April 1, 2026 14:41
@mnecas

mnecas commented Apr 16, 2026

Copy link
Copy Markdown
Member

@yaacov ptal

@yaacov

yaacov commented Apr 16, 2026

Copy link
Copy Markdown
Member

@Jenny-Anne hi,
adding a short clip to add more context to this doc:

Screencast.From.2026-04-16.20-38-38.mp4

@yaacov

yaacov commented Apr 16, 2026

Copy link
Copy Markdown
Member

note: the user will not need to install anything, it will be installed automatically by our MTV controller in clusters that have Lightspeed installed ** before ** we install MTV (*).

(*) we didn't iron out this yet, we may solve this issue before release, or may not, installing lightspeed is a very complicated task, if we bring an expert that can install lightspeed, they can easily go over the manual install proccess and add the MTV support while they install Lightspeed

@yaacov

yaacov commented Apr 24, 2026

Copy link
Copy Markdown
Member

A clip showing installing the MCP feature:
Not in the movie - removing the feature is done by setting feature_lightspeed_integration to "off"
( users can add and remove the feature by setting the feature flag, the feature flag requires lightspeed already installed and configured on the system, false by default )

Clip ( note that it can take some time for lightspeed to load the new MCP, you can fast forward the clip ):

Screen.Recording.2026-04-24.at.8.34.47.mov

@Jenny-Anne Jenny-Anne force-pushed the MTV-2749-mcp-ocp-lightspeed branch from b1fbe4c to c1f5246 Compare April 27, 2026 14:33
@coderabbitai

coderabbitai Bot commented Apr 27, 2026

Copy link
Copy Markdown

Review Change Stack

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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e7418952-a08c-4e7e-a650-731360ef867c

📥 Commits

Reviewing files that changed from the base of the PR and between c074707 and 5524e4d.

📒 Files selected for processing (3)
  • documentation/modules/con_using-lightspeed-with-mtv.adoc
  • documentation/modules/proc_enabling-lightspeed-integration.adoc
  • documentation/modules/proc_troubleshooting-workflow.adoc
✅ Files skipped from review due to trivial changes (1)
  • documentation/modules/con_using-lightspeed-with-mtv.adoc
🚧 Files skipped from review as they are similar to previous changes (2)
  • documentation/modules/proc_enabling-lightspeed-integration.adoc
  • documentation/modules/proc_troubleshooting-workflow.adoc

📝 Walkthrough

Walkthrough

Adds Red Hat OpenShift Lightspeed docs: product attributes, a planning assembly and master include, a concept module, an enablement procedure, AI-assisted troubleshooting steps, and a new troubleshooting procedure referenced in the migration troubleshooting assembly.

Changes

Lightspeed documentation cohort

Layer / File(s) Summary
AsciiDoc attributes
documentation/modules/common-attributes.adoc, documentation/upstream-attributes.adoc
Adds :lightspeed-full:, :lightspeed-short:, and :lightspeed-operator: attributes for use across docs and upstream templates.
Concepts & integration description
documentation/modules/con_using-lightspeed-with-mtv.adoc
New concept module describing the Lightspeed integration, Technology Preview disclaimers, use cases, RBAC/privacy behavior, enablement overview, and additional resources.
Enablement procedure
documentation/modules/proc_enabling-lightspeed-integration.adoc
New procedure to enable MCP integration by editing ForkliftController (set spec.feature_mcp_server: 'true'), notes pod restarts, optional pod-watch command, and verification via the Lightspeed chat assistant.
Troubleshooting workflow & assembly include
documentation/modules/proc_troubleshooting-workflow.adoc, documentation/doc-Migrating_your_virtual_machines/assemblies/assembly_troubleshooting-migration.adoc
Adds an "Ask Lightspeed" troubleshooting step, refines log-review and must-gather steps, and includes the new proc_using-lightspeed-troubleshooting.adoc procedure in the troubleshooting assembly.
New troubleshooting procedure (referenced)
documentation/modules/proc_using-lightspeed-troubleshooting.adoc
Adds a procedure for using the Lightspeed chat assistant: prerequisites, example prompts, response review, and verification steps.
Planning assembly include
documentation/doc-Planning_your_migration/assemblies/assembly_lightspeed-integration.adoc, documentation/doc-Planning_your_migration/master.adoc
Adds a new Lightspeed integration assembly and includes it into the planning guide flow.

Sequence Diagram(s)

sequenceDiagram
  participant User as Console User
  participant Console as OCP Web Console
  participant Lightspeed as Lightspeed Service
  participant Forklift as ForkliftController CR
  participant MCP as MCP Server
  participant Cluster as Cluster Data (CRs, Logs)

  User->>Console: Open Lightspeed chat & ask migration question
  Console->>Lightspeed: Forward query with user context
  Lightspeed->>Forklift: Read feature flag / registration state
  Lightspeed->>MCP: Request real-time cluster data
  MCP->>Cluster: Collect plans, CRs, logs
  Cluster-->>MCP: Return diagnostics
  MCP-->>Lightspeed: Provide context and logs
  Lightspeed-->>Console: Reply with diagnosis & remediation (RBAC-aware)
  Console-->>User: Display assistant response
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

  • mnecas
  • anarnold97

Poem

🐰 I hopped through files with tiny paws,
Adding attributes and troubleshooting laws.
Lightspeed chats and procedures penned,
So migrations find a helpful friend—
A rabbit's cheer for docs well penned.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The pull request title 'MCP-OCP-Lightspeed' is vague and uses abbreviated/cryptic terminology that does not clearly convey the main change to someone scanning the commit history. Revise the title to be more descriptive, such as 'Add documentation for Red Hat OpenShift Lightspeed integration with MTV' or 'Document Lightspeed troubleshooting and integration features'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@Jenny-Anne Jenny-Anne marked this pull request as ready for review April 27, 2026 14:35

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

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 `@documentation/modules/proc_enabling-lightspeed-integration.adoc`:
- Around line 25-27: Replace the hardcoded strings in the
proc_enabling-lightspeed-integration.adoc content: change the literal namespace
"konveyor-forklift" to use the shared namespace attribute (e.g., {namespace})
and replace the operator label "Forklift Operator" with a reusable attribute
(e.g., {operator_label} or the attribute defined in
documentation/modules/common-attributes.adoc); update the two lines that contain
"konveyor-forklift" and "Forklift Operator" so they reference those attributes
instead of hardcoded text and ensure the attribute names match what's declared
in common-attributes.adoc.

In `@documentation/modules/proc_using-lightspeed-troubleshooting.adoc`:
- Around line 19-23: Replace the hardcoded "2.12" and any fixed-version URLs
with documentation attributes/xrefs so the prerequisites and link stay correct
across releases: change the literal "2.12" to a version attribute (e.g.,
{product-version} or {product-major-minor}) wherever it appears, and convert the
hardcoded link:https://.../2.12/...[...] to an attribute-based or xref-style
reference (e.g., link:{doc-base}/{product-version}/...[...] or
xref:enabling-lightspeed-integration[Enabling the {lightspeed-full}
integration]) so the text and the "Enabling the {lightspeed-full} integration"
link resolve dynamically instead of pointing to a fixed 2.12 URL.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: beb57a6f-1fd2-4184-8d71-c363fa9891f0

📥 Commits

Reviewing files that changed from the base of the PR and between 0bc52d6 and c1f5246.

📒 Files selected for processing (9)
  • documentation/doc-Migrating_your_virtual_machines/assemblies/assembly_troubleshooting-migration.adoc
  • documentation/doc-Planning_your_migration/assemblies/assembly_lightspeed-integration.adoc
  • documentation/doc-Planning_your_migration/master.adoc
  • documentation/modules/common-attributes.adoc
  • documentation/modules/con_using-lightspeed-with-mtv.adoc
  • documentation/modules/proc_enabling-lightspeed-integration.adoc
  • documentation/modules/proc_troubleshooting-workflow.adoc
  • documentation/modules/proc_using-lightspeed-troubleshooting.adoc
  • documentation/upstream-attributes.adoc

Comment thread documentation/modules/proc_enabling-lightspeed-integration.adoc Outdated
Comment thread documentation/modules/proc_using-lightspeed-troubleshooting.adoc Outdated
Resolved conflict in assembly_troubleshooting-migration.adoc by:
- Keeping the Lightspeed troubleshooting procedure include
- Using the renamed ref_common-migration-issues.adoc (from con_)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@Jenny-Anne Jenny-Anne marked this pull request as ready for review May 25, 2026 09:11

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@documentation/modules/con_using-lightspeed-with-mtv.adoc`:
- Line 63: Update the documentation text that references the ForkliftController
CR to use the finalized feature flag key feature_lightspeed_integration instead
of feature_mcp_server; change the sentence on line 63 to state that the operator
configures Lightspeed when feature_lightspeed_integration is enabled and note
that it is disabled by setting the value to "off", and propagate this corrected
key to any linked procedures or examples that set the ForkliftController spec so
users modify the correct CR field.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 54e16247-1477-47d8-b15f-cd959434c7c4

📥 Commits

Reviewing files that changed from the base of the PR and between d16c516 and b7c8dac.

📒 Files selected for processing (6)
  • documentation/doc-Migrating_your_virtual_machines/assemblies/assembly_troubleshooting-migration.adoc
  • documentation/modules/common-attributes.adoc
  • documentation/modules/con_using-lightspeed-with-mtv.adoc
  • documentation/modules/proc_enabling-lightspeed-integration.adoc
  • documentation/modules/proc_troubleshooting-workflow.adoc
  • documentation/upstream-attributes.adoc
✅ Files skipped from review due to trivial changes (2)
  • documentation/doc-Migrating_your_virtual_machines/assemblies/assembly_troubleshooting-migration.adoc
  • documentation/modules/proc_enabling-lightspeed-integration.adoc

Comment thread documentation/modules/con_using-lightspeed-with-mtv.adoc
Comment thread documentation/modules/con_using-lightspeed-with-mtv.adoc Outdated

@yaacov yaacov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm

np: i am not we are clear it's an AI too, with all the inherent security risks shared by all AI tools ( e.g. you may be sending your information to an external AI service provider )

@Jenny-Anne

Copy link
Copy Markdown
Collaborator Author

lgtm

np: i am not we are clear it's an AI too, with all the inherent security risks shared by all AI tools ( e.g. you may be sending your information to an external AI service provider )

Thanks @yaacov Added this note:

When using Lightspeed with an external AI service provider, cluster information, logs, and resource details may be transmitted to that provider. Evaluate whether external AI services align with the security and compliance requirements of your organization.

Comment thread documentation/modules/con_using-lightspeed-with-mtv.adoc Outdated
Comment thread documentation/modules/con_using-lightspeed-with-mtv.adoc Outdated
Comment thread documentation/modules/con_using-lightspeed-with-mtv.adoc Outdated
Comment thread documentation/modules/con_using-lightspeed-with-mtv.adoc Outdated
Comment thread documentation/modules/con_using-lightspeed-with-mtv.adoc Outdated
Comment thread documentation/modules/proc_enabling-lightspeed-integration.adoc Outdated
Comment thread documentation/modules/proc_troubleshooting-workflow.adoc Outdated
Comment thread documentation/modules/proc_troubleshooting-workflow.adoc
Comment thread documentation/modules/proc_enabling-lightspeed-integration.adoc Outdated

@anarnold97 anarnold97 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is great.

Just a few nits, but nothing to stop us merging

I do want to ask Carolyn to have a look. Not because of your work, but i want to make sure the "Lightspeed" usage has been signed off by legal and the correct naming is being used

thanks

@Jenny-Anne

Copy link
Copy Markdown
Collaborator Author

This is great.

Just a few nits, but nothing to stop us merging

I do want to ask Carolyn to have a look. Not because of your work, but i want to make sure the "Lightspeed" usage has been signed off by legal and the correct naming is being used

thanks

Thanks. We have these three attributes in the attributes file, so we can update them if necessary. I'm not sure if we can use the short form Lightspeed or if it has to be OpenShift Lightspeed.

  • {lightspeed-full} = "Red Hat OpenShift Lightspeed"
  • {lightspeed-short} = "Lightspeed")
  • {lightspeed-operator} = "Red Hat OpenShift Lightspeed Operator"

@Jenny-Anne Jenny-Anne marked this pull request as draft June 12, 2026 14:20
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.

4 participants