9.7. Web コンソールをカスタマイズする

手順

1. プラグインの設定ファイルに、console.action/provider 拡張機能を追加します。

   一括操作を有効にするには、VirtualMachine リソースの配列を対象とする contextId フィールドを使用する必要があります。

   console-extensions.json ファイルの抜粋例:

   {
      type: 'console.action/provider',
      properties: {
        contextId: 'kubevirt.io~v1~VirtualMachine[]',
        provider: {
          $codeRef: 'useSimpleBulkActions',
        },
      },
    }

   • properties.contextId は、KubeVirt プラグインがサポートを宣言する文字列を指定します。
   • properties.provider は、アクションアイテムを生成するソースコード内の React フックまたは関数を指定します。

2. 拡張機能が参照するソースファイル内で、選択されたリソースの配列を処理するフックを実装します。

   プラグインの例:

   import {
     type ExtensionHook,
     AccessReviewResourceAttributes,
     Action,
   } from '@openshift-console/dynamic-plugin-sdk';
   import { V1VirtualMachine } from '@kubevirt-ui-ext/kubevirt-api/kubevirt';
   import { VirtualMachineModel } from '@kubevirt-ui-ext/kubevirt-api/console';
   import { useMemo } from 'react';
   
   const useSimpleBulkActions: ExtensionHook<Action[], (V1VirtualMachine & { cluster?: string })[]> = (
     vms,
   ) => {
     const areAllRunning = vms.every((vm) => vm.status?.printableStatus === 'Running');
     const isCrossCluster = new Set(vms.map((vm) => vm.cluster)).size > 1;
     const firstVm = vms[0];
   
     const accessReview: AccessReviewResourceAttributes = useMemo(
       () => ({
         cluster: firstVm?.cluster,
         group: VirtualMachineModel.apiGroup,
         name: firstVm?.metadata?.name,
         namespace: firstVm?.metadata?.namespace,
         resource: VirtualMachineModel.plural,
         verb: 'delete',
       }),
       [firstVm?.cluster, firstVm?.metadata?.name, firstVm?.metadata?.namespace],
     );
   
     const checkAllRunningAction: Action = useMemo(
       () => ({
         id: 'check-all-running',
         cta: () => console.log('All selected VMs are running?', areAllRunning),
         label: 'Check VMs are running',
         disabled: isCrossCluster,
         disabledTooltip: isCrossCluster ? 'VMs from different clusters detected' : '',
         accessReview,
       }),
       [areAllRunning, isCrossCluster, accessReview],
     );
   
     const actions = useMemo(() => [checkAllRunningAction], [checkAllRunningAction]);
     return [actions, true, null];
   };
   
   export default useSimpleBulkActions;

   前の例で示したプラグインは、選択されたすべての仮想マシンが実行されているかを確認し、ログメッセージをコンソールに出力します。

3. プラグインをクラスターにデプロイします。

検証

1. OpenShift Container Platform Web コンソールにログインします。

2. 仮想マシンに対して一括操作を適用できることを確認します。

   1. Virtualization VirtualMachines に移動します。
   2. 既存の仮想マシンが 2 つ以上ある場合は、該当するチェックボックスを選択します。
   3. Actions ドロップダウンメニューをクリックします。作成したカスタムアクションが実行できることを確認します。