MTV-2386: Clarify name template configuration (#1854)

Signed-off-by: Aviv Turgeman <[email protected]>

Author: avivtur

locales/en/plugin__forklift-console-plugin.json

@@ -259,6 +259,7 @@
   "Critical": "Critical",
   "Critical concerns": "Critical concerns",
   "Critical issues detected in your selected VMs will cause the migration to fail. Resolve these issues or remove the VMs from the plan before starting the migration.": "Critical issues detected in your selected VMs will cause the migration to fail. Resolve these issues or remove the VMs from the plan before starting the migration.",
+  "Custom name template": "Custom name template",
   "Cutover": "Cutover",
   "Data centers": "Data centers",
   "Data is loading, please wait.": "Data is loading, please wait.",
@@ -268,6 +269,7 @@
   "Dates are compared in UTC. End of the interval is included.": "Dates are compared in UTC. End of the interval is included.",
   "Dedicated CPU": "Dedicated CPU",
   "Default": "Default",
+  "Default name template": "Default name template",
   "Default network": "Default network",
   "Default transfer network": "Default transfer network",
   "Default transfer Network": "Default transfer Network",
@@ -470,6 +472,7 @@
   "incomplete": "incomplete",
   "Incomplete": "Incomplete",
   "Information concerns": "Information concerns",
+  "Inherit plan wide setting": "Inherit plan wide setting",
   "Invalid application ID, spaces are not allowed": "Invalid application ID, spaces are not allowed",
   "Invalid application name, spaces are not allowed": "Invalid application name, spaces are not allowed",
   "Invalid application secret, spaces are not allowed": "Invalid application secret, spaces are not allowed",
@@ -720,10 +723,13 @@
   "Plan name must be unique across all namespaces.": "Plan name must be unique across all namespaces.",
   "Plan name must contain only lowercase alphanumeric characters or '-', and must start or end with lowercase alphanumeric character.": "Plan name must contain only lowercase alphanumeric characters or '-', and must start or end with lowercase alphanumeric character.",
   "Plan name:": "Plan name:",
+  "Plan network name template": "Plan network name template",
   "Plan project": "Plan project",
   "Plan project is required.": "Plan project is required.",
   "Plan project:": "Plan project:",
+  "Plan PVC name template": "Plan PVC name template",
   "Plan settings": "Plan settings",
+  "Plan volume name template": "Plan volume name template",
   "Plan YAML": "Plan YAML",
   "Plans": "Plans",
   "Plans cannot be modified during migration": "Plans cannot be modified during migration",
@@ -1101,13 +1107,16 @@
   "Virtual machine": "Virtual machine",
   "Virtual machines": "Virtual machines",
   "VM name": "VM name",
+  "VM network name template": "VM network name template",
+  "VM PVC name template": "VM PVC name template",
   "VM target affinity rules": "VM target affinity rules",
   "VM target labels": "VM target labels",
   "VM target name": "VM target name",
   "VM target name must be unique within a plan.": "VM target name must be unique within a plan.",
   "VM target name must contain only lowercase alphanumeric characters or '-', and must start or end with lowercase alphanumeric character.": "VM target name must contain only lowercase alphanumeric characters or '-', and must start or end with lowercase alphanumeric character.",
   "VM target node selector": "VM target node selector",
   "VM target power state": "VM target power state",
+  "VM volume name template": "VM volume name template",
   "VMs": "VMs",
   "VMs included in cold migrations are shut down during migration.": "VMs included in cold migrations are shut down during migration.",
   "VMs included in live migrations migrate without downtime.": "VMs included in live migrations migrate without downtime.",

package.json

@@ -41,7 +41,7 @@
     "postinstall": "husky"
   },
   "dependencies": {
-    "@kubev2v/types": "0.0.22",
+    "@kubev2v/types": "0.0.24",
     "@openshift-console/dynamic-plugin-sdk": "1.8.0",
     "@patternfly/patternfly": "5.4.2",
     "@patternfly/quickstarts": "^5.4.5",

src/components/AffinityModal/utils/constants.ts

@@ -72,3 +72,14 @@ export const operatorSelectOptions = [
   { label: t('In'), value: Operator.In.valueOf() },
   { label: t('Not in'), value: Operator.NotIn.valueOf() },
 ];
+
+export const K8sIoApiCoreV1NodeSelectorRequirementOperatorEnum = {
+  DoesNotExist: 'DoesNotExist',
+  Exists: 'Exists',
+  Gt: 'Gt',
+  In: 'In',
+  Lt: 'Lt',
+  NotIn: 'NotIn',
+} as const;
+export type K8sIoApiCoreV1NodeSelectorRequirementOperatorEnum =
+  (typeof K8sIoApiCoreV1NodeSelectorRequirementOperatorEnum)[keyof typeof K8sIoApiCoreV1NodeSelectorRequirementOperatorEnum];

src/components/AffinityModal/utils/rowsDataToAffinity.ts

@@ -1,20 +1,26 @@
-import {
-  type K8sIoApiCoreV1Affinity,
-  type K8sIoApiCoreV1NodeSelectorRequirement,
-  K8sIoApiCoreV1NodeSelectorRequirementOperatorEnum,
-  type K8sIoApiCoreV1NodeSelectorTerm,
-  type K8sIoApiCoreV1PodAffinityTerm,
-  type K8sIoApiCoreV1PreferredSchedulingTerm,
-  type K8sIoApiCoreV1WeightedPodAffinityTerm,
+import type {
+  K8sIoApiCoreV1Affinity,
+  K8sIoApiCoreV1NodeSelectorRequirement,
+  K8sIoApiCoreV1NodeSelectorTerm,
+  K8sIoApiCoreV1PodAffinityTerm,
+  K8sIoApiCoreV1PreferredSchedulingTerm,
+  K8sIoApiCoreV1WeightedPodAffinityTerm,
 } from '@kubev2v/types';
 import { isEmpty } from '@utils/helpers';
 
+import { K8sIoApiCoreV1NodeSelectorRequirementOperatorEnum } from './constants';
 import { AffinityCondition, type AffinityLabel, type AffinityRowData, AffinityType } from './types';
 
+type PickRowsMapper<T> = (rowData: AffinityRowData) => T;
+
 const flattenExpressions = (
-  affinityLabels: AffinityLabel[],
-): K8sIoApiCoreV1NodeSelectorRequirement[] =>
-  affinityLabels?.map((aff) => {
+  affinityLabels: AffinityLabel[] | undefined,
+): K8sIoApiCoreV1NodeSelectorRequirement[] => {
+  if (!affinityLabels) {
+    return [];
+  }
+
+  return affinityLabels?.map((aff) => {
     const { id: _id, ...affinityWithoutID } = aff;
 
     const affinityRequirement = { ...affinityWithoutID } as K8sIoApiCoreV1NodeSelectorRequirement;
@@ -23,6 +29,7 @@ const flattenExpressions = (
       ? { ...affinityRequirement, values: [] }
       : affinityRequirement;
   });
+};
 
 const getRequiredNodeTermFromRowData = ({
   expressions,
@@ -41,7 +48,7 @@ const getPreferredNodeTermFromRowData = ({
     matchExpressions: flattenExpressions(expressions),
     matchFields: flattenExpressions(fields),
   },
-  weight,
+  weight: weight!,
 });
 
 const getRequiredPodTermFromRowData = ({
@@ -51,7 +58,7 @@ const getRequiredPodTermFromRowData = ({
   labelSelector: {
     matchExpressions: flattenExpressions(expressions),
   },
-  topologyKey,
+  topologyKey: topologyKey!,
 });
 
 const getPreferredPodTermFromRowData = ({
@@ -63,20 +70,24 @@ const getPreferredPodTermFromRowData = ({
     labelSelector: {
       matchExpressions: flattenExpressions(expressions),
     },
-    topologyKey,
+    topologyKey: topologyKey!,
   },
-  weight,
+  weight: weight!,
 });
 
 export const rowsDataToAffinity = (affinityRows: AffinityRowData[]) => {
   if (isEmpty(affinityRows)) {
     return null;
   }
 
-  const pickRows = (rowType, rowCondition, mapper) =>
+  const pickRows = <T>(
+    affinityType: AffinityType,
+    condition: AffinityCondition,
+    mapper: PickRowsMapper<T>,
+  ): T[] =>
     affinityRows
-      .filter(({ condition, type }) => type === rowType && condition === rowCondition)
-      .map((rowData) => mapper(rowData));
+      .filter((row) => row.type === affinityType && row.condition === condition)
+      .map(mapper);
 
   const affinity = {} as K8sIoApiCoreV1Affinity;
 

src/plans/create/utils/createPlan.ts

@@ -1,7 +1,6 @@
 import { getObjectRef } from 'src/modules/Providers/views/migrate/reducer/helpers';
-import type { EnhancedPlan } from 'src/plans/details/tabs/Details/components/SettingsSection/utils/types';
 
-import { PlanModel } from '@kubev2v/types';
+import { PlanModel, type V1beta1Plan } from '@kubev2v/types';
 import { k8sCreate } from '@openshift-console/dynamic-plugin-sdk';
 
 import { MigrationTypeValue } from '../steps/migration-type/constants';
@@ -33,7 +32,7 @@ export const createPlan = async ({
   transferNetwork,
   vms,
 }: CreatePlanParams) => {
-  const plan: EnhancedPlan = {
+  const plan: V1beta1Plan = {
     apiVersion: 'forklift.konveyor.io/v1beta1',
     kind: 'Plan',
     metadata: {

src/plans/details/tabs/Details/components/SettingsSection/SettingsSection.tsx

@@ -51,9 +51,9 @@ const SettingsSection: FC<SettingsSectionProps> = ({ plan }) => {
         />
         <RootDiskDetailsItem plan={plan} canPatch={canPatch} shouldRender={isVsphere} />
         <SharedDisksDetailsItem plan={plan} canPatch={canPatch} shouldRender={isVsphere} />
-        <VolumeNameTemplateDetailsItem plan={plan} canPatch={canPatch} shouldRender={isVsphere} />
-        <TransferNetworkDetailsItem plan={plan} canPatch={canPatch} />
         <PVCNameTemplateDetailsItem plan={plan} canPatch={canPatch} shouldRender={isVsphere} />
+        <TransferNetworkDetailsItem plan={plan} canPatch={canPatch} />
+        <VolumeNameTemplateDetailsItem plan={plan} canPatch={canPatch} shouldRender={isVsphere} />
         <PreserveStaticIPsDetailsItem plan={plan} canPatch={canPatch} shouldRender={isVsphere} />
         <NetworkNameTemplateDetailsItem plan={plan} canPatch={canPatch} shouldRender={isVsphere} />
         <PreserveClusterCpuModelDetailsItem

src/plans/details/tabs/Details/components/SettingsSection/components/EditNameTemplate/EditNameTemplate.tsx

@@ -1,69 +1,96 @@
 import { type FC, type ReactNode, useState } from 'react';
 
+import Select from '@components/common/Select';
 import ModalForm from '@components/ModalForm/ModalForm';
 import type { V1beta1Plan } from '@kubev2v/types';
-import { Radio, TextInput } from '@patternfly/react-core';
+import { Form, FormGroup, SelectList, SelectOption, TextInput } from '@patternfly/react-core';
+import { isEmpty } from '@utils/helpers';
 
-import { NameTemplateRadioOptions } from './utils/constants';
+import { NameTemplateOptions, type NameTemplateOptionType } from './utils/types';
+import {
+  getNameTemplateOptions,
+  getNameTemplateStateLabel,
+  getSelectedOption,
+} from './utils/utils';
 
 type EditNameTemplateProps = {
+  allowInherit?: boolean;
+  inheritValue?: string;
   title: string;
   value: string | undefined;
   onConfirm: (value: string | undefined) => Promise<V1beta1Plan>;
   body?: ReactNode;
   helperText?: ReactNode;
+  fieldName: string;
 };
 
 const EditNameTemplate: FC<EditNameTemplateProps> = ({
+  allowInherit = true,
   body,
+  fieldName,
   helperText,
+  inheritValue,
   onConfirm,
   title,
   value,
 }) => {
-  const [selected, setSelected] = useState<NameTemplateRadioOptions>(
-    value
-      ? NameTemplateRadioOptions.customNameTemplate
-      : NameTemplateRadioOptions.defaultNameTemplate,
+  const [selected, setSelected] = useState<NameTemplateOptions>(
+    getSelectedOption(value, allowInherit),
   );
   const [inputValue, setInputValue] = useState(value ?? '');
 
   return (
     <ModalForm
       title={title}
       onConfirm={async () => {
-        return selected === NameTemplateRadioOptions.customNameTemplate
+        if (selected === NameTemplateOptions.customNameTemplate && isEmpty(inputValue.trim())) {
+          throw new Error('Name template cannot be empty');
+        }
+        return selected === NameTemplateOptions.customNameTemplate
           ? onConfirm(inputValue)
           : onConfirm(undefined);
       }}
+      isDisabled={
+        selected === NameTemplateOptions.customNameTemplate &&
+        (inputValue === value || isEmpty(inputValue.trim()))
+      }
     >
       {body}
-      <Radio
-        isChecked={selected === NameTemplateRadioOptions.defaultNameTemplate}
-        name="name-template"
-        onChange={() => {
-          setSelected(NameTemplateRadioOptions.defaultNameTemplate);
-        }}
-        label="Use default naming template"
-        id="default-naming-template"
-      />
-      <Radio
-        isChecked={selected === NameTemplateRadioOptions.customNameTemplate}
-        name="name-template"
-        onChange={() => {
-          setSelected(NameTemplateRadioOptions.customNameTemplate);
-        }}
-        label="Enter custom naming template"
-        id="custom-naming-template"
-      />
-      <TextInput
-        isDisabled={selected === NameTemplateRadioOptions.defaultNameTemplate}
-        value={inputValue}
-        onChange={(_, val) => {
-          setInputValue(val);
-        }}
-      />
-      {helperText}
+      <Form>
+        <FormGroup label={fieldName} fieldId="nameTemplate" isRequired>
+          <Select
+            id="nameTemplate"
+            value={getNameTemplateStateLabel(selected, allowInherit)}
+            onSelect={(_event, val) => {
+              setSelected((val as unknown as NameTemplateOptionType)?.value);
+            }}
+          >
+            <SelectList>
+              {getNameTemplateOptions(allowInherit).map((option) => (
+                <SelectOption
+                  key={option.value}
+                  value={option}
+                  isSelected={selected === option.value}
+                  description={option.getInheritToDescription?.(inheritValue)}
+                >
+                  {option?.label}
+                </SelectOption>
+              ))}
+            </SelectList>
+          </Select>
+        </FormGroup>
+        {selected === NameTemplateOptions.customNameTemplate && (
+          <FormGroup>
+            <TextInput
+              value={inputValue}
+              onChange={(_, val) => {
+                setInputValue(val);
+              }}
+            />
+            {helperText}
+          </FormGroup>
+        )}
+      </Form>
     </ModalForm>
   );
 };

src/plans/details/tabs/Details/components/SettingsSection/components/EditNameTemplate/components/NameTemplateBody.tsx

@@ -9,7 +9,7 @@ import {
 } from '@patternfly/react-core';
 
 type NameTemplateBodyProps = {
-  bodyText: string[];
+  bodyText: string;
   allowedVariables: string[];
 };
 

src/plans/details/tabs/Details/components/SettingsSection/components/EditNameTemplate/utils/constants.ts

@@ -0,0 +1,11 @@
+export enum NameTemplateOptions {
+  defaultNameTemplate = 'defaultNameTemplate',
+  customNameTemplate = 'customNameTemplate',
+  inheritPlanWideSetting = 'inheritPlanWideSetting',
+}
+
+export type NameTemplateOptionType = {
+  value: NameTemplateOptions;
+  label: string;
+  getInheritToDescription?: (inheritValue: string | undefined) => string;
+};