Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-10041

Spike: Investigate Wrapping Current AI RHDH Installer With Go CLI

    • Icon: Story Story
    • Resolution: Unresolved
    • Icon: Normal Normal
    • 1.9.0
    • None
    • None
    • None

      Story (Required)

      As a user of the AI RHDH Installer trying to have a easy to use interface, I want to run and configure as few commands + settings as possible when setting up my environment.

      <Describes high level purpose and goal for this story. Answers the questions: Who is impacted, what is it and why do we need it? How does it improve the customer’s experience?>

      Background (Required)

      <Describes the context or background related to this story>

       

      • The current AI RHDH Installer is a combination of a bunch of Bash scripts, we should look into wrapping this in a Go CLI
      • This CLI can be extended in the future to easily incorporate new use-cases
        • E.g. Operator profiles, local deployment, etc
      • As part of this we should look into what it would take to convert our current AI RHDH Installer into Go modules so that we can take advantage of the benefits of Go
        • E.g. testing, nativeness with the Kube API

      Out of scope

      • Any investigation work for the chosen RHDH flavor / profile to be used
      • Investigation into the utilization of GitOps resources for the installations

      Approach (Required)

      • Determine what under the AI RHDH installer would need to be refactored and what we can drop
      • Design the layout of packages / functions that will be created from converting the existing bash functionality
      • Design the commands the user will use to directly interact with the setup
        • Installing the RHDH and companion components
        • Creating setup or updating the existing setup to add integrations
      • Investigate testing options and determine path to take for testing the installer

      Dependencies

      <Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>

      Acceptance Criteria (Required)

      <Describe edge cases to consider when implementing the story and defining tests>

      <Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story>

      documentation updates (design docs, release notes etc)
      demo needed
      SOP required
      education module update (Filled by RHDHPAI team only)
      R&D label required (Filled by RHDHPAI team only)

      Done Checklist

      Code is completed, reviewed, documented and checked in
      Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
      Continuous Delivery pipeline(s) is able to proceed with new code included
      Customer facing documentation, API docs, design docs etc. are produced/updated, reviewed and published
      Acceptance criteria are met
      If the Grafana dashboard is updated, ensure the corresponding SOP is updated as well

              Unassigned Unassigned
              rh-ee-jdubrick Jordan Dubrick
              RHIDP - AI
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: