Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-20378

Provide multicluster SDK NPM package

XMLWordPrintable

    • Provide multicluster SDK NPM package
    • Product / Portfolio Work
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected
    • In Progress
    • VIRTSTRAT-53 - ACM-CNV UI integration and multi-cluster SDK supporting VM list, VM details, VNC Console
    • VIRTSTRAT-53ACM-CNV UI integration and multi-cluster SDK supporting VM list, VM details, VNC Console
    • 0% To Do, 0% In Progress, 100% Done

      OCP/Telco Definition of Done
      https://docs.google.com/document/d/1TP2Av7zHXz4_fmeX4q9HB0m9cqSZ4F6Jd4AiVoaF_2s/edit#heading=h.gaa58bzbvwde
      Epic Template descriptions and documentation.
      https://docs.google.com/document/d/14CUCEg6hQ_jpsFzJtWo29GfFVWmun2Uivrxq3_Fkgdg/edit
      ACM-wide Product Requirements (Top-level Epics)
      https://docs.google.com/document/d/1uIp6nS2QZ766UFuZBaC9USs8dW_I5wVdtYF9sUObYKg/edit

      *<--- Cut-n-Paste the entire contents of this description into your new
      Epic --->*

      Epic Goal

      Provide an initial version of the @stolostron/multicluster-sdk package that supports the features required for VNC console access.

      Why is this important?

      Customers do not want users to have to switch to the console of a managed cluster and log in separately to access the VNC consoles of VMs that are distributed across various clusters in the fleet. This package will allow the kubevirt-plugin to leverage ACM functionality that will allow it to connect to a managed cluster instead of communicating only with the cluster it is running on.

      Scenarios

      Other OpenShift console dynamic plugins can install the @stolostron/multicluster-sdk package and use its APIs. When ACM is available and providing a compatible implementation, the APIs can work with all clusters in the fleet.

      Acceptance Criteria

      • The package implements a useFleetK8sAPI hook that plugins can use to determine the correct Kubernetes API route for a given cluster
      • The package implements a useFleetK8sWatchResource hook, analagous to useK8sWatchResource, that will retrieve resource(s) from a given managed cluster.
      • Documentation and examples are provided.

      Dependencies (internal and external)

      1. ...

      Previous Work (Optional):

      1. ...

      Open questions:

      Done Checklist

      • CI - CI is running, tests are automated and merged.
      • Release Enablement <link to Feature Enablement Presentation>
      • DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
        Issue>
      • DEV - Upstream documentation merged: <link to meaningful PR or GitHub
        Issue>
      • DEV - Downstream build attached to advisory: <link to errata>
      • QE - Test plans in Polarion: <link or reference to Polarion>
      • QE - Automated tests merged: <link or reference to automated tests>
      • DOC - Doc issue opened with a completed template. Separate doc issue
        opened for any deprecation, removal, or any current known
        issue/troubleshooting removal from the doc, if applicable.
      • Considerations were made for Extended Update Support (EUS)

              rh-ee-kcormier Kevin Cormier
              rh-ee-kcormier Kevin Cormier
              David Huynh David Huynh
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: