Uploaded image for project: 'Migration Toolkit for Applications'
  1. Migration Toolkit for Applications
  2. MTA-6524

[DOC] Reorganize Developer Lightspeed Prerequisites to nest Operator, Plugin, and API dependencies

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Normal Normal
    • MTA 8.2.0
    • None
    • Documentation
    • None
    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • False
    • None

      Following internal review (Comment I24), the current linear list of prerequisites for Developer Lightspeed does not accurately reflect the hierarchy of dependencies required for the feature to function. Specifically, the MTA Operator acts as the foundation for the Solution Server, which in turn requires both a client-side interface (VS Code Extension) and a backend authorization mechanism (LLM API Key). Restructuring these items as sub-bullets clarifies the order of operations for users setting up the environment.

      Comment
      Would it make sense to move the table in the pre-reqs to a reference section? "Table 2.1. Configurable large language models and providers"
       
      The "Create an API key for an LLM." pre-req seems to be a sub-bullet to the "Install the MTA Operator 8.0.0."
      Suggest the "Install the MTA Operator 8.0.0" have 3 sub-bullets:
      -  ...mandatory if you plan to enable the Solution Server...
      - install the migration toolkit for applications (MTA) 8.0.0 Visual Studio (VS) Code plug-in from the VS Code marketplace.
      • Create an API key

      Detailed Content Restructuring

      The section "Install the MTA Operator 8.0.0" should be elevated as a primary requirement with three specific sub-tasks:

      1. Enable the Solution Server:
        • State clearly that the MTA Operator is mandatory to manage the deployment, configuration, and lifecycle of the Solution Server.
        • The Operator is the mechanism used to enable the spec.lightspeed section within the Tackle Custom Resource (CR) to activate AI functionality.
           
      1. Install the MTA VS Code Extension:
        • The extension is the primary user interface for triggering contextual code fixes.
        • Users must install the "Red Hat Developer Lightspeed for MTA" extension from the Marketplace or via VSIX to ensure the IDE can communicate with the backend services.
      1. Create an LLM API Key:
        • This is a required secret for authenticating the Solution Server with the Large Language Model provider.
        • The API key must be configured as a secret in the cluster to ensure secure communication without exposing credentials

      Reference Hyperlinks

      Acceptance Criteria

      • [ ] The prerequisites section for Lightspeed reflects the 3-bullet nested structure under the MTA Operator installation.
      • [ ] Clear cross-references are maintained between the IDE setup and the backend Solution Server configuration.
      • [ ] The relationship between the API key secret and the Tackle CR is clearly articulated in the consolidated steps.
         

              rhn-support-anarnold A Arnold
              rhn-support-anarnold A Arnold
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: