@rancher/shell 0.1.3 → 0.1.21

package/config/uiplugins.js

@@ -0,0 +1,117 @@
+import semver from 'semver';
+
+// Version of the plugin API supported
+export const UI_PLUGIN_API_VERSION = '1.0.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';
+
+export const UI_PLUGIN_NAMESPACE = 'cattle-ui-plugin-system';
+
+// Annotation name and value that indicate a chart is a UI plugin
+export const UI_PLUGIN_ANNOTATION_NAME = 'catalog.cattle.io/ui-component';
+export const UI_PLUGIN_ANNOTATION_VALUE = 'plugins';
+
+export const UI_PLUGIN_OPERATOR_CRD_CHART_NAME = 'ui-plugin-operator-crd';
+export const UI_PLUGIN_OPERATOR_CHART_NAME = 'ui-plugin-operator';
+
+export const UI_PLUGIN_CHARTS = [
+  UI_PLUGIN_OPERATOR_CHART_NAME,
+  UI_PLUGIN_OPERATOR_CRD_CHART_NAME,
+];
+
+// Expected chart repo name for the UI Plugins operator
+export const UI_PLUGIN_OPERATOR_REPO_NAME = 'rancher-charts';
+
+// Info for the Helm Chart Repository that we will add
+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';
+
+// Chart annotations
+export const UI_PLUGIN_CHART_ANNOTATIONS = {
+  RANCHER_VERSION:    'catalog.cattle.io/rancher-version',
+  EXTENSIONS_VERSION: 'catalog.cattle.io/ui-extenstions-version',
+  EXTENSIONS_HOST:    'catalog.cattle.io/ui-extenstions-host',
+};
+
+// Plugin Metadata properties
+export const UI_PLUGIN_METADATA = {
+  RANCHER_VERSION:    'rancherVersion',
+  EXTENSION_VERSION:  'extVersion',
+  EXTENSIONS_HOST:    'host',
+};
+
+export function isUIPlugin(chart) {
+  return !!chart?.versions.find((v) => {
+    return v.annotations && v.annotations[UI_PLUGIN_ANNOTATION_NAME] === UI_PLUGIN_ANNOTATION_VALUE;
+  });
+}
+
+export function uiPluginHasAnnotation(chart, name, value) {
+  return !!chart?.versions.find((v) => {
+    return v.annotations && v.annotations[name] === value;
+  });
+}
+
+// Should we load a plugin, based on the metadata returned by the backend?
+// Returns error key string or false
+export function shouldNotLoadPlugin(plugin, rancherVersion) {
+  if (!plugin.name || !plugin.version || !plugin.endpoint) {
+    return 'plugins.error.generic';
+  }
+
+  // Plugin specified a required extension API version
+  const requiredAPI = plugin.metadata?.[UI_PLUGIN_METADATA.EXTENSION_VERSION];
+
+  if (requiredAPI && !semver.satisfies(UI_PLUGIN_API_VERSION, requiredAPI)) {
+    return 'plugins.error.api';
+  }
+
+  // Host application
+  const requiredHost = plugin.metadata?.[UI_PLUGIN_METADATA.EXTENSIONS_HOST];
+
+  if (requiredHost && requiredHost !== UI_PLUGIN_HOST_APP) {
+    return 'plugins.error.host';
+  }
+
+  // Rancher version
+  if (rancherVersion) {
+    const requiredRancherVersion = plugin.metadata?.[UI_PLUGIN_METADATA.RANCHER_VERSION];
+
+    if (requiredRancherVersion && !semver.satisfies(rancherVersion, requiredRancherVersion)) {
+      return 'plugins.error.version';
+    }
+  }
+
+  return false;
+}
+
+// Can a chart version be used for this Rancher (based on the annotations on the chart)?
+export function isSupportedChartVersion(chartVersion, rancherVersion) {
+  // Plugin specified a required extension API version
+  const requiredAPI = chartVersion.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];
+
+  if (requiredHost && requiredHost !== UI_PLUGIN_HOST_APP) {
+    return false;
+  }
+
+  // Rancher version
+  if (rancherVersion) {
+    const requiredRancherVersion = chartVersion.annotations?.[UI_PLUGIN_CHART_ANNOTATIONS.RANCHER_VERSION];
+
+    if (requiredRancherVersion && !semver.satisfies(rancherVersion, requiredRancherVersion)) {
+      return false;
+    }
+  }
+
+  return true;
+}

package/config/version.js

@@ -0,0 +1,17 @@
+/**
+ * Store version data retrieved from the backend /rancherversion API
+ */
+let _versionData = { RancherPrime: 'false' };
+
+export function isRancherPrime() {
+  return _versionData.RancherPrime?.toLowerCase() === 'true';
+}
+
+export function getVersionData() {
+  return _versionData;
+}
+
+export function setVersionData(v) {
+  // Remove any properties on 'v' we don't want
+  _versionData = JSON.parse(JSON.stringify(v));
+}

package/content/docs/en-us/getting-started.md

@@ -72,11 +72,6 @@ As of version 2.6, Cluster Manager is no longer provided as a separate UI. The d
     <tr class="table-group">
       <td colspan="3">Global</td>
     </tr>
-    <tr>
-      <td>Apps</td>
-      <td>Global → Apps</td>
-      <td>Menu → Multi-cluster Apps → Apps</td>
-    </tr>
     <tr>
       <td>Settings</td>
       <td>Global → Settings</td>
@@ -100,7 +95,7 @@ As of version 2.6, Cluster Manager is no longer provided as a separate UI. The d
     <tr>
       <td>Pod Security Policies</td>
       <td>Global → Security → Pod Security Policies</td>
-      <td>Menu → Cluster Management → Advanced → Pod Security Policies</td>
+      <td>Menu → Cluster Management → Pod Security Policies</td>
     </tr>
     <!-- -->
     <tr class="table-group">
@@ -136,26 +131,11 @@ As of version 2.6, Cluster Manager is no longer provided as a separate UI. The d
       <td>(Cluster) → Tools → Notifiers</td>
       <td>Menu → (Cluster) → Legacy -> Notifiers</td>
     </tr>
-    <tr>
-      <td>Logging (V1)</td>
-      <td>(Cluster) → Tools → Logging</td>
-      <td>Menu → (Cluster) → Cluster Tools -> Logging (Legacy)</td>
-    </tr>
     <tr>
       <td>Monitoring (V1)</td>
       <td>(Cluster) → Tools → Monitoring</td>
       <td>Menu → (Cluster) → Cluster Tools -> Monitoring (Legacy)</td>
     </tr>
-    <tr>
-      <td>Istio (V1)</td>
-      <td>(Cluster) → Tools → Istio</td>
-      <td>Menu → (Cluster) → Cluster Tools -> Istio (Legacy)</td>
-    </tr>
-    <tr>
-      <td>CIS Scans (V1)</td>
-      <td>(Cluster) → Tools → CIS Scans</td>
-      <td>Menu → (Cluster) → Legacy -> CIS Scans</td>
-    </tr>
     <tr class="table-group">
       <td colspan="3">V1 Monitoring</td>
     <tr>
@@ -212,11 +192,6 @@ As of version 2.6, Cluster Manager is no longer provided as a separate UI. The d
       <td>(Cluster) → (Project) → Tools → Monitoring</td>
       <td>Menu → (Cluster) → Legacy → Project → (Project) → Monitoring</td>
     </tr>
-    <tr>
-      <td>Pipeline</td>
-      <td>(Cluster) → (Project) → Tools → Pipeline</td>
-      <td>Menu → (Cluster) → Legacy → Project → (Project) → Pipelines → Configuration</td>
-    </tr>
     <tr class="table-group">
       <td colspan="3">Other</td>
     </tr>

package/core/plugin.ts

@@ -45,6 +45,10 @@ export class Plugin implements IPlugin {
     this.name = this._metadata.name || this.id;
   }
 
+  get version() {
+    return this._metadata.version;
+  }
+
   get validators() {
     return this._validators;
   }
@@ -104,6 +108,14 @@ export class Plugin implements IPlugin {
     this.routes.push({ parent, route });
   }
 
+  setHomePage(component: any) {
+    this.addRoute({
+      name: 'home',
+      path: '/home',
+      component
+    });
+  }
+
   addUninstallHook(hook: Function) {
     this.uninstallHooks.push(hook);
   }

package/core/plugins.js

@@ -2,6 +2,7 @@ import { productsLoaded } from '@shell/store/type-map';
 import { clearModelCache } from '@shell/plugins/dashboard-store/model-loader';
 import { Plugin } from './plugin';
 import { PluginRoutes } from './plugin-routes';
+import { UI_PLUGIN_BASE_URL } from '@shell/config/uiplugins';
 
 const MODEL_TYPE = 'models';
 
@@ -16,9 +17,9 @@ export default function({
   let _lastLoaded = 0;
 
   // Track which plugin loaded what, so we can unload stuff
-  const plugins = {};
+  let plugins = {};
 
-  const pluginRoutes = new PluginRoutes(app.router);
+  let pluginRoutes = new PluginRoutes(app.router);
 
   inject('plugin', {
     // Plugins should not use these - but we will pass them in for now as a 2nd argument
@@ -35,6 +36,24 @@ export default function({
       return internal;
     },
 
+    // Load a plugin from a UI package
+    loadPluginAsync(plugin) {
+      const { name, version } = plugin;
+      const id = `${ name }-${ version }`;
+      let url;
+
+      if (plugin?.metadata?.direct === 'true') {
+        url = plugin.endpoint;
+      } else {
+        // See if the plugin has a main metadata property set
+        const main = plugin?.metadata?.main || `${ id }.umd.min.js`;
+
+        url = `${ UI_PLUGIN_BASE_URL }/${ name }/${ version }/plugin/${ main }`;
+      }
+
+      return this.loadAsync(id, url);
+    },
+
     // Load a plugin from a UI package
     loadAsync(id, mainFile) {
       return new Promise((resolve, reject) => {
@@ -140,6 +159,23 @@ export default function({
       }
     },
 
+    async logout() {
+      const all = Object.keys(plugins);
+
+      for (let i = 0; i < all.length; i++) {
+        const name = all[i];
+
+        try {
+          await this.removePlugin(name);
+        } catch (e) {
+          console.error('Error removing plugin', e); // eslint-disable-line no-console
+        }
+      }
+
+      plugins = {};
+      pluginRoutes = new PluginRoutes(app.router);
+    },
+
     // Remove the plugin
     async removePlugin(name) {
       const plugin = Object.values(plugins).find(p => p.name === name);

package/core/types.ts

@@ -73,6 +73,12 @@ export interface IPlugin {
   addRoute(route: RouteConfig): void;
   addRoute(parent: string, route: RouteConfig): void;
 
+  /**
+   * Set the component to use for the landing home page
+   * @param component Home page component
+   */
+  setHomePage(component: any): void;
+
   /**
    * Add routes to the Vue Router
    */

package/creators/app/{tsconfig.json → files/tsconfig.json}

@@ -33,7 +33,8 @@
       "@types/node",
       "@nuxt/types",
       "cypress",
-      "rancher"
+      "rancher",
+      "shell"
     ]
   },
   "exclude": [

package/creators/app/init

@@ -1,13 +1,12 @@
 #!/usr/bin/env node
 
-const fs = require('fs-extra');
 const path = require('path');
-const exec = require('child_process').exec;
+const fs = require('fs-extra');
 
 const targets = {
-  'dev': './node_modules/.bin/nuxt dev',
-  'nuxt': './node_modules/.bin/nuxt',
-  'build': './node_modules/.bin/nuxt build'
+  dev:   './node_modules/.bin/nuxt dev',
+  nuxt:  './node_modules/.bin/nuxt',
+  build: './node_modules/.bin/nuxt build'
 };
 
 const files = [
@@ -30,8 +29,8 @@ if (args.length == 3) {
   const folder = path.resolve('.');
 
   appFolder = path.join(folder, name);
-  console.log(`  Creating application folder: ${ appFolder}`);
-  fs.ensureDirSync(appFolder);  
+  console.log(`  Creating application folder: ${ appFolder }`);
+  fs.ensureDirSync(appFolder);
 }
 
 // Check that there is a package file
@@ -71,18 +70,23 @@ const creatorPkgData = fs.readFileSync(path.join(__dirname, 'package.json'));
 const creatorPkg = JSON.parse(creatorPkgData);
 
 pkg.dependencies['@rancher/shell'] = `^${ creatorPkg.version }`;
-pkg.dependencies['core-js'] = '^3.20.3';
-pkg.dependencies['css-loader'] = '4.3.0';
+
+// Rest of dependencies are in the _pkgs property of package.json - copy then across
+if (creatorPkg._pkgs) {
+  Object.keys(creatorPkg._pkgs).forEach((pkg) => {
+    pkg.dependencies[pkg] = creatorPkg._pkgs[pkg];
+  });
+}
 
 fs.writeFileSync(path.join(appFolder, 'package.json'), JSON.stringify(pkg, null, 2));
 
 // Copy base files
 files.forEach((file) => {
-  const src = path.join(__dirname, file);
+  const src = path.join(__dirname, 'files', file);
   const dest = path.join(appFolder, file);
 
   if (!fs.existsSync(dest)) {
-    console.log('  Adding file: ' + file);
+    console.log(`  Adding file: ${ file }`);
 
     const folder = path.dirname(file);
 
@@ -93,9 +97,4 @@ files.forEach((file) => {
   }
 });
 
-// require("child_process").spawn('yarn', ['install'], {
-//   cwd: process.cwd(),
-//   stdio: "inherit"
-// });
-
-console.log('');
+console.log('');

package/creators/app/package.json

@@ -13,6 +13,12 @@
   "engines": {
     "node": ">=12"
   },
+  "_requires": [
+    "core-js",
+    "css-loader",
+    "@types/lodash",
+    "@rancher/components"
+  ],
   "dependencies": {
     "fs-extra": "^10.0.0"
   }

package/creators/pkg/{tsconfig.json → files/tsconfig.json}

@@ -16,12 +16,16 @@
     "typeRoots": [
       "../../node_modules",
       "../../node_modules/@rancher/shell/types"
-    ],
+    ],    
     "types": [
       "node",
       "webpack-env",
+      "@types/node",
+      "@types/jest",
+      "@types/lodash",
       "@nuxt/types",
-      "rancher"
+      "rancher",
+      "shell"
     ],
     "lib": [
       "esnext",
@@ -30,24 +34,21 @@
       "scripthost"
     ],
     "paths": {
-      "@shell/core/*": [
-        "../../node_modules/@rancher/shell/core/*"
-      ],
-      "@shell/config/*": [
-        "../../node_modules/@rancher/shell/config/*"
+      "@shell/*": [
+        "../../node_modules/@rancher/shell/*"
       ],
-      "@shell/store/*": [
-        "../../node_modules/@rancher/shell/store/*"
+      "@components/*": [
+        "@rancher/components/*"
       ]
     }
   },
   "include": [
     "**/*.ts",
+    "**/*.d.ts",
     "**/*.tsx",
-    "**/*.vue",
-    "../../node_modules/@rancher/shell/core/types.ts"
+    "**/*.vue"
   ],
   "exclude": [
-    "node_modules"
+    "../../node_modules"
   ]
 }

package/creators/pkg/init

@@ -95,7 +95,7 @@ if (addTypeFolders) {
 
 // Copy base files
 files.forEach((file) => {
-  const src = path.join(__dirname, file);
+  const src = path.join(__dirname, 'files', file);
   const dest = path.join(path.join(pkgFolder, file));
 
   if (!fs.existsSync(dest)) {

package/creators/update/init

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const fs = require('fs-extra');
+const { spawnSync } = require('child_process');
+
+const scriptFolder = __dirname;
+const dest = path.resolve('.');
+
+// Remove first two args
+let args = process.argv;
+args.splice(0, 2);
+
+const res = spawnSync(`${__dirname}/upgrade`, args, {
+  cwd: dest,
+  shell: false,
+  stdio: [ 'ignore', process.stdout, process.stderr ],
+});
+
+if (res.status !== 0) {
+  process.exit(res.status);
+}
+
+// Read the existing package.json
+let rawdata = fs.readFileSync(path.join(dest, 'package.json'));
+const appPackage = JSON.parse(rawdata);
+
+// Read the package.json from the app creator
+rawdata = fs.readFileSync(path.join(scriptFolder, 'app', 'package.json'));
+const latestPackage = JSON.parse(rawdata);
+
+// Read the package.json from the upgrade creator
+rawdata = fs.readFileSync(path.join(scriptFolder, 'package.json'));
+const upgradePackage = JSON.parse(rawdata);
+
+// Update dependency versions to match the latest from the creator
+Object.keys(latestPackage.dependencies).forEach((key) => {
+  const version = latestPackage.dependencies[key];
+
+  appPackage.dependencies[key] = version;
+});
+
+// Update the version of @rancher/shell
+const shellVersion = upgradePackage.version;
+
+appPackage.dependencies['@rancher/shell'] = shellVersion;
+
+fs.writeFileSync(path.join(dest, 'package.json'), JSON.stringify(appPackage, null, 2));
+
+spawnSync(`yarn`, ['install'], {
+  cwd: dest,
+  shell: false,
+  stdio: [ 'ignore', process.stdout, process.stderr ],
+});

package/creators/update/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@rancher/create-update",
+  "description": "Rancher UI Update helper",
+  "version": "0.0.0",
+  "license": "Apache-2.0",
+  "author": "SUSE",
+  "private": false,
+  "bin": "./init",
+  "files": [
+    "**/*.*",
+    "init",
+    "upgrade"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "dependencies": {
+    "fs-extra": "^10.0.0"
+  }
+}

package/creators/update/upgrade

@@ -0,0 +1,56 @@
+#!/usr/bin/env sh
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+echo "Upgrading Rancher Shell"
+
+# Get the version number from the package.json file
+VERSION=$(node -p -e "require('${SCRIPT_DIR}/package.json').version")
+
+echo "Updating to version: ${VERSION}"
+echo ""
+
+FORCE="false"
+
+if [ "$1" == "-f" ]; then
+  FORCE="true"
+fi
+
+# Check for a clean git repository
+if [ ! -d ".git" ] && [ "${FORCE}" == "false" ]; then
+  echo "Not runnning in a git repository. Re-run with -f to ignore this check"
+  echo "Note: This action will update yuor files - running in a git repsository will ensure you have visibility over changes made"
+  exit 1 
+fi
+
+if [[ $(git diff --stat) != '' ]] && [ "${FORCE}" == "false" ]; then
+  echo "Git repository is not clean. Re-run with -f to ignore this check"
+  echo "Note: This action will update yuor files - running in a clean git repsository will ensure you have visibility over changes made"
+  exit 1 
+fi
+
+# Check this is a Rancher Extension
+if [ ! -f "./package.json" ]; then
+  echo "Can't find package.json - check you're running from the correct folder"
+  exit 1 
+fi
+
+HAS_SHELL=$(grep "\"@rancher/shell\"" package.json -c )
+if [ "${HAS_SHELL}" != "1" ]; then
+  echo "package.json does not reference @rancher/shell - check you're running from the correct folder"
+  exit 1 
+fi
+
+# Copy files for the top-level folder (from the app creator)
+cp ${SCRIPT_DIR}/app/files/* .
+
+# Go through each folder in the pkg folder and update their files
+for pkg in ./pkg/*
+do
+  if [ -d "${pkg}" ]; then
+    pkgName=$(basename $pkg)
+    echo "Updating package ${pkgName}"
+
+    cp ${SCRIPT_DIR}/pkg/files/* ${pkg}
+  fi
+done

package/creators/update/yarn-error.log

@@ -0,0 +1,54 @@
+Arguments: 
+  /usr/local/bin/node /usr/local/Cellar/yarn/1.22.11/libexec/bin/yarn.js add @rancher/pkg@0.0.0
+
+PATH: 
+  /Users/nwm/.gem/ruby/3.1.2/bin:/Users/nwm/.rubies/ruby-3.1.2/lib/ruby/gems/3.1.0/bin:/Users/nwm/.rubies/ruby-3.1.2/bin:/Users/nwm/.deno/bin:/usr/local/sbin:/opt/local/bin:/opt/local/sbin:/Users/nwm/.rd/bin:/Users/nwm/go/bin:/usr/local/bin:/Users/nwm/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/go/bin:/usr/local/MacGPG2/bin:/Library/Apple/usr/bin:/Users/nwm/.deno/bin:/usr/local/sbin:/Users/nwm/google-cloud-sdk/bin:/opt/local/bin:/opt/local/sbin:/Users/nwm/.rd/bin:/Users/nwm/go/bin:/Users/nwm/bin:/Applications/Utilities/kdiff3.app/Contents/MacOS/:/Applications/Visual Studio Code.app/Contents/Resources/app/bin:/Applications/Utilities/kdiff3.app/Contents/MacOS/:/Applications/Visual Studio Code.app/Contents/Resources/app/bin
+
+Yarn version: 
+  1.22.11
+
+Node version: 
+  16.16.0
+
+Platform: 
+  darwin x64
+
+Trace: 
+  Error: https://registry.yarnpkg.com/@rancher%2fpkg: Not found
+      at Request.params.callback [as _callback] (/usr/local/Cellar/yarn/1.22.11/libexec/lib/cli.js:66992:18)
+      at Request.self.callback (/usr/local/Cellar/yarn/1.22.11/libexec/lib/cli.js:140763:22)
+      at Request.emit (node:events:527:28)
+      at Request.<anonymous> (/usr/local/Cellar/yarn/1.22.11/libexec/lib/cli.js:141735:10)
+      at Request.emit (node:events:527:28)
+      at IncomingMessage.<anonymous> (/usr/local/Cellar/yarn/1.22.11/libexec/lib/cli.js:141657:12)
+      at Object.onceWrapper (node:events:641:28)
+      at IncomingMessage.emit (node:events:539:35)
+      at endReadableNT (node:internal/streams/readable:1345:12)
+      at processTicksAndRejections (node:internal/process/task_queues:83:21)
+
+npm manifest: 
+  {
+    "name": "@rancher/create-app",
+    "description": "Rancher UI Upgrade helper",
+    "version": "0.0.0",
+    "license": "Apache-2.0",
+    "author": "SUSE",
+    "private": false,
+    "bin": "./init",
+    "files": [
+      "*.*",
+      "init"
+    ],
+    "engines": {
+      "node": ">=12"
+    },
+    "dependencies": {
+      "fs-extra": "^10.0.0"
+    }
+  }
+
+yarn manifest: 
+  No manifest
+
+Lockfile: 
+  No lockfile