@rancher/shell 0.5.3 → 1.2.1

package/config/settings.ts

@@ -77,7 +77,6 @@ export const SETTING = {
   FAVICON:                              'ui-favicon',
   UI_PERFORMANCE:                       'ui-performance',
   UI_CUSTOM_LINKS:                      'ui-custom-links',
-  UI_SUPPORTED_K8S_VERSIONS:            'ui-k8s-supported-versions-range',
   /**
    * Allow the backend to force a light/dark theme. Used in non-rancher world and results in the theme used
    * both pre and post log in. If not present defaults to the usual process
@@ -92,7 +91,15 @@ export const SETTING = {
   /**
    * manage rancher repositories in extensions (official, partners repos)
    */
-  ADD_EXTENSION_REPOS_BANNER_DISPLAY:   'display-add-extension-repos-banner'
+  ADD_EXTENSION_REPOS_BANNER_DISPLAY:   'display-add-extension-repos-banner',
+  /**
+   * User retention settings
+   */
+  USER_RETENTION_CRON:                  'user-retention-cron',
+  USER_RETENTION_DRY_RUN:               'user-retention-dry-run',
+  USER_LAST_LOGIN_DEFAULT:              'user-last-login-default',
+  DISABLE_INACTIVE_USER_AFTER:          'disable-inactive-user-after',
+  DELETE_INACTIVE_USER_AFTER:           'delete-inactive-user-after',
 };
 
 // These are the settings that are allowed to be edited via the UI

package/config/store.js

@@ -40,7 +40,7 @@ let store = {};
 
   // If the environment supports hot reloading...
 
-  if (module.hot) {
+  if (process.client && module.hot) {
     // Whenever any Vuex module is updated...
     module.hot.accept([
       '../store/action-menu.js',

package/config/system-namespaces.js

@@ -12,7 +12,4 @@ export default [
   'linkerd',
   'security-scan',
   'tekton-pipelines',
-  'cis-operator-system',
-  'istio-system',
-  'longhorn-system',
 ];

package/config/table-headers.js

@@ -398,6 +398,33 @@ export const USER_PROVIDER = {
   sort:        'providerDisplay',
 };
 
+export const USER_LAST_LOGIN = {
+  name:          'user-last-login',
+  labelKey:      'tableHeaders.userLastLogin',
+  value:         'userLastLogin',
+  formatter:     'LiveDate',
+  formatterOpts: { addSuffix: true },
+  sort:          'userLastLogin',
+};
+
+export const USER_DISABLED_IN = {
+  name:          'user-disabled-in',
+  labelKey:      'tableHeaders.userDisabledIn',
+  value:         'userDisabledInDisplay',
+  formatter:     'LiveDate',
+  formatterOpts: { isCountdown: true },
+  sort:          'userDisabledIn',
+};
+
+export const USER_DELETED_IN = {
+  name:          'user-deleted-in',
+  labelKey:      'tableHeaders.userDeletedIn',
+  value:         'userDeletedIn',
+  formatter:     'LiveDate',
+  formatterOpts: { isCountdown: true },
+  sort:          'userDeletedIn',
+};
+
 export const USER_ID = {
   name:          'user-id',
   labelKey:      'tableHeaders.userId',
@@ -706,29 +733,6 @@ export const FLEET_SUMMARY = {
   width:     100,
 };
 
-export const FLEET_REPO_CLUSTER_SUMMARY = {
-  name:      'clusterSummary',
-  labelKey:  'tableHeaders.clusterResources',
-  value:     'status.resourceCounts',
-  sort:      false,
-  search:    false,
-  formatter: 'FleetClusterSummaryGraph',
-  align:     'center',
-  width:     100,
-};
-
-export const FLEET_REPO_PER_CLUSTER_STATE = {
-  name:          'perClusterState',
-  labelKey:      'tableHeaders.repoPerClusterState',
-  tooltip:       'tableHeaders.repoPerClusterStateTooltip',
-  sort:          ['stateSort', 'nameSort'],
-  width:         100,
-  default:       'unknown',
-  formatter:     'BadgeStateFormatter',
-  formatterOpts: { arbitrary: true }
-
-};
-
 export const APP_SUMMARY = {
   name:      'summary',
   labelKey:  'tableHeaders.resources',
@@ -994,30 +998,6 @@ export const FLEET_BUNDLE_TYPE = {
   width:    100,
 };
 
-export const FLEET_REPO_CLUSTERS_READY = {
-  name:     'clustersReady',
-  labelKey: 'tableHeaders.clustersReady',
-  value:    'status.readyClusters',
-  sort:     'status.readyClusters',
-  search:   false,
-};
-
-export const FLEET_REPO_TARGET = {
-  name:     'target',
-  labelKey: 'tableHeaders.target',
-  value:    'targetInfo.modeDisplay',
-  sort:     ['targetInfo.modeDisplay', 'targetInfo.cluster', 'targetInfo.clusterGroup'],
-
-};
-
-export const FLEET_REPO = {
-  name:     'repo',
-  labelKey: 'tableHeaders.repo',
-  value:    'repoDisplay',
-  sort:     'repoDisplay',
-  search:   ['spec.repo', 'status.commit'],
-};
-
 export const UI_PLUGIN_CATALOG = [
   {
     name:          'state',

package/config/types.js

@@ -53,6 +53,8 @@ export const NODE = 'node';
 export const NETWORK_POLICY = 'networking.k8s.io.networkpolicy';
 export const POD = 'pod';
 export const POD_DISRUPTION_BUDGET = 'policy.poddisruptionbudget';
+export const PSP = 'policy.podsecuritypolicy';
+export const PSPS = 'policy.podsecuritypolicies';
 export const PV = 'persistentvolume';
 export const PVC = 'persistentvolumeclaim';
 export const RESOURCE_QUOTA = 'resourcequota';
@@ -181,6 +183,8 @@ export const MANAGEMENT = {
   TOKEN:                         'management.cattle.io.token',
   GLOBAL_ROLE:                   'management.cattle.io.globalrole',
   GLOBAL_ROLE_BINDING:           'management.cattle.io.globalrolebinding',
+  POD_SECURITY_POLICY_TEMPLATE:  'management.cattle.io.podsecuritypolicytemplate',
+  PSP_TEMPLATE_BINDING:          'management.cattle.io.podsecuritypolicytemplateprojectbinding',
   PSA:                           'management.cattle.io.podsecurityadmissionconfigurationtemplate',
   MANAGED_CHART:                 'management.cattle.io.managedchart',
   USER_NOTIFICATION:             'management.cattle.io.rancherusernotification',
@@ -287,6 +291,7 @@ export const HCI = {
   CLUSTER:          'harvesterhci.io.management.cluster',
   DASHBOARD:        'harvesterhci.io.dashboard',
   IMAGE:            'harvesterhci.io.virtualmachineimage',
+  VGPU_DEVICE:      'devices.harvesterhci.io.vgpudevice',
   SETTING:          'harvesterhci.io.setting',
   HARVESTER_CONFIG: 'rke-machine-config.cattle.io.harvesterconfig',
 };

package/config/uiplugins.js

@@ -1,7 +1,7 @@
 import semver from 'semver';
 
 // Version of the plugin API supported
-export const UI_PLUGIN_API_VERSION = '1.1.0';
+export const UI_PLUGIN_API_VERSION = '1.2.0';
 export const UI_PLUGIN_HOST_APP = 'rancher-manager';
 
 export const UI_PLUGIN_BASE_URL = '/api/v1/namespaces/cattle-ui-plugin-system/services/http:ui-plugin-operator:80/proxy';

package/core/plugin-helpers.js

@@ -7,11 +7,13 @@ import {
 import { getProductFromRoute } from '@shell/middleware/authenticated';
 import { isEqual } from '@shell/utils/object';
 
-function checkRouteProduct($route, locationConfigParam) {
-  const product = getProductFromRoute($route);
+function checkRouteProduct({ name, params, query }, locationConfigParam) {
+  const product = getProductFromRoute({
+    name, params, query
+  });
 
   // alias for the homepage
-  if (locationConfigParam === 'home' && $route.name === 'home') {
+  if (locationConfigParam === 'home' && name === 'home') {
     return true;
   } else if (locationConfigParam === product) {
     return true;

package/core/plugin-routes.ts

@@ -6,8 +6,20 @@ interface RouteInfo {
   route: RouteConfig;
 }
 
+interface RouteInstallInfo {
+  plugin: string;
+  route: RouteConfig;
+}
+
+type RouteInstallHistory = {
+  [route: string]: RouteInstallInfo[]
+}
+
 export class PluginRoutes {
   router: Router;
+  pluginRoutes: RouteConfig[] = [];
+
+  replacedRoutes: RouteInstallHistory = {};
 
   constructor(router: Router) {
     this.router = router;
@@ -22,25 +34,70 @@ export class PluginRoutes {
     });
   }
 
-  public addRoutes(plugin: any, newRouteInfos: RouteInfo[]) {
+  // Ensure we put back any routes that the plugin that is being uninstalled added
+  public uninstall(plugin: any) {
+    // List of routes we need to restore
+    const restore: RouteInfo[] = [];
+
+    Object.keys(this.replacedRoutes).forEach((routeName) => {
+      const info = this.replacedRoutes[routeName];
+
+      for (let index = 0; index < info.length; index++) {
+        const savedRoute = info[index];
+
+        if (savedRoute.plugin === plugin.id) {
+          // The plugin that is being uninstalled replaced an existing route that we will restore
+          if (index === 0) {
+            // Need to restore the previous route, since the plugin owned the active route
+            info.shift();
+
+            restore.push({ route: savedRoute.route });
+
+            break;
+          } else {
+            // 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;
+            info.splice(index, 1);
+
+            break;
+          }
+        }
+      }
+    });
+
+    // 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 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
     // Remove all routes that are being replaced
-    const newRoutes = newRouteInfos.map((ri) => ri.route);
-
-    this.forEachNestedRoutes(newRoutes, (r: RouteConfig) => {
+    routes.forEach((r: RouteInfo) => {
       // Patch colliding legacy routes that start /:product
-      if (r.path?.startsWith('/:product')) {
+      if (r.route.path?.startsWith('/:product')) {
         // Legacy pattern used by extensions - routes may collide, so modify them not to
         let productName;
 
         // If the route has a name (which is always the case for the extensions we have written), use it to get the product name
-        if (r.name) {
-          const nameParts = r.name.split('-');
+        if (r.route.name) {
+          const nameParts = r.route.name.split('-');
 
           // First part of the route name is the product name
           productName = nameParts[0];
@@ -50,40 +107,74 @@ export class PluginRoutes {
         productName = productName || plugin.name;
 
         // Replace the path - removing :product and using the actual product name instead - this avoids route collisions
-        r.path = `/${ productName }${ r.path.substr(9) }`;
-        r.meta = r.meta || {};
+        r.route.path = `/${ productName }${ r.route.path.substr(9) }`;
+        r.route.meta = r.route.meta || {};
+
+        r.route.meta.product = r.route.meta.product || productName;
+      }
+
+      // See if the route exists
+      let existing: any;
+
+      if (r.parent) {
+        const pExisting = allRoutes.findIndex((route: any) => route.name === r.parent) as any;
+        const path = `${ pExisting.path }${ r.route.path }`;
+
+        // TODO: Validate
+        existing = allRoutes.findIndex((route: any) => route.path === path);
+      } else {
+        // no parent route
+        existing = allRoutes.findIndex((route: any) => route.name === r.route.name);
+      }
+
+      if (existing >= 0) {
+        const existingRoute = allRoutes[existing];
+
+        // Store the route so we can restore it on uninstall
+        if (plugin && existingRoute?.name) {
+          if (!this.replacedRoutes[existingRoute.name]) {
+            this.replacedRoutes[existingRoute.name] = [];
+          }
+
+          this.replacedRoutes[existingRoute.name].unshift({
+            plugin: plugin.id,
+            route:  existingRoute
+          });
+        }
 
-        r.meta.product = r.meta.product || productName;
+        allRoutes.splice(existing, 1);
       }
     });
 
-    this.updateMatcher(newRouteInfos, allRoutes);
+    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 to
+    // 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 pluginRoutesWithParents: any[] = [];
     const orderedPluginRoutes: any[] = [];
 
-    // separate plugin routes that have parent and not, you want to push the new routes in REVERSE order to the front of the existing list so that the order of routes specified by the extension is preserved
-    newRoutes.reverse().forEach((r: any) => {
+    // separate plugin routes that have parent and not
+    newRoutes.forEach((r: any) => {
       let foundParentRoute;
 
       if (r.parent) {
-        foundParentRoute = this.findInNestedRoutes(allRoutes, (route: RouteConfig) => route.name === r.parent);
+        foundParentRoute = allRoutes.find((route) => route.name === r.parent);
 
         if (foundParentRoute) {
-          foundParentRoute.children = foundParentRoute?.children || [];
-          foundParentRoute.children.unshift(r.route);
+          pluginRoutesWithParents.push(r);
         }
       }
 
       if (!foundParentRoute) {
-        orderedPluginRoutes.unshift(r.route);
+        orderedPluginRoutes.push(r.route);
       }
+
+      this.pluginRoutes.push(r.route);
     });
 
     const newRouter: Router = new Router({
@@ -91,45 +182,12 @@ export class PluginRoutes {
       routes: [...orderedPluginRoutes, ...allRoutes]
     });
 
-    (this.router as any).matcher = (newRouter as any).matcher;
-  }
-
-  /**
-   * Traverse the entire tree of nested routes
-   *
-   * @param routes The routes we wish to traverse through
-   * @param fn -> Return true if you'd like to break the loop early (small)
-   * @returns {@boolean} -> Returns true if breaking early
-   */
-  private forEachNestedRoutes(routes: RouteConfig[] = [], fn: (route: RouteConfig) => boolean | undefined | void) {
-    for (let i = 0; i < routes.length; ++i) {
-      const route = routes[i];
-      const result = fn(route);
-
-      if (result || this.forEachNestedRoutes(route.children, fn)) {
-        return true;
-      }
-    }
-  }
-
-  /**
-   * Find a route that matches the criteria defined by fn.
-   *
-   * @param routes The routes we wish to search through
-   * @param fn -> Returns true if the passed in route matches the expected criteria
-   * @returns The found route or undefined
-   */
-  private findInNestedRoutes(routes: RouteConfig[] = [], fn: (route: RouteConfig) => boolean): RouteConfig | undefined {
-    let found: any;
-
-    this.forEachNestedRoutes(routes, (route) => {
-      if (fn(route)) {
-        found = route;
-
-        return true;
-      }
+    // handle plugin routes with parent
+    pluginRoutesWithParents.forEach((r: any) => {
+      newRouter.addRoute(r.parent, r.route);
     });
 
-    return found;
+    // Typing is incorrect
+    (this.router as any).matcher = (newRouter as any).matcher;
   }
 }

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;
 
@@ -119,27 +120,12 @@ export class Plugin implements IPlugin {
     const parent: string | undefined = hasParent ? parentOrRoute as string : undefined;
     const route: RouteConfig = hasParent ? optionalRoute as RouteConfig : parentOrRoute as RouteConfig;
 
-    let parentOverride;
-
-    if (!parent) {
-      // TODO: Inspecting the route object in the browser clearly indicates it's not a RouteConfig. The type needs to be changed or at least extended.
-      const typelessRoute: any = route;
-
-      if (typelessRoute.component?.layout) {
-        console.warn(`Layouts have been deprecated. We still have parent routes which use the same name and styling as the previous layouts. \n\nFound a component ${ typelessRoute.component.name } with the '${ typelessRoute.component.layout }' layout specified `); // eslint-disable-line no-console
-        parentOverride = typelessRoute.component.layout.toLowerCase();
-      } else {
-        console.warn(`Layouts have been deprecated. We still have parent routes which use the same name and styling as the previous layouts. You should specify a parent, we're currently setting the parent to 'default'`); // eslint-disable-line no-console
-        parentOverride = 'default';
-      }
-    }
-
     route.meta = {
       ...route?.meta,
       pkg: this.name,
     };
 
-    this.routes.push({ parent: parentOverride || parent, route });
+    this.routes.push({ parent, route });
   }
 
   private _addUIConfig(type: string, where: string, when: LocationConfig | string, config: any) {
@@ -282,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-loader.js

@@ -20,12 +20,14 @@ export default function({
     dynamicLoader.default($plugin);
   }
 
-  // The libraries we build have Vue externalised, so we need to expose Vue as a global for
-  // them to pick up - see: https://cli.vuejs.org/guide/build-targets.html#library
-  window.Vue = Vue;
+  if (process.client) {
+    // The libraries we build have Vue externalised, so we need to expose Vue as a global for
+    // them to pick up - see: https://cli.vuejs.org/guide/build-targets.html#library
+    window.Vue = Vue;
 
-  // Global libraries - allows us to externalise these to reduce package bundle size
-  window.$ = $;
-  window.__jszip = JSZip;
-  window.__jsyaml = jsyaml;
+    // Global libraries - allows us to externalise these to reduce package bundle size
+    window.$ = $;
+    window.__jszip = JSZip;
+    window.__jsyaml = jsyaml;
+  }
 }

package/core/plugins.js

@@ -222,6 +222,9 @@ export default function({
         promises.push(...this.removeTypeFromStore(store, 'management', Object.keys(plugin.types.models)));
       }
 
+      // Uninstall routes
+      pluginRoutes.uninstall(plugin);
+
       // Call plugin uninstall hooks
       plugin.uninstallHooks.forEach((fn) => fn(plugin, this.internal()));
 

package/core/types-provisioning.ts

@@ -60,7 +60,6 @@ export interface IClusterProvisioner {
 
   /**
    * Unique ID of the Cluster Provisioner
-   * If this overlaps with the name of an existing provisioner (seen in the type query param while creating a cluster) this provisioner will overwrite the built-in ui
    */
   id: string;
 
@@ -116,12 +115,6 @@ export interface IClusterProvisioner {
    */
   tag?: string;
 
-  /**
-   * Also show the provider card in the cluster importing flow
-   * If not set, the card will only be shown in the cluster creation page
-   */
-  showImport?: boolean
-
   /* --------------------------------------------------------------------------------------
    * Custer Details View
    * --------------------------------------------------------------------------------------- */

package/creators/app/init

@@ -34,25 +34,6 @@ if (args.length === 3) {
   fs.ensureDirSync(appFolder);
 }
 
-let addGitlabWorkflow = false;
-
-// Check for Gitlab integration option
-if ( args.length > 3 ) {
-  for (let i = 3; i < args.length; i++) {
-    switch (args[i]) {
-    case '-l':
-      addGitlabWorkflow = true;
-      break;
-    default:
-      break;
-    }
-  }
-}
-
-if ( addGitlabWorkflow ) {
-  files.push('.gitlab-ci.yml');
-}
-
 // Check that there is a package file
 
 let setName = false;

package/detail/fleet.cattle.io.bundle.vue

@@ -38,7 +38,7 @@ export default {
       if (this.hasRepoLabel) {
         const bundleResourceIds = this.bundleResourceIds;
 
-        return this.repo?.status?.resources?.filter((resource) => {
+        return this.repo?.status?.resources.filter((resource) => {
           return bundleResourceIds.includes(resource.name);
         });
       } else if (this.value?.spec?.resources?.length) {

package/detail/fleet.cattle.io.cluster.vue

@@ -8,7 +8,7 @@ import { MANAGEMENT, FLEET } from '@shell/config/types';
 import { FLEET as FLEET_LABELS } from '@shell/config/labels-annotations';
 
 export default {
-  name: 'FleetDetailCluster',
+  name: 'DetailCluster',
 
   components: {
     Loading,
@@ -36,8 +36,6 @@ export default {
     this.allRepos = await this.$store.dispatch('management/findAll', { type: FLEET.GIT_REPO });
 
     await this.$store.dispatch('management/findAll', { type: FLEET.WORKSPACE });
-
-    await this.$store.dispatch('management/findAll', { type: FLEET.BUNDLE_DEPLOYMENT });
   },
 
   data() {
@@ -45,13 +43,6 @@ export default {
   },
 
   computed: {
-    allBundleDeployments() {
-      return this.value.bundleDeployments;
-    },
-    clusterId() {
-      return this.value?.metadata?.labels[FLEET_LABELS.CLUSTER_NAME];
-    },
-
     repos() {
       return this.allRepos.filter((x) => {
         return x.targetClusters.includes(this.value);
@@ -85,7 +76,6 @@ export default {
         :weight="19"
       >
         <FleetRepos
-          :clusterId="clusterId"
           :rows="repos"
           :schema="repoSchema"
           :paging="true"