@rancher/shell 3.0.12-rc.4 → 3.0.12-rc.6

package/core/types.ts

@@ -1,13 +1,9 @@
-import { ProductFunction } from './plugin';
 import { RouteRecordRaw } from 'vue-router';
 import type { ExtensionManager } from '@shell/types/extension-manager';
 import { PaginationSettingsStores } from '@shell/types/resources/settings';
-import type {
-  ProductMetadata, ProductSinglePage,
-  StandardProductName, RouteRecordRawWithParams, ProductChild,
-  ProductChildGroup,
-  ProductChildPage
-} from './plugin-types';
+import { IExtensionProducts } from '@shell/core/plugin-products-external';
+import { RouteRecordRawWithParams } from '@shell/core/plugin-types';
+import { TypeMapProduct } from '@shell/types/store/type-map';
 
 // Cluster Provisioning types
 export * from './types-provisioning';
@@ -200,137 +196,6 @@ export type ExtensionEnvironment = {
   docsVersion: string; /** e.g. 'v2.10' */
 };
 
-export interface ProductOptions {
-  /**
-   * The category this product belongs under. i.e. 'config'
-   */
-  category?: string;
-
-  /**
-   * Hide the Copy KubeConfig button in the header
-   */
-  hideCopyConfig?: boolean;
-
-  /**
-   * Hide the Download KubeConfig button in the header
-   */
-  hideKubeConfig?: boolean;
-
-  /**
-   * Hide the Kubectl Shell button in the header
-   */
-  hideKubeShell?: boolean;
-
-  /**
-   * Hide the Namespace location
-   */
-  hideNamespaceLocation?: boolean;
-
-  /**
-   * Hide the system resources
-   */
-
-  hideSystemResources?: boolean;
-  /**
-   * The icon that should be displayed beside this item in the navigation.
-   */
-  icon?: string,
-
-  /**
-   * Only load the product if the feature is present
-   */
-  ifFeature?: string | RegExp;
-
-  /**
-   * Only load the product if the type is present
-   */
-  ifHave?: string;
-
-  /**
-   * Only load the product if the group is present
-   */
-  ifHaveGroup?: string | RegExp;
-
-  /**
-   * Only load the product if the type is present
-   */
-  ifHaveType?: string | RegExp;
-
-  /**
-   * Hide the product if the type is present (opposite of ifHaveType)
-   */
-  ifNotHaveType?: string | RegExp;
-
-  /**
-   * The vuex store that this product should use by default i.e. 'management'
-   */
-  inStore?: string;
-
-  /**
-   * Show the cluster switcher in the navigation
-   */
-  showClusterSwitcher?: boolean;
-
-  /**
-   * Indicates whether UI Extensions can add pages to this product
-   */
-  extendable?: boolean;
-
-  /**
-   * Show the namespace filter in the header
-   */
-  showNamespaceFilter?: boolean;
-
-  /**
-   * A number used to determine where in navigation this item will be placed. The highest number will be at the top of the list.
-   */
-  weight?: number;
-
-  /**
-   * The route that the product will lead to if click on in navigation.
-   */
-  to?: PluginRouteRecordRaw;
-
-  /**
-   * Whether the product can be removed by users (default: false — products are built-in/not removable unless explicitly set to true)
-   */
-  removable?: boolean;
-
-  /**
-   * Alternative to the icon property. Uses require
-   */
-  svg?: Function;
-
-  /**
-   * Product name
-   */
-  name?: string;
-
-  /**
-   *  controls whether a workspace switcher dropdown appears in the header (instead of the namespace filter) if set to true
-   */
-  showWorkspaceSwitcher?: boolean;
-
-  /**
-   *
-   */
-  label?: string;
-
-  labelKey?: string;
-
-  iconHeader?: string;
-
-  // Do not use - internal use only
-  version?: number;
-
-  /**
-   * Leaving these here for completeness but I don't think these should be advertised as useable to plugin creators.
-   */
-  // ifHaveVerb: string | RegExp;
-  // supportRoute: string;
-  // typeStoreMap: string;
-}
-
 /**
  * Configuration required to show a header in a ResourceTable
  */
@@ -399,17 +264,6 @@ export interface HeaderOptions {
  */
 export type PaginationHeaderOptions = Omit<HeaderOptions, 'getValue'>
 
-export type ResourceTypeConfig = {
-  options?: {
-    isCreatable?: boolean;
-    isEditable?: boolean;
-  },
-  listHeaders?: {
-    legacy?: HeaderOptions[];
-    paginated?: PaginationHeaderOptions[];
-  }
-};
-
 /**
  * External extension configuration for @HeaderOptions
  */
@@ -568,7 +422,7 @@ export interface DSLReturnType {
    * @param options {@link ProductOptions}
    * @returns {@link void}
    */
-  product: (options: ProductOptions) => void;
+  product: (options: TypeMapProduct) => void;
 
   /**
    /**
@@ -691,62 +545,12 @@ export type ModelExtensionContext = {
 /**
  * Constructor signature for a model extension
  */
-export type ModelExtensionConstructor = (context: ModelExtensionContext) => Object;
+export type ModelExtensionConstructor = new (context: ModelExtensionContext) => Object;
 
 /**
  * Interface for a UI Extension
  */
-export interface IExtension {
-  /**
-   * Register a top-level product as a flag on the plugin
-   * @internal - DO NOT USE - Internal API only
-   */
-  _registerTopLevelProduct(): void;
-  /**
-   *
-   * @internal - DO NOT USE - Internal API only
-   */
-  _setStartRouteWithProduct(value: boolean): void;
-
-  /**
-   * Add a product to the sidebar, with children and a side menu for navigation for internal pages
-   * @param name
-   * @param config
-   */
-  addProduct(product: ProductMetadata, config: ProductChildPage[]): void;
-  addProduct(product: ProductMetadata, config: ProductChildGroup[]): void;
-  addProduct(product: ProductMetadata, config: ProductChild[]): void;
-
-  /**
-   * Add a product to the sidebar, without children (no side menu, single page only)
-   * @param product
-   */
-  addProduct(product: ProductSinglePage): void;
-
-  /**
-   * Add a product with just a name (convenience/bridge method for quick setup).
-   * Creates a basic product with an empty page component automatically.
-   * This is useful for getting started quickly - expand to the full API once you're ready to add custom pages.
-   * @param productName Simple product name - will be used as both the name and label
-   */
-  addProduct(productName: string): void;
-
-  /**
-   * Add a product to the sidebar (deprecated, use other signatures of addProduct instead)
-   * @deprecated Use other `addProduct` signatures instead
-   * @param importFn Function that will import the module containing a product definition
-   */
-  addProduct(importFn: ProductFunction): void;
-
-  /**
-   * Extend an existing product in Rancher, with children and a side menu for navigation for internal pages
-   *
-   * @param product Product to be extended
-   * @param config Product extension configuration
-   */
-  extendProduct(product: StandardProductName | string, config: ProductChildPage[]): void;
-  extendProduct(product: StandardProductName | string, config: ProductChildGroup[]): void;
-  extendProduct(product: StandardProductName | string, config: ProductChild[]): void;
+export interface IExtension extends IExtensionProducts {
 
   /**
    * Add a locale to the i18n store

package/detail/__tests__/provisioning.cattle.io.cluster.test.ts

@@ -241,4 +241,56 @@ describe('view: provisioning.cattle.io.cluster', () => {
       expect(wrapper.vm.fakeMachines).toHaveLength(0);
     });
   });
+
+  describe('computed: showLog', () => {
+    it('returns true when mgmt has a log link and extDetailTabs.logs is enabled', async() => {
+      const value = { mgmt: { hasLink: (link: string) => link === 'log' } };
+
+      const wrapper = shallowMount(ProvisioningCattleIoCluster, {
+        props:  { value },
+        global: { mocks },
+      });
+
+      await wrapper.setData({ extDetailTabs: { logs: true } });
+
+      expect(wrapper.vm.showLog).toStrictEqual(true);
+    });
+
+    it('returns false when mgmt does not have a log link', async() => {
+      const value = { mgmt: { hasLink: () => false } };
+
+      const wrapper = shallowMount(ProvisioningCattleIoCluster, {
+        props:  { value },
+        global: { mocks },
+      });
+
+      await wrapper.setData({ extDetailTabs: { logs: true } });
+
+      expect(wrapper.vm.showLog).toStrictEqual(false);
+    });
+
+    it('returns false when mgmt has a log link but extDetailTabs.logs is disabled', async() => {
+      const value = { mgmt: { hasLink: (link: string) => link === 'log' } };
+
+      const wrapper = shallowMount(ProvisioningCattleIoCluster, {
+        props:  { value },
+        global: { mocks },
+      });
+
+      await wrapper.setData({ extDetailTabs: { logs: false } });
+
+      expect(wrapper.vm.showLog).toStrictEqual(false);
+    });
+
+    it('returns false when mgmt is undefined', async() => {
+      const value = {};
+
+      const wrapper = shallowMount(ProvisioningCattleIoCluster, {
+        props:  { value },
+        global: { mocks },
+      });
+
+      expect(wrapper.vm.showLog).toBeFalsy();
+    });
+  });
 });

package/detail/pod.vue

@@ -38,7 +38,7 @@ export default {
       const projectId = namespace?.metadata?.labels[PROJECT];
 
       if (projectId) {
-        this.POD_PROJECT_METRICS_DETAIL_URL = `/api/v1/namespaces/cattle-project-${ projectId }-monitoring/services/http:cattle-project-${ projectId }-monitoring-grafana:80/proxy/d/rancher-pod-containers-1/rancher-pod-containers?orgId=1'`;
+        this.POD_PROJECT_METRICS_DETAIL_URL = `/api/v1/namespaces/cattle-project-${ projectId }-monitoring/services/http:cattle-project-${ projectId }-monitoring-grafana:80/proxy/d/rancher-pod-containers-1/rancher-pod-containers?orgId=1`;
         this.POD_PROJECT_METRICS_SUMMARY_URL = `/api/v1/namespaces/cattle-project-${ projectId }-monitoring/services/http:cattle-project-${ projectId }-monitoring-grafana:80/proxy/d/rancher-pod-1/rancher-pod?orgId=1`;
 
         this.showProjectMetrics = await allDashboardsExist(this.$store, this.currentCluster.id, [this.POD_PROJECT_METRICS_DETAIL_URL, this.POD_PROJECT_METRICS_SUMMARY_URL], 'cluster', projectId);

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

@@ -6,7 +6,9 @@ import SortableTable from '@shell/components/SortableTable';
 import CopyCode from '@shell/components/CopyCode';
 import Tab from '@shell/components/Tabbed/Tab';
 import { allHash } from '@shell/utils/promise';
-import { CAPI, MANAGEMENT, NORMAN, SNAPSHOT } from '@shell/config/types';
+import {
+  CAPI, MANAGEMENT, NORMAN, SNAPSHOT, OPERATION
+} from '@shell/config/types';
 import {
   STATE, NAME as NAME_COL, AGE, INTERNAL_EXTERNAL_IP, STATE_NORMAN, ROLES, MACHINE_NODE_OS, MANAGEMENT_NODE_OS, NAME,
 } from '@shell/config/table-headers';
@@ -149,6 +151,21 @@ export default {
       fetchOne.snapshots = this.$store.dispatch('management/findAll', { type: SNAPSHOT });
     }
 
+    // Fetch operation CRDs for clusters with day 2 ops enabled
+    if ( this.value.isImportedWithDayTwoOps ) {
+      const operationTypes = [
+        OPERATION.ETCD_SNAPSHOT,
+        OPERATION.ETCD_SNAPSHOT_RESTORE,
+        OPERATION.ENCRYPTION_KEY_ROTATE,
+      ];
+
+      for (const opType of operationTypes) {
+        if (this.$store.getters['management/canList'](opType)) {
+          fetchOne[`operations_${ opType }`] = this.$store.dispatch('management/findAll', { type: opType });
+        }
+      }
+    }
+
     if ( this.value.isImported || this.value.isCustom || this.value.isHostedKubernetesProvider ) {
       fetchOne.clusterToken = this.value.getOrCreateToken();
     }
@@ -210,9 +227,7 @@ export default {
     if ( this.$store.getters['management/canList'](MANAGEMENT.RKE_TEMPLATE) ) {
       this.$store.dispatch('management/findAll', { type: MANAGEMENT.RKE_TEMPLATE });
     }
-  },
 
-  created() {
     if ( this.showLog ) {
       this.connectLog();
     }
@@ -292,6 +307,7 @@ export default {
         registration: true, // in this component
         snapshots:    true, // in this component
         autoscaler:   true, // in this component
+        operations:   true, // in this component
         related:      true, // in ResourceTabs
         events:       true, // in ResourceTabs
         conditions:   true, // in ResourceTabs
@@ -477,13 +493,54 @@ export default {
     showSnapshots() {
       if (this.value.isRke1) {
         return false;
-      } else if (this.value.isRke2) {
+      } else if (this.value.isRke2 || (this.value.isImported && this.value.isDayTwoOpsEnabled)) {
         return this.$store.getters['management/canList'](SNAPSHOT) && this.extDetailTabs.snapshots;
       }
 
       return false;
     },
 
+    showOperations() {
+      return this.value.isImportedWithDayTwoOps && this.extDetailTabs.operations;
+    },
+
+    clusterOperations() {
+      if (!this.value.isImportedWithDayTwoOps) {
+        return [];
+      }
+
+      const mgmtId = this.value.mgmt?.id;
+      const operationTypes = [
+        OPERATION.ETCD_SNAPSHOT,
+        OPERATION.ETCD_SNAPSHOT_RESTORE,
+        OPERATION.ENCRYPTION_KEY_ROTATE,
+      ];
+
+      const allOps = [];
+
+      for (const opType of operationTypes) {
+        const resources = this.$store.getters['management/all'](opType) || [];
+
+        allOps.push(...resources.filter((op) => op.spec?.clusterRef?.name === mgmtId));
+      }
+
+      return allOps;
+    },
+
+    operationHeaders() {
+      return [
+        STATE,
+        NAME,
+        {
+          name:     'type',
+          labelKey: 'tableHeaders.type',
+          value:    'type',
+          sort:     'type',
+        },
+        AGE,
+      ];
+    },
+
     isRke1() {
       return this.value.isRke1;
     },
@@ -566,7 +623,10 @@ export default {
         {
           ...STATE_NORMAN, value: 'snapshotFile.status', formatterOpts: { arbitrary: true }
         },
-        NAME,
+        {
+          ...NAME,
+          formatter: 'EtcdSnapshotName',
+        },
         {
           name:      'size',
           labelKey:  'tableHeaders.size',
@@ -1150,6 +1210,20 @@ export default {
               </template>
             </SortableTable>
           </Tab>
+          <Tab
+            v-if="showOperations"
+            name="operations"
+            :label="t('cluster.tabs.operations')"
+            :weight="0"
+          >
+            <SortableTable
+              :headers="operationHeaders"
+              default-sort-by="age"
+              :table-actions="false"
+              :rows="clusterOperations"
+              :search="false"
+            />
+          </Tab>
           <AutoscalerTab
             v-if="showAutoScalerTab"
             :value="value"

package/dialog/RotateEncryptionKeyDialog.vue

@@ -1,5 +1,5 @@
 <script>
-import { SNAPSHOT } from '@shell/config/types';
+import { SNAPSHOT, OPERATION } from '@shell/config/types';
 import AsyncButton from '@shell/components/AsyncButton';
 import { Card } from '@components/Card';
 import { Banner } from '@components/Banner';
@@ -10,7 +10,7 @@ import day from 'dayjs';
 import { escapeHtml } from '@shell/utils/string';
 import { DATE_FORMAT, TIME_FORMAT } from '@shell/store/prefs';
 import { set } from '@shell/utils/object';
-
+import { createOperationCR } from '@shell/utils/operation-cr';
 export default {
   emits: ['close'],
 
@@ -66,6 +66,10 @@ export default {
     async getEtcdBackups() {
       let etcdBackups = await this.$store.dispatch('management/findAll', { type: SNAPSHOT });
 
+      if (this.cluster.isImportedWithDayTwoOps) {
+        return etcdBackups
+          .filter((backup) => backup.metadata.namespace === this.cluster.mgmt?.id && backup.spec?.clusterName === this.cluster.mgmt?.metadata?.name );
+      }
       etcdBackups = etcdBackups.filter((backup) => backup.clusterId === this.cluster.id);
 
       return etcdBackups;
@@ -82,12 +86,32 @@ export default {
 
     async apply(buttonDone) {
       try {
-        const currentGeneration = this.cluster.spec?.rkeConfig?.rotateEncryptionKeys?.generation || 0;
-
-        // To rotate the encryption keys, increment
-        // rkeConfig.rotateEncyrptionKeys.generation in the YAML.
-        set(this.cluster, 'spec.rkeConfig.rotateEncryptionKeys.generation', currentGeneration + 1);
-        await this.cluster.save();
+        const isImportedWithDayTwoOps = this.cluster?.isImportedWithDayTwoOps || this.cluster?.mgmt?.isDayTwoOpsEnabled;
+
+        if (isImportedWithDayTwoOps) {
+          if (!isImportedWithDayTwoOps) {
+            throw new Error(this.t('promptRotateEncryptionKey.error.unableToResolveTargetCluster'));
+          }
+          // For imported clusters with day 2 ops, create an encryption key rotation operation CR
+          const namespace = this.cluster.mgmt?.id;
+          const safePrefix = this.cluster.mgmt?.id;
+          const spec = {
+            clusterRef: {
+              apiVersion: 'management.cattle.io/v3',
+              kind:       'Cluster',
+              name:       this.cluster.mgmt?.id,
+            }
+          };
+
+          createOperationCR(this.$store.dispatch, OPERATION.ENCRYPTION_KEY_ROTATE, spec, namespace, safePrefix);
+        } else {
+          const currentGeneration = this.cluster.spec?.rkeConfig?.rotateEncryptionKeys?.generation || 0;
+
+          // To rotate the encryption keys, increment
+          // rkeConfig.rotateEncyrptionKeys.generation in the YAML.
+          set(this.cluster, 'spec.rkeConfig.rotateEncryptionKeys.generation', currentGeneration + 1);
+          await this.cluster.save();
+        }
 
         this.close(buttonDone);
       } catch (err) {
@@ -128,7 +152,7 @@ export default {
           <Banner
             v-else
             color="error"
-            label-key="promptRotateEncryptionKey.error"
+            label-key="promptRotateEncryptionKey.error.noBackup"
           />
         </div>
       </div>

package/dialog/__tests__/RotateEncryptionKeyDialog.test.ts

@@ -0,0 +1,78 @@
+import { shallowMount } from '@vue/test-utils';
+import RotateEncryptionKeyDialog from '@shell/dialog/RotateEncryptionKeyDialog.vue';
+import { OPERATION } from '@shell/config/types';
+import { createOperationCR } from '@shell/utils/operation-cr';
+
+jest.mock('@shell/utils/operation-cr', () => ({ createOperationCR: jest.fn() }));
+
+describe('component: RotateEncryptionKeyDialog', () => {
+  const t = (key: string) => key;
+
+  const createWrapper = (cluster: any, dispatch = jest.fn()) => {
+    return shallowMount(RotateEncryptionKeyDialog, {
+      propsData: { cluster },
+      global:    {
+        mocks: {
+          t,
+          $store: {
+            dispatch,
+            getters: {
+              isRancher:   true,
+              'prefs/get': jest.fn((key: string) => (key.includes('date') ? 'YYYY-MM-DD' : 'HH:mm:ss')),
+            }
+          },
+        },
+        directives: { 'clean-html': true }
+      }
+    });
+  };
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should create operation CR for imported day 2 ops clusters', async() => {
+    (createOperationCR as jest.Mock).mockResolvedValue(undefined);
+
+    const cluster = {
+      isImportedWithDayTwoOps: true,
+      mgmt:                    { id: 'c-m-1' },
+      save:                    jest.fn(),
+      spec:                    { rkeConfig: {} }
+    };
+    const dispatch = jest.fn();
+    const buttonDone = jest.fn();
+    const wrapper = createWrapper(cluster, dispatch);
+
+    await wrapper.vm.apply(buttonDone);
+
+    expect(createOperationCR).toHaveBeenCalledWith(dispatch, OPERATION.ENCRYPTION_KEY_ROTATE, {
+      clusterRef: {
+        apiVersion: 'management.cattle.io/v3',
+        kind:       'Cluster',
+        name:       'c-m-1',
+      }
+    }, 'c-m-1', 'c-m-1');
+    expect(cluster.save).not.toHaveBeenCalled();
+    expect(buttonDone).toHaveBeenCalledWith(true);
+  });
+
+  it('should update generation and save for non-day-2 clusters', async() => {
+    const save = jest.fn().mockResolvedValue(undefined);
+    const cluster = {
+      isImportedWithDayTwoOps: false,
+      mgmt:                    { id: 'c-m-1' },
+      save,
+      spec:                    { rkeConfig: { rotateEncryptionKeys: { generation: 4 } } }
+    };
+    const buttonDone = jest.fn();
+    const wrapper = createWrapper(cluster);
+
+    await wrapper.vm.apply(buttonDone);
+
+    expect(createOperationCR).not.toHaveBeenCalled();
+    expect(cluster.spec.rkeConfig.rotateEncryptionKeys.generation).toBe(5);
+    expect(save).toHaveBeenCalledWith();
+    expect(buttonDone).toHaveBeenCalledWith(true);
+  });
+});