Uploaded image for project: 'OpenShift Console'
  1. OpenShift Console
  2. CONSOLE-3202

SDK Extensions should be backwards compatible in OpenShift Console

    XMLWordPrintable

Details

    • Story
    • Resolution: Unresolved
    • Blocker
    • None
    • None
    • Dynamic Plugins

    Description

      Once the specific existing extensions we have identified exist in the Core SDK and we have done a release, we'll be bringing it back into OpenShift Console. This will be to drive both HAC & OpenShift Console from the same base SDK. However, many plugins exist today with the usage of the extensions we moved. This is not ideal for backwards compatible support to change this on them, so we'll support this in a backwards compatible way by repackaging the Core SDK extensions back out as Console extensions.

      Acceptance Criteria

      • Bring in to console Core HAC SDK package
      • Create a new extension type in the OpenShift Console SDK; `RepackageExtension` that will allow for redefining the name of the extension (see below for an example snippet)
      • Verify that the core extensions didn't change types
      • Import Core extensions back to their `console.` variant by using `RepackageExtension` type

      Details

      This effort is for backwards compatible, and since OpenShift Console is the only one who needs it... we can add this to OpenShift Console.

      // OpenShift Console SDK will use this internally so it can redefine core extensions
export type RepackageExtension<T extends string, E extends Extension> = ExtensionDeclaration<
  T,
  E['properties']
>;


// An example of an OpenShift Console SDK repackaging an imported Core Extension
import { MyCoreExtension } from '@openshift/dynamic-plugin-sdk';

type MyConsoleExtension = RepackageExtension<
  'console.something/other-thing',
  MyCoreExtension
>;

      Attachments

        Issue Links

          blocks

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. CONSOLE-3203 Refactor OpenShift Console to use Bootstrapping from the Core SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. CONSOLE-3211 Refactor OpenShift Console to use common-fetch utils from the Core SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. CONSOLE-3212 Refactor OpenShift Console to use k8s hooks from the Core SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. CONSOLE-3213 Refactor OpenShift Console to use watch-resource-types from the Core SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. CONSOLE-3214 Refactor OpenShift Console to use use-model-types utils from the Core SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. CONSOLE-3215 Refactor OpenShift Console to use k8s-resource utils from the Core SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. CONSOLE-3216 Refactor OpenShift Console to use k8s-utils from the Core SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. CONSOLE-3217 Refactor OpenShift Console to use k8s types utils from the Core SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. CONSOLE-3218 Refactor OpenShift Console to use web-socket utils from the Core SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • To Do
          is blocked by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. HAC-424 Support Extensions in the Core SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          links to

          GitHub openshift/console#11841: [WIP] CONSOLE-3202: utilize Core SDK extensions

          GitHub openshift/console#11978: [WIP] CONSOLE-3202: utilize Core SDK extensions

          Activity

            People

              Unassigned Unassigned
              aballantyne Andrew Ballantyne
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: