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

Multicluster SDK - implement useFleetK8sAPIPath

XMLWordPrintable

    • Product / Portfolio Work
    • 5
    • False
    • Hide

      None

      Show
      None
    • False
    • Hide

      Provide the required acceptance criteria using this template.

      • ...
      Show
      Provide the required acceptance criteria using this template. ...
    • ACM Console Train 31 - 1
    • Important
    • None

      Value Statement

      Provide a hook that plugins can use to obtain the kubernetes API path for a given cluster. This is useful for cases where the plugin connects directly to the API or uses a dynamic plugin SDK function like consoleFetch or similar that accepts a URL path. This should also be provided as an async function, getFleetK8sAPIPath.

      Definition of Done for Engineering Story Owner (Checklist)

      • Hook accepts the cluster name as a param
      • Hook returns a tuple similar to other asynchronous hooks, because it needs to check the name of the hub cluster
      • The API path is simply the ACM cluster proxy route with cluster name appended, or the OCP console API route (/api/kubernetes) for the hub cluster (no cluster name provided or name matches hub cluster name)
      • Hook can cache the name of the hub cluster using zustand
      • Function version getFleetK8sAPIPath returns Promise<string>
      • Should include unit tests (see React Hooks Testing Library)

      Development Complete

      • The code is complete.
      • Functionality is working.
      • Any required downstream Docker file changes are made.

      Tests Automated

      • [ ] Unit/function tests have been automated and incorporated into the
        build.
      • [ ] 100% automated unit/function test coverage for new or changed APIs.

      Secure Design

      • [ ] Security has been assessed and incorporated into your threat model.

      Multidisciplinary Teams Readiness

      • [ ] Create an informative documentation issue using the Customer

      Portal Doc template that you can access from [The Playbook](

      https://docs.google.com/document/d/1YTqpZRH54Bnn4WJ2nZmjaCoiRtqmrc2w6DdQxe_yLZ8/edit#heading=h.9fvyr2rdriby),

      and ensure doc acceptance criteria is met.

      • Call out this sentence as it's own action:
      • [ ] Link the development issue to the doc issue.

      Support Readiness

      • [ ] The must-gather script has been updated.

              jswanke@redhat.com John Swanke
              rh-ee-kcormier Kevin Cormier
              David Huynh David Huynh
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: