@rancher/shell 0.1.2 → 0.1.3

package/config/product/harvester-manager.js

@@ -3,9 +3,60 @@ import { HARVESTER, MULTI_CLUSTER } from '@shell/store/features';
 import { DSL } from '@shell/store/type-map';
 import { STATE, NAME as NAME_COL, AGE, VERSION } from '@shell/config/table-headers';
 import { allHash } from '@shell/utils/promise';
+import dynamicPluginLoader from '@shell/pkg/dynamic-plugin-loader';
+import { BLANK_CLUSTER } from '@shell/store';
+
+dynamicPluginLoader.register({
+  load: async({ route, store }) => {
+    // Check that we've either got here either
+    // - directly (page refresh/load -> have path but no name)
+    // - via router name (have name but no path)
+    let clusterId;
+    const pathParts = route.path.split('/');
+
+    if (pathParts?.[1] === HARVESTER_NAME && pathParts?.[3] ) {
+      clusterId = pathParts?.[3];
+    } else {
+      const nameParts = route.name?.split('-');
+
+      if (nameParts?.[0] === HARVESTER_NAME) {
+        clusterId = route.params?.cluster;
+      }
+    }
+
+    // If we have a cluster id, try to load the plugin via the harvester cluster's `loadClusterPlugin`
+    if (clusterId) {
+      const provClusters = await store.dispatch('management/findAll', { type: CAPI.RANCHER_CLUSTER });
+      const provCluster = provClusters.find(p => p.mgmt.id === clusterId);
+
+      if (provCluster) {
+        const harvCluster = await store.dispatch('management/create', {
+          ...provCluster,
+          type: HCI.CLUSTER
+        });
+
+        if (harvCluster) {
+          try {
+            await harvCluster.loadClusterPlugin();
+
+            return route;
+          } catch (err) {
+            // If we've failed to load the harvester plugin nav to the harvester cluster list (probably got here from a bookmarked
+            // harvester instance that hasn't been updated to serve a plugin)
+            console.error('Failed to load harvester package: ', typeof error === 'object' ? JSON.stringify(err) : err); // eslint-disable-line no-console
+
+            return harvesterClustersLocation;
+          }
+        }
+      }
+    }
+  }
+});
 
 export const NAME = 'harvesterManager';
 
+export const HARVESTER_NAME = 'harvester';
+
 const MACHINE_POOLS = {
   name:      'summary',
   labelKey:  'tableHeaders.machines',
@@ -16,6 +67,15 @@ const MACHINE_POOLS = {
   width:     100,
 };
 
+const harvesterClustersLocation = {
+  name:   'c-cluster-product-resource',
+  params: {
+    cluster:  BLANK_CLUSTER,
+    product:  NAME,
+    resource: HCI.CLUSTER
+  }
+};
+
 export function init(store) {
   const {
     product,
@@ -33,6 +93,7 @@ export function init(store) {
     removable:           false,
     showClusterSwitcher: false,
     weight:              100,
+    to:                  harvesterClustersLocation,
   });
 
   configureType(HCI.CLUSTER, { showListMasthead: false });
@@ -41,7 +102,8 @@ export function init(store) {
     NAME_COL,
     {
       ...VERSION,
-      value: 'kubernetesVersion'
+      value:    'kubernetesVersion',
+      getValue: row => row.kubernetesVersion
     },
     MACHINE_POOLS,
     AGE,
@@ -54,7 +116,7 @@ export function init(store) {
   ]);
   basicType([HCI.CLUSTER]);
   spoofedType({
-    label:      store.getters['i18n/t']('harvester.manager.cluster.label'),
+    label:      store.getters['i18n/t']('harvesterManager.cluster.label'),
     name:       HCI.CLUSTER,
     type:       HCI.CLUSTER,
     namespaced: false,

package/config/product/manager.js

@@ -7,6 +7,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';
 
 export const NAME = 'manager';
 
@@ -28,6 +29,14 @@ export function init(store) {
     icon:                'cluster-management',
     removable:           false,
     showClusterSwitcher: false,
+    to:                   {
+      name:   'c-cluster-product-resource',
+      params: {
+        cluster:  BLANK_CLUSTER,
+        product:  NAME,
+        resource: CAPI.RANCHER_CLUSTER
+      }
+    },
   });
 
   virtualType({

package/config/settings.js

@@ -1,5 +1,6 @@
 // Settings
 import { MANAGEMENT } from './types';
+
 // Adapted from: https://github.com/rancher/ui/blob/08c379a9529f740666a704b52522a468986c3520/lib/shared/addon/utils/constants.js#L564
 // Setting IDs
 export const SETTING = {
@@ -15,12 +16,12 @@ export const SETTING = {
   API_HOST:                         'api-host',
   CA_CERTS:                         'cacerts',
 
-  // Allow the local cluste to be hidden
+  // Allow the local cluster to be hidden
   HIDE_LOCAL_CLUSTER:                   'hide-local-cluster',
   AUTH_TOKEN_MAX_TTL_MINUTES:           'auth-token-max-ttl-minutes',
   KUBECONFIG_GENERATE_TOKEN:            'kubeconfig-generate-token',
   KUBECONFIG_TOKEN_TTL_MINUTES:         'kubeconfig-token-ttl-minutes',
-  KUBECONFIG_DEFAULT_TOKEN_TTL_MINUTES:       'kubeconfig-default-token-ttl-minutes',
+  KUBECONFIG_DEFAULT_TOKEN_TTL_MINUTES: 'kubeconfig-default-token-ttl-minutes',
   ENGINE_URL:                           'engine-install-url',
   ENGINE_ISO_URL:                       'engine-iso-url',
   FIRST_LOGIN:                          'first-login',
@@ -33,9 +34,11 @@ export const SETTING = {
   AUTH_USER_SESSION_TTL_MINUTES:        'auth-user-session-ttl-minutes',
   AUTH_USER_INFO_RESYNC_CRON:           'auth-user-info-resync-cron',
   AUTH_LOCAL_VALIDATE_DESC:             'auth-password-requirements-description',
+  CATTLE_PASSWORD_MIN_LENGTH:           'password-min-length',
   CLUSTER_TEMPLATE_ENFORCEMENT:         'cluster-template-enforcement',
   UI_INDEX:                             'ui-index',
   UI_DASHBOARD_INDEX:                   'ui-dashboard-index',
+  UI_DASHBOARD_HARVESTER_LEGACY_PLUGIN: 'ui-dashboard-harvester-legacy-plugin',
   UI_OFFLINE_PREFERRED:                 'ui-offline-preferred',
   SYSTEM_DEFAULT_REGISTRY:              'system-default-registry',
   UI_ISSUES:                            'ui-issues',
@@ -63,11 +66,9 @@ export const SETTING = {
 // These are the settings that are allowed to be edited via the UI
 export const ALLOWED_SETTINGS = {
   [SETTING.CA_CERTS]:                             { kind: 'multiline', readOnly: true },
-  // [SETTING.CLUSTER_DEFAULTS]:            { kind: 'json' },
   [SETTING.ENGINE_URL]:                           {},
   [SETTING.ENGINE_ISO_URL]:                       {},
-  // [SETTING.PL]:                             {},
-  // [SETTING.ISSUES]:                         {},
+  [SETTING.CATTLE_PASSWORD_MIN_LENGTH]:           { kind: 'integer' },
   [SETTING.INGRESS_IP_DOMAIN]:                    {},
   [SETTING.AUTH_USER_INFO_MAX_AGE_SECONDS]:       {},
   [SETTING.AUTH_USER_SESSION_TTL_MINUTES]:        {},
@@ -78,7 +79,6 @@ export const ALLOWED_SETTINGS = {
   [SETTING.AUTH_USER_INFO_RESYNC_CRON]:           {},
   [SETTING.SERVER_URL]:                           { kind: 'url', canReset: true },
   [SETTING.RKE_METADATA_CONFIG]:                  { kind: 'json' },
-  // [SETTING.BANNERS]:                        { kind: 'json' },
   [SETTING.SYSTEM_DEFAULT_REGISTRY]:              {},
   [SETTING.UI_INDEX]:                             {},
   [SETTING.UI_DASHBOARD_INDEX]:                   {},
@@ -94,74 +94,19 @@ export const ALLOWED_SETTINGS = {
   },
   [SETTING.HIDE_LOCAL_CLUSTER]: { kind: 'boolean' },
 };
-// harvester Settings ID
-export const HCI_SETTING = {
-  BACKUP_TARGET:                    'backup-target',
-  LOG_LEVEL:                        'log-level',
-  SERVER_VERSION:                   'server-version',
-  UI_INDEX:                         'ui-index',
-  UPGRADE_CHECKER_ENABLED:          'upgrade-checker-enabled',
-  UPGRADE_CHECKER_URL:              'upgrade-checker-url',
-  VLAN:                             'vlan',
-  UI_SOURCE:                        'ui-source',
-  HTTP_PROXY:                       'http-proxy',
-  ADDITIONAL_CA:                    'additional-ca',
-  OVERCOMMIT_CONFIG:                'overcommit-config',
-  CLUSTER_REGISTRATION_URL:         'cluster-registration-url',
-  DEFAULT_STORAGE_CLASS:            'default-storage-class',
-  VIP:                              'vip-pools',
-  SUPPORT_BUNDLE_TIMEOUT:           'support-bundle-timeout',
-  SUPPORT_BUNDLE_IMAGE:             'support-bundle-image',
-  VM_FORCE_RESET_POLICY:            'vm-force-reset-policy',
-  SSL_CERTIFICATES:                 'ssl-certificates',
-  SSL_PARAMETERS:                   'ssl-parameters',
-  SUPPORT_BUNDLE_NAMESPACES:        'support-bundle-namespaces',
-  AUTO_DISK_PROVISION_PATHS:        'auto-disk-provision-paths',
-  RANCHER_MONITORING:               'fleet-local/rancher-monitoring',
-  RELEASE_DOWNLOAD_URL:             'release-download-url'
-};
-export const HCI_ALLOWED_SETTINGS = {
-  [HCI_SETTING.BACKUP_TARGET]: { kind: 'json', from: 'import' },
-  [HCI_SETTING.LOG_LEVEL]:     {
-    kind:    'enum',
-    options: ['info', 'debug', 'trace']
-  },
-  [HCI_SETTING.VLAN]: {
-    kind: 'custom', from: 'import', alias: 'vlan'
-  },
-  [HCI_SETTING.SERVER_VERSION]:                   { readOnly: true },
-  [HCI_SETTING.UPGRADE_CHECKER_ENABLED]:          { kind: 'boolean' },
-  [HCI_SETTING.UPGRADE_CHECKER_URL]:              { kind: 'url' },
-  [HCI_SETTING.HTTP_PROXY]:                       { kind: 'json', from: 'import' },
-  [HCI_SETTING.ADDITIONAL_CA]:                    {
-    kind: 'multiline', canReset: true, from: 'import'
-  },
-  [HCI_SETTING.OVERCOMMIT_CONFIG]:                { kind: 'json', from: 'import' },
-  [HCI_SETTING.SUPPORT_BUNDLE_TIMEOUT]:           {},
-  [HCI_SETTING.SUPPORT_BUNDLE_IMAGE]:             { kind: 'json', from: 'import' },
-  [HCI_SETTING.VM_FORCE_RESET_POLICY]:            { kind: 'json', from: 'import' },
-  [HCI_SETTING.SSL_CERTIFICATES]:                 { kind: 'json', from: 'import' },
-  [HCI_SETTING.VIP]:                      {
-    kind: 'json', from: 'import', canReset: true
-  },
-  [HCI_SETTING.SSL_PARAMETERS]:                   {
-    kind: 'json', from: 'import', canReset: true
-  },
-  [HCI_SETTING.SUPPORT_BUNDLE_NAMESPACES]: { from: 'import', canReset: true },
-  [HCI_SETTING.AUTO_DISK_PROVISION_PATHS]: { canReset: true },
-  [HCI_SETTING.RANCHER_MONITORING]:                {
-    kind: 'custom', from: 'import', canReset: true, customFormatter: 'json', alias: 'harvester-monitoring'
+
+export const DEFAULT_PERF_SETTING = {
+  incrementalLoading: {
+    enabled:   true,
+    threshold: 1500,
   },
-  [HCI_SETTING.RELEASE_DOWNLOAD_URL]: { kind: 'url' },
-};
-export const HCI_SINGLE_CLUSTER_ALLOWED_SETTING = {
-  [HCI_SETTING.UI_SOURCE]: {
-    kind:    'enum',
-    options: ['auto', 'external', 'bundled']
+  manualRefresh: {
+    enabled:   false,
+    threshold: 1500,
   },
-  [HCI_SETTING.UI_INDEX]:                 { kind: 'url' },
-  [HCI_SETTING.CLUSTER_REGISTRATION_URL]: { kind: 'url' },
+  disableWebsocketNotification: false
 };
+
 export const fetchOrCreateSetting = async(store, id, val, save = true) => {
   let setting;
 
@@ -181,6 +126,7 @@ export const fetchOrCreateSetting = async(store, id, val, save = true) => {
 
   return setting;
 };
+
 export const setSetting = async(store, id, val) => {
   const setting = await fetchOrCreateSetting(store, id, val, false);
 

package/config/table-headers.js

@@ -870,7 +870,6 @@ export const FEATURE_DESCRIPTION = {
   value:         'status.description',
   align:         'left',
   sort:          ['status.description'],
-  width:         300,
   formatter:     'Translate',
   formatterOpts: { prefix: 'featureFlags.description' },
 };

package/config/types.js

@@ -79,7 +79,8 @@ export const WORKLOAD_TYPES = {
   JOB:                    'batch.job',
   STATEFUL_SET:           'apps.statefulset',
   REPLICA_SET:            'apps.replicaset',
-  REPLICATION_CONTROLLER: 'replicationcontroller'
+  REPLICATION_CONTROLLER: 'replicationcontroller',
+  POD:                    'pod'
 };
 
 const {
@@ -267,30 +268,9 @@ export const VIRTUAL_TYPES = {
 
 // harvester
 export const HCI = {
-  VM:                 'kubevirt.io.virtualmachine',
-  VMI:                'kubevirt.io.virtualmachineinstance',
-  VMIM:               'kubevirt.io.virtualmachineinstancemigration',
-  VM_TEMPLATE:        'harvesterhci.io.virtualmachinetemplate',
-  VM_VERSION:         'harvesterhci.io.virtualmachinetemplateversion',
-  IMAGE:              'harvesterhci.io.virtualmachineimage',
-  SSH:                'harvesterhci.io.keypair',
-  VOLUME:             'harvesterhci.io.volume',
-  USER:               'harvesterhci.io.user',
-  SETTING:            'harvesterhci.io.setting',
-  UPGRADE:            'harvesterhci.io.upgrade',
-  BACKUP:             'harvesterhci.io.virtualmachinebackup',
-  RESTORE:            'harvesterhci.io.virtualmachinerestore',
-  NODE_NETWORK:       'network.harvesterhci.io.nodenetwork',
-  CLUSTER_NETWORK:    'network.harvesterhci.io.clusternetwork',
-  SUPPORT_BUNDLE:     'harvesterhci.io.supportbundle',
-  NETWORK_ATTACHMENT: 'harvesterhci.io.networkattachmentdefinition',
-  CLUSTER:            'harvesterhci.io.management.cluster',
-  DASHBOARD:          'harvesterhci.io.dashboard',
-  BLOCK_DEVICE:       'harvesterhci.io.blockdevice',
-  CLOUD_TEMPLATE:     'harvesterhci.io.cloudtemplate',
-  HOST:               'harvesterhci.io.host',
-  VERSION:            'harvesterhci.io.version',
-  MANAGED_CHART:      'harvesterhci.io.managedchart',
+  CLUSTER:   'harvesterhci.io.management.cluster',
+  DASHBOARD: 'harvesterhci.io.dashboard',
+  IMAGE:     'harvesterhci.io.virtualmachineimage',
 };
 
 export const VIRTUAL_HARVESTER_PROVIDER = 'harvester';

package/core/plugin-routes.ts

@@ -16,6 +16,7 @@ type RouteInstallHistory = {
 
 export class PluginRoutes {
   router: Router;
+  pluginRoutes: RouteConfig[] = [];
 
   replacedRoutes: RouteInstallHistory = {};
 
@@ -53,7 +54,7 @@ export class PluginRoutes {
 
             break;
           } else {
-            // Need to updare the previous item so that when it is removed, it restores the correct route
+            // Need to update the previous item so that when it is removed, it restores the correct route
             const previous = info[index - 1];
 
             previous.route = savedRoute.route;
@@ -65,14 +66,24 @@ export class PluginRoutes {
       }
     });
 
+    // Remove routes from pluginRoutes, update matcher (to avoid dupes when re-adding plugin routes)
+    this.pluginRoutes = this.pluginRoutes.filter(pR => !plugin.routes.find((r: any) => pR === r.route));
+    this.updateMatcher([], [
+      ...this.pluginRoutes,
+      ...(this.router.options.routes || [])
+    ]);
+
+    // Restore appropriate routes
     if (restore.length > 0) {
       this.addRoutes(null, restore);
     }
   }
 
   public addRoutes(plugin: any, routes: RouteInfo[]) {
-    const appRoutes = this.router.options.routes || [];
-    let replaced = 0;
+    const allRoutes = [
+      ...this.pluginRoutes,
+      ...(this.router.options.routes || [])
+    ];
 
     // Need to take into account if routes are being replaced
     // Despite what the docs say, routes are not replaced, so we use a workaround
@@ -82,18 +93,18 @@ export class PluginRoutes {
       let existing: any;
 
       if (r.parent) {
-        const pExisting = appRoutes.findIndex((route: any) => route.name === r.parent) as any;
+        const pExisting = allRoutes.findIndex((route: any) => route.name === r.parent) as any;
         const path = `${ pExisting.path }${ r.route.path }`;
 
         // TODO: Validate
-        existing = appRoutes.findIndex((route: any) => route.path === path);
+        existing = allRoutes.findIndex((route: any) => route.path === path);
       } else {
         // no parent route
-        existing = appRoutes.findIndex((route: any) => route.name === r.route.name);
+        existing = allRoutes.findIndex((route: any) => route.name === r.route.name);
       }
 
       if (existing >= 0) {
-        const existingRoute = appRoutes[existing];
+        const existingRoute = allRoutes[existing];
 
         // Store the route so we can restore it on uninstall
         if (plugin && existingRoute?.name) {
@@ -107,32 +118,33 @@ export class PluginRoutes {
           });
         }
 
-        appRoutes.splice(existing, 1);
-        replaced++;
+        allRoutes.splice(existing, 1);
       }
     });
 
-    const newRouter: Router = replaced > 0 ? new Router({
+    this.updateMatcher(routes, allRoutes);
+  }
+
+  private updateMatcher(newRoutes: RouteInfo[], allRoutes: RouteConfig[]) {
+    // Note - Always use a new router and replace the existing router's matching
+    // Using the existing router and adding routes to it will force nuxt middleware (specifically authenticated on default layout) to
+    // execute many times (nuxt middleware boils down to router.beforeEach). This issue was seen refreshing in a harvester cluster with a
+    // dynamically loaded cluster
+    const newRouter: Router = new Router({
       mode:   'history',
-      routes: appRoutes
-    }) : this.router;
+      routes: allRoutes
+    });
 
-    routes.forEach((r: any) => {
+    newRoutes.forEach((r: any) => {
       if (r.parent) {
         newRouter.addRoute(r.parent, r.route);
       } else {
         newRouter.addRoute(r.route);
       }
+      this.pluginRoutes.push(r.route);
     });
 
-    if (replaced > 0) {
-      // Typing is incorrect
-      (this.router as any).matcher = (newRouter as any).matcher;
-    }
-
-    // If we replaced any routes, then we should reload on uninstall
-    if (plugin) {
-      plugin.reloadOnUninstall = replaced > 0;
-    }
+    // Typing is incorrect
+    (this.router as any).matcher = (newRouter as any).matcher;
   }
 }

package/core/plugin.ts

@@ -1,6 +1,6 @@
 import { RouteConfig } from 'vue-router';
 import { DSL as STORE_DSL } from '@shell/store/type-map';
-import { IPlugin } from './types';
+import { CoreStoreInit, IPlugin } from './types';
 import coreStore, { coreStoreModule, coreStoreState } from '@shell/plugins/dashboard-store';
 import {
   PluginRouteConfig, RegisterStore, UnregisterStore, CoreStoreSpecifics, CoreStoreConfig, OnNavToPackage, OnNavAwayFromPackage, OnLogOut
@@ -23,6 +23,8 @@ export class Plugin implements IPlugin {
   // Plugin metadata (plugin package.json)
   public _metadata: any = {};
 
+  public _validators: {[key:string]: Function } = {}
+
   // Is this a built-in plugin (bundled with the application)
   public builtin = false;
 
@@ -43,6 +45,14 @@ export class Plugin implements IPlugin {
     this.name = this._metadata.name || this.id;
   }
 
+  get validators() {
+    return this._validators;
+  }
+
+  set validators(vals: {[key:string]: Function }) {
+    this._validators = vals;
+  }
+
   // Track which products the plugin creates
   DSL(store: any, productName: string) {
     const storeDSL = STORE_DSL(store, productName);
@@ -104,13 +114,14 @@ export class Plugin implements IPlugin {
     });
   }
 
-  addDashboardStore(storeName: string, storeSpecifics: CoreStoreSpecifics, config: CoreStoreConfig) {
+  addDashboardStore(storeName: string, storeSpecifics: CoreStoreSpecifics, config: CoreStoreConfig, init?: CoreStoreInit) {
     this.stores.push({
       storeName,
       register: () => {
         return coreStore(
           this.storeFactory(storeSpecifics, config),
           config,
+          init,
         );
       },
       unregister: (store: any) => {
@@ -167,7 +178,8 @@ export class Plugin implements IPlugin {
     const nparts = name.split('/');
 
     // Support components in a sub-folder - component_name/index.vue (and ignore other componnets in that folder)
-    if (nparts.length === 2) {
+    // Allow store-scoped models via sub-folder - pkgname/models/storename/type will be registered as storename/type to avoid overwriting shell/models/type
+    if (nparts.length === 2 && type !== 'models') {
       if (nparts[1] !== 'index') {
         return;
       }

package/core/plugins-loader.js

@@ -1,4 +1,5 @@
 import Vue from 'vue';
+import $ from 'jquery';
 import JSZip from 'jszip';
 import jsyaml from 'js-yaml';
 
@@ -25,6 +26,7 @@ export default function({
     window.Vue = Vue;
 
     // Global libraries - allows us to externalise these to reduce package bundle size
+    window.$ = $;
     window.__jszip = JSZip;
     window.__jsyaml = jsyaml;
   }