CNV-41590: sysprep volume missing on creation of a VM with Sysprep

src/utils/components/SysprepModal/hooks/useConfigMaps.ts

@@ -4,6 +4,9 @@ import { useK8sWatchResource, WatchK8sResult } from '@openshift-console/dynamic-
 
 import { AUTOUNATTEND, UNATTEND } from '../sysprep-utils';
 
+const checkEqualCaseInsensitive = (a: string, b: string) =>
+  a.localeCompare(b, 'en', { sensitivity: 'base' }) === 0; // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare
+
 const useSysprepConfigMaps = (namespace: string): WatchK8sResult<IoK8sApiCoreV1ConfigMap[]> => {
   const [configmaps, configmapsLoaded, configmapsError] = useK8sWatchResource<
     IoK8sApiCoreV1ConfigMap[]
@@ -13,9 +16,15 @@ const useSysprepConfigMaps = (namespace: string): WatchK8sResult<IoK8sApiCoreV1C
     namespace,
     namespaced: true,
   });
-  const sysprepConfigMaps = configmaps?.filter(
-    (configmap) => configmap?.data?.[AUTOUNATTEND] || configmap?.data?.[UNATTEND],
-  );
+  const sysprepConfigMaps = configmaps?.filter((configmap) => {
+    const dataKeys = Object.keys(configmap?.data);
+    const hasSysprepXMLData = dataKeys.some((key) => {
+      return (
+        checkEqualCaseInsensitive(key, UNATTEND) || checkEqualCaseInsensitive(key, AUTOUNATTEND)
+      );
+    });
+    return hasSysprepXMLData;
+  });
 
   return [sysprepConfigMaps, configmapsLoaded, configmapsError];
 };

src/utils/components/SysprepModal/sysprep-utils.ts

@@ -1,20 +1,20 @@
 import { ConfigMapModel } from '@kubevirt-ui/kubevirt-api/console';
 import { IoK8sApiCoreV1ConfigMap } from '@kubevirt-ui/kubevirt-api/kubernetes';
-import { V1VirtualMachine, V1Volume } from '@kubevirt-ui/kubevirt-api/kubevirt';
-import { buildOwnerReference } from '@kubevirt-utils/resources/shared';
+import { V1Disk, V1VirtualMachine, V1Volume } from '@kubevirt-ui/kubevirt-api/kubevirt';
 import { getDisks, getVolumes } from '@kubevirt-utils/resources/vm';
-import { getRandomChars } from '@kubevirt-utils/utils/utils';
+import { generatePrettyName } from '@kubevirt-utils/utils/utils';
+
+import { SYSPREP } from './consts';
 
-export const SYSPREP = 'sysprep';
 export const AUTOUNATTEND = 'autounattend.xml';
 export const UNATTEND = 'unattend.xml';
 export const WINDOWS = 'windows';
 
 export type SysprepData = { autounattend?: string; unattended?: string };
 
-export const sysprepDisk = () => ({ cdrom: { bus: 'sata' }, name: SYSPREP });
+export const sysprepDisk = (): V1Disk => ({ cdrom: { bus: 'sata' }, name: SYSPREP });
 
-export const sysprepVolume = (sysprepName: string) => ({
+export const sysprepVolume = (sysprepName: string): V1Volume => ({
   name: SYSPREP,
   sysprep: {
     configMap: { name: sysprepName },
@@ -40,28 +40,22 @@ export const removeSysprepConfig = (vm: V1VirtualMachine, sysprepVolumeName: str
   );
 };
 
-type GenerateNewSysprepConfigInputType = {
+export const generateSysprepConfigMapName = () => generatePrettyName('sysprep-config');
+
+type GenerateNewSysprepConfig = {
   data: IoK8sApiCoreV1ConfigMap['data'];
   sysprepName?: string;
-  vm: V1VirtualMachine;
-  withOwnerReference?: boolean;
 };
 
 export const generateNewSysprepConfig = ({
   data,
   sysprepName,
-  vm,
-  withOwnerReference = false,
-}: GenerateNewSysprepConfigInputType): IoK8sApiCoreV1ConfigMap => ({
+}: GenerateNewSysprepConfig): IoK8sApiCoreV1ConfigMap => ({
   apiVersion: ConfigMapModel.apiVersion,
   data,
   kind: ConfigMapModel.kind,
   metadata: {
-    name: sysprepName || `sysprep-config-${vm?.metadata?.name}-${getRandomChars()}`,
-    namespace: vm?.metadata?.namespace,
-    ownerReferences: withOwnerReference
-      ? [buildOwnerReference(vm, { blockOwnerDeletion: false })]
-      : null,
+    name: sysprepName || generateSysprepConfigMapName(),
   },
 });
 

src/views/catalog/CreateFromInstanceTypes/components/CreateVMFooter/CreateVMFooter.tsx

@@ -13,7 +13,6 @@ import { useModal } from '@kubevirt-utils/components/ModalProvider/ModalProvider
 import { SecretSelectionOption } from '@kubevirt-utils/components/SSHSecretModal/utils/types';
 import { createSSHSecret } from '@kubevirt-utils/components/SSHSecretModal/utils/utils';
 import {
-  addSysprepConfig,
   AUTOUNATTEND,
   generateNewSysprepConfig,
   UNATTEND,
@@ -112,35 +111,29 @@ const CreateVMFooter: FC = () => {
       data: vmToCreate,
       model: VirtualMachineModel,
     })
-      .then((createdVM) => {
+      .then(async (createdVM) => {
         if (secretOption === SecretSelectionOption.addNew) {
           createSSHSecret(sshPubKey, sshSecretName, vmNamespaceTarget);
         }
 
-        // create appropriate ConfigMap and/or add it to the Windows VM if sysprep configured
         if (isWindowsOSVolume) {
-          const { data, name } = sysprepConfigMapData;
+          const { data, name, shouldCreateNewConfigMap } = sysprepConfigMapData;
           const { autounattend, unattended } = data;
 
-          if (!isEmpty(data) && !name) {
-            // the user has chosen to add new ConfigMap with new data
+          if (shouldCreateNewConfigMap) {
             const configMap = generateNewSysprepConfig({
               data: { [AUTOUNATTEND]: autounattend, [UNATTEND]: unattended },
-              vm: createdVM,
+              sysprepName: name,
             });
 
-            k8sCreate({ data: configMap, model: ConfigMapModel });
-            addSysprepConfig(createdVM, configMap.metadata.name); // add ConfigMap and related volume and disk to the new VM
-          }
-
-          if (name) {
-            // if user has chosen some existing ConfigMap from the list
-            addSysprepConfig(createdVM, name);
+            try {
+              await k8sCreate({ data: configMap, model: ConfigMapModel });
+            } catch {}
           }
         }
 
         createHeadlessService(createdVM);
-        navigate(getResourceUrl({ model: VirtualMachineModel, resource: vmToCreate }));
+        navigate(getResourceUrl({ model: VirtualMachineModel, resource: createdVM }));
       })
       .catch(setError)
       .finally(() => setIsSubmitting(false));

src/views/catalog/CreateFromInstanceTypes/components/CreateVMFooter/components/YamlAndCLIViewerModal/utils/utils.ts

@@ -3,6 +3,7 @@ import { isBootableVolumePVCKind } from '@kubevirt-utils/resources/bootableresou
 import { BootableVolume } from '@kubevirt-utils/resources/bootableresources/types';
 import { encodeKeyForVirtctlCommand } from '@kubevirt-utils/resources/secret/utils';
 import { getName, getNamespace } from '@kubevirt-utils/resources/shared';
+import { isEmpty } from '@kubevirt-utils/utils/utils';
 
 export const getCreateVMVirtctlCommand = (
   vm: V1VirtualMachine,
@@ -17,18 +18,17 @@ export const getCreateVMVirtctlCommand = (
     ? '--volume-clone-pvc='
     : '--volume-datasource=src:';
 
-  const encodedSSHCloudInitUserData = `--cloud-init-user-data ${encodeKeyForVirtctlCommand(
-    vm,
-    sshPubKey,
-  )}`;
+  const hasSSH = !isEmpty(sshPubKey);
+  const encodedSSHCloudInitUserData =
+    hasSSH && `--cloud-init-user-data ${encodeKeyForVirtctlCommand(vm, sshPubKey)}`;
 
   const commandStructure = [
     'virtctl create vm',
     `--name=${getName(vm)}`,
     `--instancetype=${vm?.spec?.instancetype?.name}`,
     `--preference=${vm?.spec?.preference?.name}`,
     `${source}${sourceMetadata}`,
-    encodedSSHCloudInitUserData,
+    ...(hasSSH ? [encodedSSHCloudInitUserData] : []),
   ];
 
   return commandStructure.filter(Boolean).join(` \\\n`);

src/views/catalog/CreateFromInstanceTypes/components/VMDetailsSection/components/SysprepDescriptionItem.tsx

@@ -8,7 +8,11 @@ import {
 } from '@catalog/CreateFromInstanceTypes/state/utils/types';
 import { useModal } from '@kubevirt-utils/components/ModalProvider/ModalProvider';
 import useSysprepConfigMaps from '@kubevirt-utils/components/SysprepModal/hooks/useConfigMaps';
-import { AUTOUNATTEND, UNATTEND } from '@kubevirt-utils/components/SysprepModal/sysprep-utils';
+import {
+  AUTOUNATTEND,
+  generateSysprepConfigMapName,
+  UNATTEND,
+} from '@kubevirt-utils/components/SysprepModal/sysprep-utils';
 import { SysprepModal } from '@kubevirt-utils/components/SysprepModal/SysprepModal';
 import VirtualMachineDescriptionItem from '@kubevirt-utils/components/VirtualMachineDescriptionItem/VirtualMachineDescriptionItem';
 import { useKubevirtTranslation } from '@kubevirt-utils/hooks/useKubevirtTranslation';
@@ -52,7 +56,8 @@ const SysprepDescriptionItem: FC = () => {
         autounattend: autoUnattend,
         unattended: unattend,
       },
-      name: '', // name of new ConfigMap will be generated and attached to VM later on its creation
+      name: generateSysprepConfigMapName(),
+      shouldCreateNewConfigMap: true,
     });
   };
 
@@ -69,6 +74,7 @@ const SysprepDescriptionItem: FC = () => {
         unattended: unattend,
       },
       name,
+      shouldCreateNewConfigMap: false,
     });
   };
 

src/views/catalog/CreateFromInstanceTypes/state/utils/state.ts

@@ -11,7 +11,7 @@ export const instanceTypeVMInitialState: InstanceTypeVMState = {
   selectedInstanceType: { name: '', namespace: null },
   selectedStorageClass: null,
   sshSecretCredentials: initialSSHCredentials,
-  sysprepConfigMapData: { data: {}, name: '' },
+  sysprepConfigMapData: { data: {}, name: '', shouldCreateNewConfigMap: false },
   vmName: '',
   volumeSnapshotSource: null,
 };

src/views/catalog/CreateFromInstanceTypes/state/utils/types.ts

@@ -38,6 +38,7 @@ export type UseBootableVolumesValues = {
 export type SysprepConfigMapData = {
   data: SysprepData;
   name: string;
+  shouldCreateNewConfigMap: boolean;
 };
 
 export type InstanceTypeVMState = {

src/views/catalog/CreateFromInstanceTypes/utils/utils.ts

@@ -9,6 +9,7 @@ import {
 } from '@kubevirt-utils/components/CloudinitModal/utils/cloudinit-utils';
 import { ACTIVATION_KEY } from '@kubevirt-utils/components/CloudinitModal/utils/constants';
 import { addSecretToVM } from '@kubevirt-utils/components/SSHSecretModal/utils/utils';
+import { sysprepDisk, sysprepVolume } from '@kubevirt-utils/components/SysprepModal/sysprep-utils';
 import { ROOTDISK } from '@kubevirt-utils/constants/constants';
 import { RHELAutomaticSubscriptionData } from '@kubevirt-utils/hooks/useRHELAutomaticSubscription/utils/types';
 import { isBootableVolumePVCKind } from '@kubevirt-utils/resources/bootableresources/helpers';
@@ -74,8 +75,14 @@ export const generateVM = (
   subscriptionData: RHELAutomaticSubscriptionData,
   autoUpdateEnabled?: boolean,
 ) => {
-  const { pvcSource, selectedBootableVolume, selectedInstanceType, sshSecretCredentials, vmName } =
-    instanceTypeState;
+  const {
+    pvcSource,
+    selectedBootableVolume,
+    selectedInstanceType,
+    sshSecretCredentials,
+    sysprepConfigMapData,
+    vmName,
+  } = instanceTypeState;
   const { sshSecretName } = sshSecretCredentials;
   const virtualmachineName = vmName ?? generatePrettyName();
 
@@ -91,6 +98,7 @@ export const generateVM = (
     null,
   );
   const isDynamic = instanceTypeState?.isDynamicSSHInjection;
+  const isSysprep = !isEmpty(sysprepConfigMapData?.name);
 
   const emptyVM: V1VirtualMachine = {
     apiVersion: `${VirtualMachineModel.apiGroup}/${VirtualMachineModel.apiVersion}`,
@@ -147,24 +155,28 @@ export const generateVM = (
         },
         spec: {
           domain: {
-            devices: {},
+            devices: {
+              ...(isSysprep ? { disks: [sysprepDisk()] } : {}),
+            },
           },
           subdomain: HEADLESS_SERVICE_NAME,
           volumes: [
             {
               dataVolume: { name: `${virtualmachineName}-volume` },
               name: ROOTDISK,
             },
-            {
-              cloudInitNoCloud: {
-                userData: createPopulatedCloudInitYAML(
-                  selectedPreference,
-                  subscriptionData,
-                  autoUpdateEnabled,
-                ),
-              },
-              name: 'cloudinitdisk',
-            },
+            isSysprep
+              ? sysprepVolume(sysprepConfigMapData?.name)
+              : {
+                  cloudInitNoCloud: {
+                    userData: createPopulatedCloudInitYAML(
+                      selectedPreference,
+                      subscriptionData,
+                      autoUpdateEnabled,
+                    ),
+                  },
+                  name: 'cloudinitdisk',
+                },
           ],
         },
       },

src/views/catalog/utils/WizardVMContext/utils/vm-produce.ts

@@ -2,7 +2,11 @@ import produce from 'immer';
 import { WritableDraft } from 'immer/dist/internal';
 
 import { V1VirtualMachine } from '@kubevirt-ui/kubevirt-api/kubevirt';
-import { sysprepDisk, sysprepVolume } from '@kubevirt-utils/components/SysprepModal/sysprep-utils';
+import {
+  generateSysprepConfigMapName,
+  sysprepDisk,
+  sysprepVolume,
+} from '@kubevirt-utils/components/SysprepModal/sysprep-utils';
 import { ensurePath } from '@kubevirt-utils/utils/utils';
 
 export const produceVMNetworks = (
@@ -65,7 +69,7 @@ export const produceVMSysprep = (vm: V1VirtualMachine, sysprepName?: string) =>
     ) {
       vmDraft.spec.template.spec.domain.devices.disks.push(sysprepDisk());
       vmDraft.spec.template.spec.volumes.push(
-        sysprepVolume(sysprepName || `sysprep-config-${vm?.metadata?.name}`),
+        sysprepVolume(sysprepName || generateSysprepConfigMapName()),
       );
     }
   });

src/views/catalog/wizard/tabs/scripts/components/sysprep-utils.ts

@@ -34,9 +34,7 @@ export const pushSysprepObject = (
   updateTabsData((tabsDraft) => {
     if (!tabsDraft?.additionalObjects) tabsDraft.additionalObjects = [];
 
-    tabsDraft.additionalObjects.push(
-      generateNewSysprepConfig({ data: sysprepData, sysprepName, vm }),
-    );
+    tabsDraft.additionalObjects.push(generateNewSysprepConfig({ data: sysprepData, sysprepName }));
   });
 };
 

src/views/templates/details/tabs/scripts/components/SysPrepItem/SysPrepItem.tsx

@@ -70,7 +70,7 @@ const SysPrepItem: FC<SysPrepItemProps> = ({ template }) => {
   };
 
   const onSysprepCreation = (newUnattended: string, newAutoUnattend: string) => {
-    const newSysPrepObject = updateSysprepObject(sysPrepObject, newUnattended, newAutoUnattend, vm);
+    const newSysPrepObject = updateSysprepObject(sysPrepObject, newUnattended, newAutoUnattend);
     const templateWithSysPrep = newSysPrepObject
       ? replaceTemplateSysprepObject(template, newSysPrepObject, currentVMSysprepName)
       : deleteTemplateSysprepObject(template, currentVMSysprepName);

src/views/templates/details/tabs/scripts/components/SysPrepItem/sysprep-utils.ts

@@ -3,7 +3,6 @@ import produce from 'immer';
 import { produceVMDisks } from '@catalog/utils/WizardVMContext';
 import { TemplateModel, V1Template } from '@kubevirt-ui/kubevirt-api/console';
 import { IoK8sApiCoreV1ConfigMap } from '@kubevirt-ui/kubevirt-api/kubernetes';
-import { V1VirtualMachine } from '@kubevirt-ui/kubevirt-api/kubevirt';
 import {
   addSysprepConfig,
   AUTOUNATTEND,
@@ -93,7 +92,6 @@ export const updateSysprepObject = (
   sysprepConfig: IoK8sApiCoreV1ConfigMap,
   unattend: string,
   autoUnattend: string,
-  vm: V1VirtualMachine,
 ): IoK8sApiCoreV1ConfigMap | undefined => {
   if (!unattend && !autoUnattend) return undefined;
 
@@ -105,6 +103,6 @@ export const updateSysprepObject = (
     });
   } else {
     const data = { [AUTOUNATTEND]: autoUnattend, [UNATTEND]: unattend };
-    return generateNewSysprepConfig({ data, vm });
+    return generateNewSysprepConfig({ data });
   }
 };

src/views/virtualmachines/details/tabs/configuration/initialrun/utils/utils.ts

@@ -2,10 +2,10 @@ import { ConfigMapModel } from '@kubevirt-ui/kubevirt-api/console';
 import VirtualMachineModel from '@kubevirt-ui/kubevirt-api/console/models/VirtualMachineModel';
 import { IoK8sApiCoreV1ConfigMap } from '@kubevirt-ui/kubevirt-api/kubernetes';
 import { V1VirtualMachine } from '@kubevirt-ui/kubevirt-api/kubevirt';
+import { SYSPREP } from '@kubevirt-utils/components/SysprepModal/consts';
 import {
   AUTOUNATTEND,
   generateNewSysprepConfig,
-  SYSPREP,
   sysprepDisk,
   sysprepVolume,
   UNATTEND,
@@ -59,7 +59,6 @@ export const createSysprepConfigMap = async (
   const configMap = generateNewSysprepConfig({
     data: sysprepData,
     sysprepName: externalSysprepConfig?.metadata?.name,
-    vm,
   });
 
   if (externalSysprepConfig) {