@rancher/shell 0.3.16 → 0.3.18

package/config/persistentVolume.ts

@@ -0,0 +1,108 @@
+export const VOLUME_PLUGINS = [
+  {
+    labelKey:  'persistentVolume.awsElasticBlockStore.label',
+    value:     'awsElasticBlockStore',
+    supported: true
+  },
+  {
+    labelKey:  'persistentVolume.azureDisk.label',
+    value:     'azureDisk',
+    supported: true
+  },
+  {
+    labelKey:  'persistentVolume.azureFile.label',
+    value:     'azureFile',
+    supported: true
+  },
+  {
+    labelKey: 'persistentVolume.cephfs.label',
+    value:    'cephfs',
+  },
+  {
+    labelKey: 'persistentVolume.rbd.label',
+    value:    'rbd',
+  },
+  {
+    labelKey:  'persistentVolume.csi.label',
+    value:     'csi',
+    supported: true
+  },
+  {
+    labelKey: 'persistentVolume.fc.label',
+    value:    'fc',
+  },
+  {
+    labelKey: 'persistentVolume.flexVolume.label',
+    value:    'flexVolume',
+  },
+  {
+    labelKey: 'persistentVolume.flocker.label',
+    value:    'flocker',
+  },
+  {
+    labelKey: 'persistentVolume.glusterfs.label',
+    value:    'glusterfs',
+  },
+  {
+    labelKey:  'persistentVolume.gcePersistentDisk.label',
+    value:     'gcePersistentDisk',
+    supported: true
+  },
+  {
+    labelKey:  'persistentVolume.hostPath.label',
+    value:     'hostPath',
+    supported: true
+  },
+  {
+    labelKey: 'persistentVolume.iscsi.label',
+    value:    'iscsi',
+  },
+  {
+    labelKey:  'persistentVolume.local.label',
+    value:     'local',
+    supported: true
+  },
+  {
+    labelKey:  'persistentVolume.longhorn.label',
+    value:     'longhorn',
+    supported: true
+  },
+  {
+    labelKey:  'persistentVolume.nfs.label',
+    value:     'nfs',
+    supported: true
+  },
+  {
+    labelKey: 'persistentVolume.cinder.label',
+    value:    'cinder',
+  },
+  {
+    labelKey: 'persistentVolume.photonPersistentDisk.label',
+    value:    'photonPersistentDisk',
+  },
+  {
+    labelKey: 'persistentVolume.portworxVolume.label',
+    value:    'portworxVolume',
+  },
+
+  {
+    labelKey: 'persistentVolume.quobyte.label',
+    value:    'quobyte',
+  },
+
+  {
+    labelKey: 'persistentVolume.scaleIO.label',
+    value:    'scaleIO',
+  },
+  {
+    labelKey: 'persistentVolume.storageos.label',
+    value:    'storageos',
+  },
+  {
+    labelKey:  'persistentVolume.vsphereVolume.label',
+    value:     'vsphereVolume',
+    supported: true
+  },
+];
+
+export const LONGHORN_PLUGIN = VOLUME_PLUGINS.find((plugin) => plugin.value === 'longhorn');

package/config/product/manager.js

@@ -8,7 +8,7 @@ import {
 } from '@shell/config/types';
 import { MULTI_CLUSTER } from '@shell/store/features';
 import { DSL } from '@shell/store/type-map';
-import { BLANK_CLUSTER } from '@shell/store';
+import { BLANK_CLUSTER } from '@shell/store/store-types.js';
 
 export const NAME = 'manager';
 
@@ -38,6 +38,10 @@ export function init(store) {
         resource: CAPI.RANCHER_CLUSTER
       }
     },
+    typeStoreMap: {
+      [NORMAN.CLOUD_CREDENTIAL]: 'rancher',
+      cloudCredential:           'rancher',
+    }
   });
 
   virtualType({

package/config/router.js

@@ -48,10 +48,6 @@ export const routerOptions = {
     path:      '/prefs',
     component: () => interopDefault(import('../pages/prefs.vue' /* webpackChunkName: "pages/prefs" */)),
     name:      'prefs'
-  }, {
-    path:      '/safeMode',
-    component: () => interopDefault(import('../pages/safeMode.vue' /* webpackChunkName: "pages/safeMode" */)),
-    name:      'safeMode'
   }, {
     path:      '/support',
     component: () => interopDefault(import('../pages/support/index.vue' /* webpackChunkName: "pages/support/index" */)),

package/config/settings.ts

@@ -89,6 +89,10 @@ export const SETTING = {
    */
   CLUSTER_AGENT_DEFAULT_AFFINITY:       'cluster-agent-default-affinity',
   FLEET_AGENT_DEFAULT_AFFINITY:         'fleet-agent-default-affinity',
+  /**
+   * manage rancher repositories in extensions (official, partners repos)
+   */
+  ADD_EXTENSION_REPOS_BANNER_DISPLAY:   'display-add-extension-repos-banner'
 };
 
 // These are the settings that are allowed to be edited via the UI

package/config/table-headers.js

@@ -264,11 +264,12 @@ export const DURATION = {
   formatter: 'LiveDuration',
 };
 
-export const IMAGE = {
-  name:     'image',
-  labelKey: 'tableHeaders.image',
-  value:    'image',
-  sort:     ['image', 'nameSort'],
+export const IMAGE_NAME = {
+  name:      'image',
+  labelKey:  'tableHeaders.image',
+  value:     'image',
+  sort:      ['image', 'nameSort'],
+  formatter: 'ImageName',
 };
 
 export const POD_IMAGES = {

package/config/types.js

@@ -151,6 +151,8 @@ export const LONGHORN = {
   VOLUMES:       'longhorn.io.volume',
 };
 
+export const LONGHORN_DRIVER = 'driver.longhorn.io';
+
 export const SNAPSHOT = 'rke.cattle.io.etcdsnapshot';
 
 // --------------------------------------

package/config/uiplugins.js

@@ -29,8 +29,21 @@ export const UI_PLUGINS_REPO_NAME = 'rancher-ui-plugins';
 export const UI_PLUGINS_REPO_URL = 'https://github.com/rancher/ui-plugin-charts';
 export const UI_PLUGINS_REPO_BRANCH = 'main';
 
+// Info for the Helm Chart Repo for Partner Extensions
+export const UI_PLUGINS_PARTNERS_REPO_NAME = 'partner-extensions';
+
+export const UI_PLUGINS_PARTNERS_REPO_URL = 'https://github.com/rancher/partner-extensions';
+export const UI_PLUGINS_PARTNERS_REPO_BRANCH = 'main';
+
+// Info for the Helm Chart Repo for Community Extensions
+export const UI_PLUGINS_COMMUNITY_REPO_NAME = 'community-extensions';
+
+export const UI_PLUGINS_COMMUNITY_REPO_URL = 'https://github.com/rancher/community-extensions';
+export const UI_PLUGINS_COMMUNITY_REPO_BRANCH = 'main';
+
 // Chart annotations
 export const UI_PLUGIN_CHART_ANNOTATIONS = {
+  KUBE_VERSION:       'catalog.cattle.io/kube-version',
   RANCHER_VERSION:    'catalog.cattle.io/rancher-version',
   EXTENSIONS_VERSION: 'catalog.cattle.io/ui-extensions-version',
   UI_VERSION:         'catalog.cattle.io/ui-version',
@@ -121,16 +134,18 @@ export function shouldNotLoadPlugin(plugin, rancherVersion, loadedPlugins) {
 }
 
 // Can a chart version be used for this Rancher (based on the annotations on the chart)?
-export function isSupportedChartVersion(chartVersion, rancherVersion) {
+export function isSupportedChartVersion(versionsData) {
+  const { version, rancherVersion, kubeVersion } = versionsData;
+
   // Plugin specified a required extension API version
-  const requiredAPI = chartVersion.annotations?.[UI_PLUGIN_CHART_ANNOTATIONS.EXTENSIONS_VERSION];
+  const requiredAPI = version.annotations?.[UI_PLUGIN_CHART_ANNOTATIONS.EXTENSIONS_VERSION];
 
   if (requiredAPI && !semver.satisfies(UI_PLUGIN_API_VERSION, requiredAPI)) {
     return false;
   }
 
   // Host application
-  const requiredHost = chartVersion.annotations?.[UI_PLUGIN_CHART_ANNOTATIONS.EXTENSIONS_HOST];
+  const requiredHost = version.annotations?.[UI_PLUGIN_CHART_ANNOTATIONS.EXTENSIONS_HOST];
 
   if (requiredHost && requiredHost !== UI_PLUGIN_HOST_APP) {
     return false;
@@ -138,24 +153,37 @@ export function isSupportedChartVersion(chartVersion, rancherVersion) {
 
   // Rancher version
   if (rancherVersion) {
-    const requiredRancherVersion = chartVersion.annotations?.[UI_PLUGIN_CHART_ANNOTATIONS.RANCHER_VERSION];
+    const requiredRancherVersion = version.annotations?.[UI_PLUGIN_CHART_ANNOTATIONS.RANCHER_VERSION];
 
     if (requiredRancherVersion && !semver.satisfies(rancherVersion, requiredRancherVersion)) {
       return false;
     }
   }
 
+  // Kube version
+  if (kubeVersion) {
+    const requiredKubeVersion = version.annotations?.[UI_PLUGIN_CHART_ANNOTATIONS.KUBE_VERSION];
+
+    if (requiredKubeVersion && !semver.satisfies(kubeVersion, requiredKubeVersion)) {
+      return false;
+    }
+  }
+
   return true;
 }
 
-export function isChartVersionAvailableForInstall(version, rancherVersion, returnObj = false) {
+export function isChartVersionAvailableForInstall(versionsData, returnObj = false) {
+  const { version, rancherVersion, kubeVersion } = versionsData;
+
   const parsedRancherVersion = rancherVersion.split('-')?.[0];
   const regexHashString = new RegExp('^[A-Za-z0-9]{9}$');
   const isRancherVersionHashString = regexHashString.test(rancherVersion);
   const requiredUiVersion = version.annotations?.[UI_PLUGIN_CHART_ANNOTATIONS.UI_VERSION];
+  const requiredKubeVersion = version.annotations?.[UI_PLUGIN_CHART_ANNOTATIONS.KUBE_VERSION];
   const versionObj = { ...version };
 
   versionObj.isCompatibleWithUi = true;
+  versionObj.isCompatibleWithKubeVersion = true;
 
   // if it's a head version of Rancher, then we skip the validation and enable them all
   if (!isRancherVersionHashString && requiredUiVersion && !semver.satisfies(parsedRancherVersion, requiredUiVersion)) {
@@ -164,6 +192,23 @@ export function isChartVersionAvailableForInstall(version, rancherVersion, retur
     }
     versionObj.isCompatibleWithUi = false;
     versionObj.requiredUiVersion = requiredUiVersion;
+
+    if (returnObj) {
+      return versionObj;
+    }
+  }
+
+  // check kube version
+  if (kubeVersion && requiredKubeVersion && !semver.satisfies(kubeVersion, requiredKubeVersion)) {
+    if (!returnObj) {
+      return false;
+    }
+    versionObj.isCompatibleWithKubeVersion = false;
+    versionObj.requiredKubeVersion = requiredKubeVersion;
+
+    if (returnObj) {
+      return versionObj;
+    }
   }
 
   if (returnObj) {

package/core/plugin-helpers.js

@@ -1,8 +1,11 @@
 import { ActionLocation, CardLocation, ExtensionPoint } from '@shell/core/types';
 import { isMac } from '@shell/utils/platform';
 import { ucFirst, randomStr } from '@shell/utils/string';
-import { _EDIT, _CONFIG, _DETAIL, _LIST } from '@shell/config/query-params';
+import {
+  _EDIT, _CONFIG, _DETAIL, _LIST, _CREATE
+} from '@shell/config/query-params';
 import { getProductFromRoute } from '@shell/middleware/authenticated';
+import { isEqual } from '@shell/utils/object';
 
 function checkRouteProduct({ name, params, query }, locationConfigParam) {
   const product = getProductFromRoute({
@@ -20,21 +23,24 @@ function checkRouteProduct({ name, params, query }, locationConfigParam) {
 }
 
 function checkRouteMode({ name, query }, locationConfigParam) {
-  if (locationConfigParam === _EDIT && query.mode && query.mode === _EDIT) {
+  if (locationConfigParam === _EDIT && query.mode && query.mode === _EDIT && !query.as) {
     return true;
   } else if (locationConfigParam === _CONFIG && query.as && query.as === _CONFIG) {
     return true;
-  } else if (locationConfigParam === _DETAIL && name.includes('-id')) {
+  } else if (locationConfigParam === _DETAIL && !query.as && name.includes('-id') && (!query.mode || query?.mode !== _EDIT)) {
     return true;
     // alias to target all list views
   } else if (locationConfigParam === _LIST && !name.includes('-id') && name.includes('-resource')) {
     return true;
+    // alias to target create views
+  } else if (locationConfigParam === _CREATE && name.endsWith('-create')) {
+    return true;
   }
 
   return false;
 }
 
-function checkExtensionRouteBinding($route, locationConfig) {
+function checkExtensionRouteBinding($route, locationConfig, context) {
   // if no configuration is passed, consider it as global
   if (!Object.keys(locationConfig).length) {
     return true;
@@ -43,23 +49,31 @@ function checkExtensionRouteBinding($route, locationConfig) {
   const { params } = $route;
 
   // "params" to be checked based on the locationConfig
+  // This has become overloaded with mode and context
   const paramsToCheck = [
     'product',
     'resource',
     'namespace',
     'cluster',
     'id',
-    'mode'
+    'mode',
+    'path',
+    // url query params
+    'queryParam',
+    // Custom context specific params provided by the extension, not to be confused with location params
+    'context',
   ];
 
-  let res = false;
+  let res = true;
 
   for (let i = 0; i < paramsToCheck.length; i++) {
     const param = paramsToCheck[i];
 
     if (locationConfig[param]) {
-      for (let x = 0; x < locationConfig[param].length; x++) {
-        const locationConfigParam = locationConfig[param][x];
+      const asArray = Array.isArray(locationConfig[param]) ? locationConfig[param] : [locationConfig[param]];
+
+      for (let x = 0; x < asArray.length; x++) {
+        const locationConfigParam = asArray[x];
 
         if (locationConfigParam) {
           // handle "product" in a separate way...
@@ -68,6 +82,21 @@ function checkExtensionRouteBinding($route, locationConfig) {
           // also handle "mode" in a separate way because it mainly depends on query params
           } else if (param === 'mode') {
             res = checkRouteMode($route, locationConfigParam);
+          } else if (param === 'context') {
+            // Need all keys and values to match
+            res = isEqual(locationConfigParam, context);
+            // evaluate queryParam in route
+          } else if (param === 'queryParam') {
+            res = isEqual(locationConfigParam, $route.query);
+            // evaluate path in route
+          } else if (param === 'path' && locationConfigParam.urlPath) {
+            if (locationConfigParam.endsWith) {
+              res = $route.path.endsWith(locationConfigParam.urlPath);
+            } else if (!Object.keys(locationConfigParam).includes('exact') || locationConfigParam.exact) {
+              res = locationConfigParam.urlPath === $route.path;
+            } else {
+              res = $route.path.includes(locationConfigParam.urlPath);
+            }
           } else if (locationConfigParam === params[param]) {
             res = true;
           } else {
@@ -91,7 +120,7 @@ function checkExtensionRouteBinding($route, locationConfig) {
   return res;
 }
 
-export function getApplicableExtensionEnhancements(pluginCtx, actionType, uiArea, currRoute, translationCtx = pluginCtx) {
+export function getApplicableExtensionEnhancements(pluginCtx, actionType, uiArea, currRoute, translationCtx = pluginCtx, context) {
   const extensionEnhancements = [];
 
   // gate it so that we prevent errors on older versions of dashboard
@@ -99,7 +128,7 @@ export function getApplicableExtensionEnhancements(pluginCtx, actionType, uiArea
     const actions = pluginCtx.$plugin.getUIConfig(actionType, uiArea);
 
     actions.forEach((action, i) => {
-      if (checkExtensionRouteBinding(currRoute, action.locationConfig)) {
+      if (checkExtensionRouteBinding(currRoute, action.locationConfig, context || {})) {
         // ADD CARD PLUGIN UI ENHANCEMENT
         if (actionType === ExtensionPoint.CARD) {
           // intercept to apply translation
@@ -116,11 +145,6 @@ export function getApplicableExtensionEnhancements(pluginCtx, actionType, uiArea
               actions[i].label = translationCtx.t(action.labelKey);
             }
 
-            // sets the enabled flag to true if omitted on the config
-            if (!Object.keys(action).includes('enabled')) {
-              actions[i].enabled = true;
-            }
-
             // bulkable flag
             actions[i].bulkable = actions[i].multiple || actions[i].bulkable;
 

package/core/plugin.ts

@@ -15,6 +15,7 @@ import {
   PluginRouteConfig, RegisterStore, UnregisterStore, CoreStoreSpecifics, CoreStoreConfig, OnNavToPackage, OnNavAwayFromPackage, OnLogOut
 } from './types';
 import coreStore, { coreStoreModule, coreStoreState } from '@shell/plugins/dashboard-store';
+import { registerLayout } from '@shell/initialize/layouts';
 
 export type ProductFunction = (plugin: IPlugin, store: any) => void;
 
@@ -267,6 +268,14 @@ export class Plugin implements IPlugin {
       }
 
       this.l10n[name].push(fn);
+    } else if (type === 'layouts') {
+      fn().then((component: any) => {
+        if (component.default) {
+          registerLayout(name, component.default);
+        } else {
+          console.error(`Failed to load layout ${ name } because the file didn't export a default component.`); // eslint-disable-line no-console
+        }
+      });
     } else {
       if (!this.types[type]) {
         this.types[type] = {};

package/core/plugins.js

@@ -182,7 +182,7 @@ export default function({
           console.error('Error removing plugin', e); // eslint-disable-line no-console
         }
 
-        delete plugins[plugin.name];
+        delete plugins[plugin.id];
       }
     },