@rancher/shell 0.1.0

package/content/docs/zh-hans/getting-started.md

@@ -0,0 +1,248 @@
+---
+title: 快速开始
+sideToc: false
+---
+
+# 入门
+
+这个简短的指南提供了一个关于用户界面的基本介绍。
+
+如果你以前一直在使用集群管理的用户界面，请查看下面的指南，以了解在新的用户界面中你可以在哪里访问相应的功能。
+
+## 首页
+
+当你第一次登录Rancher时，你会被带入新的主页。这里有许多信息卡。你可以使用<i class="icon icon-close doc-icon"></i>图标来关闭这些卡片。如果你想恢复隐藏的卡片，请使用右上方的<i class="icon icon-actions doc-icon"></i>图标打开页面菜单，选择 "恢复隐藏的卡片"。
+
+你可以从主页和首选项页面来改变你登录时的位置。要访问用户偏好，请点击右上方的用户头像图标，并从菜单中选择'偏好'。
+
+### 顶层菜单
+
+新的滑入式菜单提供了对你的集群和应用程序的快速访问。点击<svg class="doc-icon" xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24"><path d="M0 0h24v24H0z" fill="none" /><path d="M3 18h18v-2H3v2zm0-5h18v-2H3v2zm0-7v2h18V6H3z" /></svg> 左上方的图标即可进入。
+
+## 从集群管理器迁移
+
+从2.6版本开始，集群管理不再作为一个单独的用户界面提供。Dashboard的用户界面已被增强，以提供来自集群管理的功能。因此，你可能熟悉的集群管理的功能可以在新的用户界面中找到稍微不同的位置 - 本指南帮助你找到你正在寻找的东西。
+
+> 请注意，需要启用传统功能标志，以使传统功能可用。你可以从滑入式菜单→全局设置→功能标志中启用该功能。
+
+<table>
+  <thead>
+    <tr>
+      <th>特性</th>
+      <th>集群管理位置</th>
+      <th>新位置</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr class="table-group">
+      <td colspan="3">集群配置</td>
+    </tr>
+    <tr>
+      <td>集群列表</td>
+      <td>全局 → Clusters</td>
+      <td>菜单 → 管理集群 → Clusters</td>
+    </tr>
+    <tr>
+      <td>Drivers</td>
+      <td>Global → Tools → Drivers</td>
+      <td>Menu → 管理集群 → Drivers</td>
+    </tr>
+    <tr>
+      <td>RKE1 Templates</td>
+      <td>Global → Tools → RKE Templates</td>
+      <td>Menu → Cluster Management →  RKE1 Configuration → RKE Templates</td>
+    </tr>
+    <tr>
+      <td>RKE1 Cloud Credentials</td>
+      <td>User Icon → Cloud Credentials</td>
+      <td>Menu → Cluster Management → RKE1 Configuration → Cloud Credentials</td>
+    </tr>
+    <tr>
+      <td>RKE1 Node Templates</td>
+      <td>User Icon → Node Templates</td>
+      <td>Menu → Cluster Management → RKE1 Configuration → Node Templates</td>
+    </tr>
+    <tr>
+      <td>RKE1 Snapshots</td>
+      <td>Global → Clusters → Snapshots</td>
+      <td>Menu → Cluster Management → (Cluster) → Snapshots</td></td>
+    </tr>
+    <!-- -->
+    <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>
+      <td>Menu → Global Settings</td>
+    </tr>
+    <tr>
+      <td>Catalogs</td>
+      <td>Global → Tools → Catalogs</td>
+      <td>Menu → Multi-cluster Apps → Catalogs</td>
+    </tr>
+    <tr>
+      <td>Global DNS Entries</td>
+      <td>Global → Tools → Global DNS Entries</td>
+      <td>Menu → Multi-cluster Apps → Global DNS Entries</td>
+    </tr>
+    <tr>
+      <td>Global DNS Providers</td>
+      <td>Global → Tools → Global DNS Providers</td>
+      <td>Menu → Multi-cluster Apps → Global DNS Providers</td>
+    </tr>
+    <tr>
+      <td>Pod Security Policies</td>
+      <td>Global → Security → Pod Security Policies</td>
+      <td>Menu → Cluster Management → Advanced → Pod Security Policies</td>
+    </tr>
+    <!-- -->
+    <tr class="table-group">
+      <td colspan="3">Cluster Functionality (for a specific cluster)</td>
+    </tr>
+    <tr>
+      <td>Cluster</td>
+      <td>(Cluster) → Cluster</td>
+      <td>Menu → (Cluster) → Cluster</td>
+    </tr>
+    <tr>
+      <td>Nodes</td>
+      <td>(Cluster) → Nodes</td>
+      <td>Menu -> (Cluster) → Cluster → Kube Nodes</td>
+    </tr>
+    <tr>
+      <td>Projects/Namespaces</td>
+      <td>(Cluster) → Projects/Namespaces</td>
+      <td>Menu -> (Cluster) → Cluster → Projects/Namespaces</td>
+    </tr>
+    <tr>
+      <td>Alerts (V1)</td>
+      <td>(Cluster) → Tools → Alerts</td>
+      <td>Menu → (Cluster) → Legacy -> Alerts</td>
+    </tr>
+    <tr>
+      <td>Catalogs</td>
+      <td>(Cluster) → Tools → Catalogs</td>
+      <td>Menu → (Cluster) → Legacy -> Catalogs</td>
+    </tr>
+    <tr>
+      <td>Notifiers (V1)</td>
+      <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>
+      <td>Cluster Metrics</td>
+      <td>(Cluster) → Cluster</td>
+      <td>Menu → (Cluster) → Cluster</td>
+    </tr>
+    <tr>
+      <td>Node Metrics</td>
+      <td>(Cluster) → Nodes → (Node)</td>
+      <td>Menu → (Cluster) → Cluster → Nodes → (Node)</td>
+    </tr>
+    <tr>
+      <td>Workload Metrics</td>
+      <td>(Cluster) → (Project) → Resources → Workloads → (Workload) → Workload Metrics</td>
+      <td>Menu → (Cluster) → Deployments → (Deployment) → Metrics</td>
+    </tr>
+    <tr>
+      <td>Pod Metrics</td>
+      <td>(Cluster) → (Project) → Resources → Workloads → (Workload) → Pods → (Pod) → Pod Metrics</td>
+      <td>Menu → (Cluster) → Deployments → (Deployment) → Pods → (Pod) → Metrics</td>
+    </tr>
+    </tr>
+    <tr class="table-group">
+      <td colspan="3">Project</td>
+    </tr>
+    <tr>
+      <td>Namespaces</td>
+      <td>(Cluster) → (Project) → Namespaces</td>
+      <td>Menu → (Cluster) → Cluster → Projects/Namespaces</td>
+    </tr>
+    <tr>
+      <td>Apps</td>
+      <td>(Cluster) → (Project) → Apps</td>
+      <td>Menu → (Cluster) → Legacy → Project → Apps</td>
+    </tr>
+    <tr>
+      <td>Alerts</td>
+      <td>(Cluster) → (Project) → Tools → Alerts</td>
+      <td>Menu → (Cluster) → Legacy → Project → (Project) → Alerts</td>
+    </tr>
+    <tr>
+      <td>Catalogs</td>
+      <td>(Cluster) → (Project) → Tools → Catalogs</td>
+      <td>Menu → (Cluster) → Legacy → Project → (Project) → Catalogs</td>
+    </tr>
+    <tr>
+      <td>Logging</td>
+      <td>(Cluster) → (Project) → Tools → Logging</td>
+      <td>Menu → (Cluster) → Legacy → Project → (Project) → Logging</td>
+    </tr>
+    <tr>
+      <td>Monitoring</td>
+      <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>
+    <tr>
+      <td>Kubeconfig download</td>
+      <td>(Cluster) → Cluster → Kubeconfig File</td>
+      <td>Menu → (Cluster) → Cluster → File Icon (top-right)</td>
+    </tr>
+    <tr>
+      <td>CLI download</td>
+      <td>Bottom Bar</td>
+      <td>Menu → Version</td>
+    </tr>
+    <tr>
+      <td>Image Lists download</td>
+      <td>Bottom Bar --> Version</td>
+      <td>Menu → Version</td>
+    </tr>
+    <tr>
+      <td>API & Keys</td>
+      <td>User Avatar → API & Keys</td>
+      <td>User Avatar → Account & API Keys</td>
+    </tr>
+    <tr>
+      <td>Preferences</td>
+      <td>User Avatar → Preferences</td>
+      <td>User Avatar → Preferences</td>
+    </tr>
+  </tbody>
+</table>

package/content/docs/zh-hans/whats-new.md

@@ -0,0 +1,56 @@
+---
+title: 2.6版的新内容
+---
+## 重新设计的Rancher用户体验
+
+重现设计用户界面的外观和感觉，使初学者和高级Kubernetes用户易于使用。
+
+- 集群资源管理器的导航已经更新，用户现在可以看到用简单术语表达的最常用的Kubernetes资源的折叠子集。任何Kubernetes资源都可以通过Explorer进行管理，并通过资源搜索功能快速找到。用户现在可以管理他们的项目。像监控和日志这样的集群工具被聚集在一个容易发现的**集群工具**菜单下。启用监控时，集群仪表板现在包括实时指标。
+- 全局导航经过重新设计，使用户和管理员更容易在集群和顶级应用之间快速切换。
+- 集群管理列出了用户的所有集群，并增强了它自己的左侧导航菜单，将所有集群生命周期工具集中到一个地方。
+
+## 增强品牌和定制选项
+
+- 管理员现在可以通过一个品牌管理页面管理Rancher中的标识和颜色。
+- 用户可以在集群资源管理器导航中添加自己的应用程序的链接。
+
+## 增强的AKS生命周期管理
+
+- 对AKS集群的配置进行了更新，以支持私有AKS端点、多节点池、自动缩放和利用Rancher云凭证进行认证。
+- 现有的AKS集群可以被注册，从而能够管理Kubernetes版本和配置设置。
+
+## 增强的GKE生命周期管理
+
+- 对GKE集群的配置进行了更新，以支持共享VPC、多节点池、自动缩放和网络标签。
+- 现有的GKE集群可以被注册，从而能够管理Kubernetes版本和配置设置。
+- Rancher的项目网络隔离可以为通过Rancher配置或注册的GKE集群启用。
+
+## 技术预览 - RKE2集群配置
+
+- 为了支持RKE2集群的配置，我们引入了一个建立在集群API之上的新的配置框架。
+- RKE2集群可以通过Rancher在不同的云基础设施供应商（如AWS、Azure、vSphere、Linode和DigitalOcean）配置虚拟机。
+- RKE2集群也可以在现有的虚拟或裸机服务器上进行配置。
+
+## 技术预览 - RKE2支持Windows工作节点
+
+- Windows工作节点可以被添加到任何使用默认Calico CNI的RKE2自定义集群中。
+
+## 技术预览 - 集群模板
+
+- 集群模板提供了控制哪些参数可以被定制的能力，以配置集群。
+
+集群可以定义的例子有。
+
+- etcd、control和worker的节点池。
+- 用于配置节点的云凭证。
+
+## 使用OIDC的Keycloak
+
+- Keycloak现在可以使用OIDC进行认证。
+
+## 安全性增强
+
+- 管理员现在可以通过Rancher和Kubernetes审计日志中的用户名和身份提供者（IdP）来追踪用户。
+- 管理员可以启用Rancher API令牌的单向哈希。
+
+阅读完整的[发布说明](https://github.com/rancher/rancher/releases/tag/v2.6.0)以了解更多细节。

package/core/plugin-routes.ts

@@ -0,0 +1,138 @@
+import Router, { RouteConfig } from 'vue-router';
+
+interface RouteInfo {
+  parent?: string;
+  route: RouteConfig;
+}
+
+interface RouteInstallInfo {
+  plugin: string;
+  route: RouteConfig;
+}
+
+type RouteInstallHistory = {
+  [route: string]: RouteInstallInfo[]
+}
+
+export class PluginRoutes {
+  router: Router;
+
+  replacedRoutes: RouteInstallHistory = {};
+
+  constructor(router: Router) {
+    this.router = router;
+  }
+
+  public logRoutes(r: any, indent = 0) {
+    const spaces = Array(indent).join(' ');
+
+    r.forEach((s: any) => {
+      console.log(`${ spaces }${ s.name } -> ${ s.path }`); // eslint-disable-line no-console
+      this.logRoutes(s.children || [], indent + 2);
+    });
+  }
+
+  // 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 updare 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;
+          }
+        }
+      }
+    });
+
+    if (restore.length > 0) {
+      this.addRoutes(null, restore);
+    }
+  }
+
+  public addRoutes(plugin: any, routes: RouteInfo[]) {
+    const appRoutes = this.router.options.routes || [];
+    let replaced = 0;
+
+    // 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
+    routes.forEach((r: RouteInfo) => {
+      // See if the route exists
+      let existing: any;
+
+      if (r.parent) {
+        const pExisting = appRoutes.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);
+      } else {
+        // no parent route
+        existing = appRoutes.findIndex((route: any) => route.name === r.route.name);
+      }
+
+      if (existing >= 0) {
+        const existingRoute = appRoutes[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
+          });
+        }
+
+        appRoutes.splice(existing, 1);
+        replaced++;
+      }
+    });
+
+    const newRouter: Router = replaced > 0 ? new Router({
+      mode:   'history',
+      routes: appRoutes
+    }) : this.router;
+
+    routes.forEach((r: any) => {
+      if (r.parent) {
+        newRouter.addRoute(r.parent, r.route);
+      } else {
+        newRouter.addRoute(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;
+    }
+  }
+}

package/core/plugin.ts

@@ -0,0 +1,181 @@
+import { RouteConfig } from 'vue-router';
+import { DSL as STORE_DSL } from '@shell/store/type-map';
+import { IPlugin } from './types';
+import coreStore, { coreStoreModule, coreStoreState } from '@/shell/plugins/dashboard-store';
+import {
+  PluginRouteConfig, RegisterStore, UnregisterStore, CoreStoreSpecifics, CoreStoreConfig, OnNavToPackage, OnNavAwayFromPackage, OnLogOut
+} from '@/shell/core/types';
+
+export class Plugin implements IPlugin {
+  public id: string;
+  public name: string;
+  public types: any = {};
+  public l10n: { [key: string]: Function[] } = {};
+  public locales: { locale: string, label: string}[] = [];
+  public products: Function[] = [];
+  public productNames: string[] = [];
+  public routes: { parent?: string, route: RouteConfig }[] = [];
+  public stores: { storeName: string, register: RegisterStore, unregister: UnregisterStore }[] = [];
+  public onEnter: OnNavToPackage = () => Promise.resolve();
+  public onLeave: OnNavAwayFromPackage = () => Promise.resolve();
+  public _onLogOut: OnLogOut = () => Promise.resolve();
+
+  // Plugin metadata (plugin package.json)
+  public _metadata: any = {};
+
+  // Is this a built-in plugin (bundled with the application)
+  public builtin = false;
+
+  // Uninstall hooks
+  public uninstallHooks: Function[] = [];
+
+  constructor(id: string) {
+    this.id = id;
+    this.name = id;
+  }
+
+  get metadata() {
+    return this._metadata;
+  }
+
+  set metadata(value) {
+    this._metadata = value;
+    this.name = this._metadata.name || this.id;
+  }
+
+  // Track which products the plugin creates
+  DSL(store: any, productName: string) {
+    const storeDSL = STORE_DSL(store, productName);
+
+    this.productNames.push(productName);
+
+    return storeDSL;
+  }
+
+  addProduct(product: Function): void {
+    this.products.push(product);
+  }
+
+  addLocale(locale: string, label: string): void {
+    this.locales.push({ locale, label });
+  }
+
+  addL10n(locale: string, fn: Function) {
+    this.register('l10n', locale, fn);
+  }
+
+  addRoutes(routes: PluginRouteConfig[] | RouteConfig[]) {
+    routes.forEach((r: PluginRouteConfig | RouteConfig) => {
+      if (Object.keys(r).includes('parent')) {
+        const pConfig = r as PluginRouteConfig;
+
+        if (pConfig.parent) {
+          this.addRoute(pConfig.parent, pConfig.route);
+        } else {
+          this.addRoute(pConfig.route);
+        }
+      } else {
+        this.addRoute(r as RouteConfig);
+      }
+    });
+  }
+
+  addRoute(parentOrRoute: RouteConfig | string, optionalRoute?: RouteConfig): void {
+    // Always add the pkg name to the route metadata
+    const hasParent = typeof (parentOrRoute) === 'string';
+    const parent: string | undefined = hasParent ? parentOrRoute as string : undefined;
+    const route: RouteConfig = hasParent ? optionalRoute as RouteConfig : parentOrRoute as RouteConfig;
+
+    route.meta = {
+      ...route?.meta,
+      pkg: this.name,
+    };
+
+    this.routes.push({ parent, route });
+  }
+
+  addUninstallHook(hook: Function) {
+    this.uninstallHooks.push(hook);
+  }
+
+  addStore(storeName: string, register: RegisterStore, unregister: UnregisterStore) {
+    this.stores.push({
+      storeName, register, unregister
+    });
+  }
+
+  addDashboardStore(storeName: string, storeSpecifics: CoreStoreSpecifics, config: CoreStoreConfig) {
+    this.stores.push({
+      storeName,
+      register: () => {
+        return coreStore(
+          this.storeFactory(storeSpecifics, config),
+          config,
+        );
+      },
+      unregister: (store: any) => {
+        store.unregisterModule(storeName);
+      }
+    });
+  }
+
+  private storeFactory(storeSpecifics: CoreStoreSpecifics, config: CoreStoreConfig) {
+    return {
+      ...coreStoreModule,
+
+      state() {
+        return {
+          ...coreStoreState(config.namespace, config.baseUrl, config.isClusterStore),
+          ...storeSpecifics.state()
+        };
+      },
+
+      getters: {
+        ...coreStoreModule.getters,
+        ...storeSpecifics.getters
+      },
+
+      mutations: {
+        ...coreStoreModule.mutations,
+        ...storeSpecifics.mutations
+      },
+
+      actions: {
+        ...coreStoreModule.actions,
+        ...storeSpecifics.actions
+      },
+    };
+  }
+
+  public addNavHooks(
+    onEnter: OnNavToPackage = () => Promise.resolve(),
+    onLeave: OnNavAwayFromPackage = () => Promise.resolve(),
+    onLogOut: OnLogOut = () => Promise.resolve(),
+  ): void {
+    this.onEnter = onEnter;
+    this.onLeave = onLeave;
+    this._onLogOut = onLogOut;
+  }
+
+  public async onLogOut(store: any) {
+    await Promise.all(this.stores.map((s: any) => store.dispatch(`${ s.storeName }/onLogout`)));
+
+    await this._onLogOut(store);
+  }
+
+  public register(type: string, name: string, fn: Function) {
+    // Accumulate l10n resources rather than replace
+    if (type === 'l10n') {
+      if (!this.l10n[name]) {
+        this.l10n[name] = [];
+      }
+
+      this.l10n[name].push(fn);
+    } else {
+      if (!this.types[type]) {
+        this.types[type] = {};
+      }
+      this.types[type][name] = fn;
+    }
+  }
+}

package/core/plugins-loader.js

@@ -0,0 +1,31 @@
+import Vue from 'vue';
+import JSZip from 'jszip';
+import jsyaml from 'js-yaml';
+
+// Load any plugins that are present as npm modules
+// The 'dynamic' module is generated in webpack to load each package
+
+const dynamicLoader = require('@rancher/dynamic');
+
+export default function({
+  app,
+  store,
+  $axios,
+  redirect,
+  $plugin,
+  nuxt
+}, inject) {
+  if (dynamicLoader) {
+    dynamicLoader.default($plugin);
+  }
+
+  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.__jszip = JSZip;
+    window.__jsyaml = jsyaml;
+  }
+}