fix: prevent duplicated cloud-config for empty user data

Signed-off-by: Andy Lee <andy.lee@suse.com>

package.json

@@ -35,7 +35,7 @@
     "glob": "7.2.3",
     "glob-parent": "6.0.2",
     "json5": "2.2.3",
-    "@types/lodash": "4.17.24",
+    "@types/lodash": "4.17.25",
     "merge": "2.1.1",
     "node-forge": "1.4.0",
     "nth-check": "2.1.1",

pkg/harvester/components/vm-migration/ReviewMigrationStep.vue

@@ -273,19 +273,6 @@ const startMigrationAction = async() => {
 
   await plan.save();
 
-  const planOwnerRef = {
-    apiVersion:         FORKLIFT_API_VERSION,
-    kind:               'Plan',
-    name:               plan.metadata.name,
-    uid:                plan.metadata.uid,
-    blockOwnerDeletion: true,
-  };
-
-  networkMap.metadata.ownerReferences = [planOwnerRef];
-  await networkMap.save();
-  storageMap.metadata.ownerReferences = [planOwnerRef];
-  await storageMap.save();
-
   // Kick off the first migration through the model so the Migration payload
   // lives in a single place (also reused by the dashboard start/restart action).
   await plan.startMigration();

pkg/harvester/l10n/en-us.yaml

@@ -835,13 +835,13 @@ harvester:
         title: "Network Data:"
         tip: "The network-data configuration allows you to customize the instance's networking interfaces by assigning subnet configuration, virtual device creation (bonds, bridges, VLANs) routes and DNS configuration. <a href='https://cloudinit.readthedocs.io/en/latest/reference/network-config-format-v1.html' target='_blank'>Learn more</a>"
     sysprep:
-      title: Windows Sysprep Configuration
+      title: Windows Unattended & Sysprep Configuration
       description: "Configure Windows automated installation using autounattend.xml. The configuration will be stored in a Kubernetes Secret and mounted as a CD-ROM during installation. <a href='https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/automate-windows-setup' target='_blank'>Learn more</a>"
       createNew: Create new...
-      createNewTitle: Create Windows Sysprep Template
+      createNewTitle: Create Windows Unattended & Sysprep Template
       xmlContent: autounattend.xml content
       secret:
-        label: Windows Sysprep Template
+        label: Windows Unattended & Sysprep Template
       validation:
         invalidXml: Invalid XML syntax
         invalidNamespace: Invalid unattend.xml namespace. Expected 'urn:schemas-microsoft-com:unattend'

pkg/harvester/mixins/harvester-vm/impl.js

@@ -38,6 +38,10 @@ export const SSH_EXISTING_TYPE = {
 export default {
   methods: {
     hasCloudConfigComment(userScript) {
+      if (typeof userScript === 'string' && /(^|\n)\s*#cloud-config(\s|$)/.test(userScript)) {
+        return true;
+      }
+
       // Check that userData contains: #cloud-config
       const userDataDoc = userScript ? YAML.parseDocument(userScript) : YAML.parseDocument({});
       const items = userDataDoc?.contents?.items || [];
@@ -52,6 +56,14 @@ export default {
         exist = true;
       }
 
+      if (userDataDoc?.contents?.commentBefore === 'cloud-config' || userDataDoc?.contents?.commentBefore?.includes('cloud-config\n')) {
+        exist = true;
+      }
+
+      if (userDataDoc?.contents?.comment === 'cloud-config' || userDataDoc?.contents?.comment?.includes('cloud-config\n')) {
+        exist = true;
+      }
+
       items.map((item) => {
         const key = item.key;
 

pkg/harvester/mixins/harvester-vm/index.js

@@ -1211,9 +1211,10 @@ export default {
 
         userDataDoc = config.installAgent ? this.mergeQGA({ userDataDoc, ...config }) : this.deleteQGA({ userDataDoc, ...config });
         const userDataYaml = userDataDoc.toString();
+        const userDataValue = userDataDoc.toJSON();
 
-        if (userDataYaml === '{}\n') {
-          // When the YAML parsed value is '{}\n', it means that the userData is empty, then undefined is returned.
+        if (userDataValue === null || (typeof userDataValue === 'object' && !Array.isArray(userDataValue) && isEmpty(userDataValue))) {
+          // Empty userData should not create cloud-init content like `null`.
           return undefined;
         }
 

pkg/harvester/promptRemove/forklift.konveyor.io.plan.vue

@@ -68,29 +68,35 @@ export default defineComponent({
       return (this.value || []).map((plan) => {
         const planName = plan?.metadata?.name || '-';
         const namespace = plan?.metadata?.namespace || '';
+        const networkMapRef = this.getPlanMapRef(plan, 'network');
+        const storageMapRef = this.getPlanMapRef(plan, 'storage');
 
         const migrations = existing[HCI.FORKLIFT_MIGRATION]
           .filter((resource) => this.ownedByPlan(resource, plan))
-          .map((resource) => ({
-            name:      resource?.metadata?.name,
-            namespace: resource?.metadata?.namespace || namespace,
-          }));
+          .map((resource) => resource?.metadata?.name)
+          .filter(Boolean);
 
-        const matchedNetworkMap = existing[HCI.FORKLIFT_NETWORK_MAP].find((resource) => this.ownedByPlan(resource, plan));
-        const matchedStorageMap = existing[HCI.FORKLIFT_STORAGE_MAP].find((resource) => this.ownedByPlan(resource, plan));
+        const matchedNetworkMap = networkMapRef ? existing[HCI.FORKLIFT_NETWORK_MAP].find((resource) => resource?.metadata?.name === networkMapRef.name && resource?.metadata?.namespace === networkMapRef.namespace) : null;
+        const matchedStorageMap = storageMapRef ? existing[HCI.FORKLIFT_STORAGE_MAP].find((resource) => resource?.metadata?.name === storageMapRef.name && resource?.metadata?.namespace === storageMapRef.namespace) : null;
 
         return {
           planName,
           namespace,
           migrations,
           networkMap: matchedNetworkMap ? {
-            namespace: matchedNetworkMap?.metadata?.namespace || namespace,
+            namespace: matchedNetworkMap?.metadata?.namespace || networkMapRef?.namespace || namespace,
             name:      matchedNetworkMap?.metadata?.name,
-          } : null,
+          } : (networkMapRef ? {
+            namespace: networkMapRef.namespace,
+            name:      networkMapRef.name,
+          } : null),
           storageMap: matchedStorageMap ? {
-            namespace: matchedStorageMap?.metadata?.namespace || namespace,
+            namespace: matchedStorageMap?.metadata?.namespace || storageMapRef?.namespace || namespace,
             name:      matchedStorageMap?.metadata?.name,
-          } : null,
+          } : (storageMapRef ? {
+            namespace: storageMapRef.namespace,
+            name:      storageMapRef.name,
+          } : null),
         };
       });
     },
@@ -113,6 +119,20 @@ export default defineComponent({
   methods: {
     resourceNames,
 
+    getPlanMapRef(plan, mapType) {
+      const ref = plan?.spec?.map?.[mapType];
+      const name = ref?.name;
+
+      if (!name) {
+        return null;
+      }
+
+      return {
+        name,
+        namespace: ref?.namespace || plan?.metadata?.namespace || '',
+      };
+    },
+
     /**
      * Determine whether a related resource (migration / network map / storage map)
      * is owned by the given plan by inspecting its `metadata.ownerReferences`.
@@ -137,9 +157,8 @@ export default defineComponent({
       const existing = this.existingRelatedResources;
       const targets = new Map();
 
-      const addTarget = (type, resource) => {
-        const name = resource?.metadata?.name;
-        const ns = resource?.metadata?.namespace;
+      const addTarget = (type, name, namespace) => {
+        const ns = namespace || '';
 
         if (!name) {
           return;
@@ -153,17 +172,20 @@ export default defineComponent({
       };
 
       for (const plan of this.value || []) {
-        existing[HCI.FORKLIFT_NETWORK_MAP]
-          .filter((resource) => this.ownedByPlan(resource, plan))
-          .forEach((resource) => addTarget(HCI.FORKLIFT_NETWORK_MAP, resource));
+        const networkMapRef = this.getPlanMapRef(plan, 'network');
+        const storageMapRef = this.getPlanMapRef(plan, 'storage');
 
-        existing[HCI.FORKLIFT_STORAGE_MAP]
-          .filter((resource) => this.ownedByPlan(resource, plan))
-          .forEach((resource) => addTarget(HCI.FORKLIFT_STORAGE_MAP, resource));
+        if (networkMapRef) {
+          addTarget(HCI.FORKLIFT_NETWORK_MAP, networkMapRef.name, networkMapRef.namespace);
+        }
+
+        if (storageMapRef) {
+          addTarget(HCI.FORKLIFT_STORAGE_MAP, storageMapRef.name, storageMapRef.namespace);
+        }
 
         existing[HCI.FORKLIFT_MIGRATION]
           .filter((resource) => this.ownedByPlan(resource, plan))
-          .forEach((resource) => addTarget(HCI.FORKLIFT_MIGRATION, resource));
+          .forEach((resource) => addTarget(HCI.FORKLIFT_MIGRATION, resource?.metadata?.name, resource?.metadata?.namespace));
       }
 
       return [...targets.values()];
@@ -256,11 +278,11 @@ export default defineComponent({
       <div>• {{ t('harvester.addons.vmMigration.labels.migration') }}:</div>
       <template v-if="summary.migrations.length">
         <div
-          v-for="migration in summary.migrations"
-          :key="`${ migration.namespace }/${ migration.name }`"
+          v-for="migrationName in summary.migrations"
+          :key="migrationName"
         >
           <div class="ml-20">
-            - {{ migration.name }}
+            - {{ migrationName }}
           </div>
         </div>
       </template>

yarn.lock

@@ -2825,10 +2825,10 @@
   resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee"
   integrity sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==
 
-"@types/lodash@4.17.24":
-  version "4.17.24"
-  resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.17.24.tgz#4ae334fc62c0e915ca8ed8e35dcc6d4eeb29215f"
-  integrity sha512-gIW7lQLZbue7lRSWEFql49QJJWThrTFFeIMJdp3eH4tKoxm1OvEPg02rm4wCCSHS0cL3/Fizimb35b7k8atwsQ==
+"@types/lodash@4.17.25":
+  version "4.17.25"
+  resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.17.25.tgz#69765ac7bcddb0eb072961cf292524a8f5b3c2c0"
+  integrity sha512-+K1NIO8I+F9/wNulfVvu23QYd0Pe9/OCqRrim4NoYIf1VoEDL90Ve4ClzpyqBLc7NpGGWRvYNCKZ1BE/Jpf8dQ==
 
 "@types/mime@^1":
   version "1.3.5"
@@ -4367,24 +4367,6 @@ bn.js@^5.2.1, bn.js@^5.2.2:
   resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-5.2.3.tgz#16a9e409616b23fef3ccbedb8d42f13bff80295e"
   integrity sha512-EAcmnPkxpntVL+DS7bO1zhcZNvCkxqtkd0ZY53h06GNQ3DEkkGZ/gKgmDv6DdZQGj9BgfSPKtJJ7Dp1GPP8f7w==
 
-body-parser@~1.20.3:
-  version "1.20.4"
-  resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.20.4.tgz#f8e20f4d06ca8a50a71ed329c15dccad1cdc547f"
-  integrity sha512-ZTgYYLMOXY9qKU/57FAo8F+HA2dGX7bqGc71txDRC1rS4frdFI5R7NhluHxH6M0YItAP0sHB4uqAOcYKxO6uGA==
-  dependencies:
-    bytes "~3.1.2"
-    content-type "~1.0.5"
-    debug "2.6.9"
-    depd "2.0.0"
-    destroy "~1.2.0"
-    http-errors "~2.0.1"
-    iconv-lite "~0.4.24"
-    on-finished "~2.4.1"
-    qs "~6.14.0"
-    raw-body "~2.5.3"
-    type-is "~1.6.18"
-    unpipe "~1.0.0"
-
 body-parser@~1.20.5:
   version "1.20.6"
   resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.20.6.tgz#60c789c78e0992d906da0a29d71ae01d15c1ed76"
@@ -6685,7 +6667,7 @@ expect@^27.5.1:
     jest-matcher-utils "^27.5.1"
     jest-message-util "^27.5.1"
 
-express@4.22.2:
+express@4.22.2, express@^4.17.3:
   version "4.22.2"
   resolved "https://registry.yarnpkg.com/express/-/express-4.22.2.tgz#c17ae0981e5efc24b22272f0e041c4662503b700"
   integrity sha512-IuL+Elrou2ZvCFHs18/CIzy2Nzvo25nZ1/D2eIZlz7c+QUayAcYoiM2BthCjs+EBHVpjYjcuLDAiCWgeIX3X1Q==
@@ -6722,43 +6704,6 @@ express@4.22.2:
     utils-merge "1.0.1"
     vary "~1.1.2"
 
-express@^4.17.3:
-  version "4.22.1"
-  resolved "https://registry.yarnpkg.com/express/-/express-4.22.1.tgz#1de23a09745a4fffdb39247b344bb5eaff382069"
-  integrity sha512-F2X8g9P1X7uCPZMA3MVf9wcTqlyNp7IhH5qPCI0izhaOIYXaW9L535tGA3qmjRzpH+bZczqq7hVKxTR4NWnu+g==
-  dependencies:
-    accepts "~1.3.8"
-    array-flatten "1.1.1"
-    body-parser "~1.20.3"
-    content-disposition "~0.5.4"
-    content-type "~1.0.4"
-    cookie "~0.7.1"
-    cookie-signature "~1.0.6"
-    debug "2.6.9"
-    depd "2.0.0"
-    encodeurl "~2.0.0"
-    escape-html "~1.0.3"
-    etag "~1.8.1"
-    finalhandler "~1.3.1"
-    fresh "~0.5.2"
-    http-errors "~2.0.0"
-    merge-descriptors "1.0.3"
-    methods "~1.1.2"
-    on-finished "~2.4.1"
-    parseurl "~1.3.3"
-    path-to-regexp "~0.1.12"
-    proxy-addr "~2.0.7"
-    qs "~6.14.0"
-    range-parser "~1.2.1"
-    safe-buffer "5.2.1"
-    send "~0.19.0"
-    serve-static "~1.16.2"
-    setprototypeof "1.2.0"
-    statuses "~2.0.1"
-    type-is "~1.6.18"
-    utils-merge "1.0.1"
-    vary "~1.1.2"
-
 extend-shallow@^2.0.1:
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/extend-shallow/-/extend-shallow-2.0.1.tgz#51af7d614ad9a9f610ea1bafbb989d6b1c56890f"
@@ -10384,7 +10329,7 @@ punycode@^2.1.0, punycode@^2.1.1, punycode@^2.3.0, punycode@^2.3.1:
   resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.1.tgz#027422e2faec0b25e1549c3e1bd8309b9133b6e5"
   integrity sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==
 
-qs@6.15.3, qs@^6.12.3, qs@~6.14.0, qs@~6.15.1:
+qs@6.15.3, qs@^6.12.3, qs@~6.15.1:
   version "6.15.3"
   resolved "https://registry.yarnpkg.com/qs/-/qs-6.15.3.tgz#76852132a58ed5c7c0ef67e4441b9bb5d6061b3b"
   integrity sha512-O9gl3zCl5h5blw1KGUzQKhA5oUXSl8rwUIM5o0S3nCXMliSvy5Dzx7/DJcI+SwgICv+IneSZwhBh1oSyEHA71A==