Add support for network data in Config Drive

vishesh92 · vishesh92 · commit 9d59c87df0f9 · 2024-07-03T13:28:05.000+05:30
diff --git a/engine/orchestration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java b/engine/orchestration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java
@@ -1798,6 +1798,7 @@ protected boolean prepareElement(final NetworkElement element, final Network net
                                      final ReservationContext context) throws InsufficientCapacityException, ConcurrentOperationException, ResourceUnavailableException {
         element.prepare(network, profile, vmProfile, dest, context);
         if (vmProfile.getType() == Type.User && element.getProvider() != null) {
+            boolean buildConfigDrive = false;
             if (_networkModel.areServicesSupportedInNetwork(network.getId(), Service.Dhcp)
                     && _networkModel.isProviderSupportServiceInNetwork(network.getId(), Service.Dhcp, element.getProvider()) && element instanceof DhcpServiceProvider) {
                 final DhcpServiceProvider sp = (DhcpServiceProvider) element;
@@ -1809,6 +1810,7 @@ protected boolean prepareElement(final NetworkElement element, final Network net
                 if (!sp.addDhcpEntry(network, profile, vmProfile, dest, context)) {
                     return false;
                 }
+                buildConfigDrive = true;
             }
             if (_networkModel.areServicesSupportedInNetwork(network.getId(), Service.Dns)
                     && _networkModel.isProviderSupportServiceInNetwork(network.getId(), Service.Dns, element.getProvider()) && element instanceof DnsServiceProvider) {
@@ -1821,13 +1823,19 @@ protected boolean prepareElement(final NetworkElement element, final Network net
                 if (!sp.addDnsEntry(network, profile, vmProfile, dest, context)) {
                     return false;
                 }
+                buildConfigDrive = true;
             }
             if (_networkModel.areServicesSupportedInNetwork(network.getId(), Service.UserData)
                     && _networkModel.isProviderSupportServiceInNetwork(network.getId(), Service.UserData, element.getProvider()) && element instanceof UserDataServiceProvider) {
                 final UserDataServiceProvider sp = (UserDataServiceProvider) element;
                 if (!sp.addPasswordAndUserdata(network, profile, vmProfile, dest, context)) {
                     return false;
                 }
+                buildConfigDrive = true;
+            }
+            if (buildConfigDrive && element instanceof ConfigDriveNetworkElement) {
+                final ConfigDriveNetworkElement sp = (ConfigDriveNetworkElement) element;
+                return sp.createConfigDriveIso(profile, vmProfile, dest, null);
             }
         }
         return true;
diff --git a/engine/storage/configdrive/src/main/java/org/apache/cloudstack/storage/configdrive/ConfigDriveBuilder.java b/engine/storage/configdrive/src/main/java/org/apache/cloudstack/storage/configdrive/ConfigDriveBuilder.java
@@ -33,6 +33,8 @@
 import java.util.Map;
 import java.util.Set;
 
+import com.cloud.vm.NicProfile;
+import com.googlecode.ipv6.IPv6Network;
 import org.apache.commons.codec.binary.Base64;
 import org.apache.commons.collections.MapUtils;
 import org.apache.commons.io.FileUtils;
@@ -108,9 +110,9 @@ public static File base64StringToFile(String encodedIsoData, String folder, Stri
      *  This method will build the metadata files required by OpenStack driver. Then, an ISO is going to be generated and returned as a String in base 64.
      *  If vmData is null, we throw a {@link CloudRuntimeException}. Moreover, {@link IOException} are captured and re-thrown as {@link CloudRuntimeException}.
      */
-    public static String buildConfigDrive(List<String[]> vmData, String isoFileName, String driveLabel, Map<String, String> customUserdataParams) {
-        if (vmData == null) {
-            throw new CloudRuntimeException("No VM metadata provided");
+    public static String buildConfigDrive(NicProfile nic, List<String[]> vmData, String isoFileName, String driveLabel, Map<String, String> customUserdataParams) {
+        if (vmData == null && nic == null) {
+            throw new CloudRuntimeException("No VM metadata and nic profile provided");
         }
 
         Path tempDir = null;
@@ -122,6 +124,7 @@ public static String buildConfigDrive(List<String[]> vmData, String isoFileName,
             File openStackFolder = new File(tempDirName + ConfigDrive.openStackConfigDriveName);
 
             writeVendorAndNetworkEmptyJsonFile(openStackFolder);
+            writeNetworkData(nic, tempDirName, openStackFolder);
             writeVmMetadata(vmData, tempDirName, openStackFolder, customUserdataParams);
 
             linkUserData(tempDirName);
@@ -211,6 +214,14 @@ static void writeVmMetadata(List<String[]> vmData, String tempDirName, File open
         writeFile(openStackFolder, "meta_data.json", metaData.toString());
     }
 
+    /**
+     * First we generate a JSON object using {@link #createJsonObjectWithNic(NicProfile)}, then we write it to a file called "network_data.json".
+     */
+    static void writeNetworkData(NicProfile nic, String tempDirName, File openStackFolder) {
+        JsonObject networkData = createJsonObjectWithNic(nic);
+        writeFile(openStackFolder, "network_data.json", networkData.toString());
+    }
+
     /**
      *  Writes the following empty JSON files:
      *  <ul>
@@ -250,6 +261,83 @@ static JsonObject createJsonObjectWithVmData(List<String[]> vmData, String tempD
         return metaData;
     }
 
+    /**
+     * Creates the {@link JsonObject} with NIC's metadata. We expect the JSONObject to have the following entries:
+     */
+    static JsonObject createJsonObjectWithNic(NicProfile nic) {
+        // TODO: Check if we actually need to read the existing file and upsert the data to support multiple networks
+        JsonObject networkData = new JsonObject();
+        JsonArray links = new JsonArray();
+        JsonArray networks = new JsonArray();
+        JsonArray services = new JsonArray();
+
+        if (StringUtils.isNotBlank(nic.getMacAddress())) {
+            JsonObject link = new JsonObject();
+            link.addProperty("ethernet_mac_address", nic.getMacAddress());
+            link.addProperty("id", "eth0");
+            link.addProperty("mtu", 1500);
+            link.addProperty("type", "phy");
+            links.add(link);
+        }
+
+        if (StringUtils.isNotBlank(nic.getIPv4Address())) {
+            JsonObject ipv4Network = new JsonObject();
+            ipv4Network.addProperty("id", nic.getIPv4Address());
+            ipv4Network.addProperty("ip_address", nic.getIPv4Address());
+            ipv4Network.addProperty("link", "eth0");
+            ipv4Network.addProperty("netmask", nic.getIPv4Netmask());
+            ipv4Network.addProperty("network_id", nic.getNetworkId());
+            ipv4Network.addProperty("type", "ipv4");
+
+            JsonObject ipv4Route = new JsonObject();
+            ipv4Route.addProperty("gateway", nic.getIPv4Gateway());
+            ipv4Route.addProperty("netmask", "0.0.0.0");
+            ipv4Route.addProperty("network", "0.0.0.0");
+            networks.add(ipv4Network);
+        }
+
+        if (StringUtils.isNotBlank(nic.getIPv6Address())) {
+            JsonObject ipv6Network = new JsonObject();
+            ipv6Network.addProperty("id", nic.getIPv6Address());
+            ipv6Network.addProperty("ip_address", nic.getIPv6Address());
+            ipv6Network.addProperty("link", "eth0");
+            ipv6Network.addProperty("netmask", IPv6Network.fromString(nic.getIPv6Cidr()).getNetmask().toString());
+            ipv6Network.addProperty("network_id", nic.getNetworkId());
+            ipv6Network.addProperty("type", "ipv6");
+
+            JsonObject ipv6Route = new JsonObject();
+            ipv6Route.addProperty("gateway", nic.getIPv6Gateway());
+            ipv6Route.addProperty("netmask", "0");
+            ipv6Route.addProperty("network", "::");
+            networks.add(ipv6Network);
+        }
+
+        if (StringUtils.isNotBlank(nic.getIPv4Dns1())) {
+            services.add(getDnsServiceObject(nic.getIPv4Dns1()));
+        }
+
+        if (StringUtils.isNotBlank(nic.getIPv4Dns2())) {
+            services.add(getDnsServiceObject(nic.getIPv4Dns2()));
+        }
+
+        if (StringUtils.isNotBlank(nic.getIPv6Dns1())) {
+            services.add(getDnsServiceObject(nic.getIPv6Dns1()));
+        }
+
+        if (StringUtils.isNotBlank(nic.getIPv6Dns2())) {
+            services.add(getDnsServiceObject(nic.getIPv6Dns2()));
+        }
+
+        return networkData;
+    }
+
+    private static JsonObject getDnsServiceObject(String dnsAddress) {
+        JsonObject dnsService = new JsonObject();
+        dnsService.addProperty("address", dnsAddress);
+        dnsService.addProperty("type", "dns");
+        return dnsService;
+    }
+
     static void createFileInTempDirAnAppendOpenStackMetadataToJsonObject(String tempDirName, JsonObject metaData, String dataType, String fileName, String content, Map<String, String> customUserdataParams) {
         if (StringUtils.isBlank(dataType)) {
             return;
diff --git a/engine/storage/configdrive/src/test/java/org/apache/cloudstack/storage/configdrive/ConfigDriveBuilderTest.java b/engine/storage/configdrive/src/test/java/org/apache/cloudstack/storage/configdrive/ConfigDriveBuilderTest.java
@@ -113,15 +113,15 @@ public void base64StringToFileTest() throws Exception {
 
     @Test(expected = CloudRuntimeException.class)
     public void buildConfigDriveTestNoVmData() {
-        ConfigDriveBuilder.buildConfigDrive(null, "teste", "C:", null);
+        ConfigDriveBuilder.buildConfigDrive(null, null, "teste", "C:", null);
     }
 
     @Test(expected = CloudRuntimeException.class)
     public void buildConfigDriveTestIoException() {
         try (MockedStatic<ConfigDriveBuilder> configDriveBuilderMocked = Mockito.mockStatic(ConfigDriveBuilder.class)) {
             configDriveBuilderMocked.when(() -> ConfigDriveBuilder.writeVendorAndNetworkEmptyJsonFile(nullable(File.class))).thenThrow(CloudRuntimeException.class);
-            Mockito.when(ConfigDriveBuilder.buildConfigDrive(new ArrayList<>(), "teste", "C:", null)).thenCallRealMethod();
-            ConfigDriveBuilder.buildConfigDrive(new ArrayList<>(), "teste", "C:", null);
+            Mockito.when(ConfigDriveBuilder.buildConfigDrive(null, new ArrayList<>(), "teste", "C:", null)).thenCallRealMethod();
+            ConfigDriveBuilder.buildConfigDrive(null, new ArrayList<>(), "teste", "C:", null);
         }
     }
 
@@ -137,9 +137,9 @@ public void buildConfigDriveTest() {
 
             configDriveBuilderMocked.when(() -> ConfigDriveBuilder.generateAndRetrieveIsoAsBase64Iso(Mockito.anyString(), Mockito.anyString(), Mockito.anyString())).thenAnswer(invocation -> "mockIsoDataBase64");
             //force execution of real method
-            Mockito.when(ConfigDriveBuilder.buildConfigDrive(new ArrayList<>(), "teste", "C:", null)).thenCallRealMethod();
+            Mockito.when(ConfigDriveBuilder.buildConfigDrive(null, new ArrayList<>(), "teste", "C:", null)).thenCallRealMethod();
 
-            String returnedIsoData = ConfigDriveBuilder.buildConfigDrive(new ArrayList<>(), "teste", "C:", null);
+            String returnedIsoData = ConfigDriveBuilder.buildConfigDrive(null, new ArrayList<>(), "teste", "C:", null);
 
             Assert.assertEquals("mockIsoDataBase64", returnedIsoData);
 
diff --git a/server/src/main/java/com/cloud/network/element/ConfigDriveNetworkElement.java b/server/src/main/java/com/cloud/network/element/ConfigDriveNetworkElement.java
@@ -90,7 +90,8 @@
 import com.cloud.vm.dao.UserVmDao;
 import com.cloud.vm.dao.UserVmDetailsDao;
 
-public class ConfigDriveNetworkElement extends AdapterBase implements NetworkElement, UserDataServiceProvider,
+public class ConfigDriveNetworkElement extends AdapterBase implements NetworkElement,
+        UserDataServiceProvider, DhcpServiceProvider, DnsServiceProvider,
         StateListener<VirtualMachine.State, VirtualMachine.Event, VirtualMachine>, NetworkMigrationResponder {
 
     private static final Map<Service, Map<Capability, String>> capabilities = setCapabilities();
@@ -197,6 +198,8 @@ public Map<Service, Map<Capability, String>> getCapabilities() {
     private static Map<Service, Map<Capability, String>> setCapabilities() {
         Map<Service, Map<Capability, String>> capabilities = new HashMap<>();
         capabilities.put(Service.UserData, null);
+        capabilities.put(Service.Dhcp, null);
+        capabilities.put(Service.Dns, null);
         return capabilities;
     }
 
@@ -225,7 +228,7 @@ public boolean addPasswordAndUserdata(Network network, NicProfile nic, VirtualMa
             throws ConcurrentOperationException, InsufficientCapacityException, ResourceUnavailableException {
         return (canHandle(network.getTrafficType())
                 && configureConfigDriveData(profile, nic, dest))
-                && createConfigDriveIso(profile, dest, null);
+                && createConfigDriveIso(nic, profile, dest, null);
     }
 
     @Override
@@ -342,10 +345,13 @@ public boolean prepareMigration(NicProfile nic, Network network, VirtualMachineP
                     configureConfigDriveData(vm, nic, dest);
 
                     // Create the config drive on dest host cache
-                    createConfigDriveIsoOnHostCache(vm, dest.getHost().getId());
+                    createConfigDriveIsoOnHostCache(nic, vm, dest.getHost().getId());
                 } else {
                     vm.setConfigDriveLocation(getConfigDriveLocation(vm.getId()));
-                    addPasswordAndUserdata(network, nic, vm, dest, context);
+                    boolean result = addPasswordAndUserdata(network, nic, vm, dest, context);
+                    if (result) {
+                        createConfigDriveIso(nic, vm, dest, null);
+                    }
                 }
             } catch (InsufficientCapacityException | ResourceUnavailableException e) {
                 logger.error("Failed to add config disk drive due to: ", e);
@@ -398,7 +404,7 @@ private void recreateConfigDriveIso(NicProfile nic, Network network, VirtualMach
                         vm.getUuid(), nic.getMacAddress(), userVm.getDetail("SSH.PublicKey"), (String) vm.getParameter(VirtualMachineProfile.Param.VmPassword), isWindows, VirtualMachineManager.getHypervisorHostname(dest.getHost() != null ? dest.getHost().getName() : ""));
                 vm.setVmData(vmData);
                 vm.setConfigDriveLabel(VirtualMachineManager.VmConfigDriveLabel.value());
-                createConfigDriveIso(vm, dest, diskToUse);
+                createConfigDriveIso(nic, vm, dest, diskToUse);
             }
         }
     }
@@ -528,7 +534,7 @@ private boolean isConfigDriveIsoOnHostCache(long vmId) {
         return false;
     }
 
-    private boolean createConfigDriveIsoOnHostCache(VirtualMachineProfile profile, Long hostId) throws ResourceUnavailableException {
+    private boolean createConfigDriveIsoOnHostCache(NicProfile nic, VirtualMachineProfile profile, Long hostId) throws ResourceUnavailableException {
         if (hostId == null) {
             throw new ResourceUnavailableException("Config drive iso creation failed, dest host not available",
                     ConfigDriveNetworkElement.class, 0L);
@@ -540,7 +546,7 @@ private boolean createConfigDriveIsoOnHostCache(VirtualMachineProfile profile, L
 
         final String isoFileName = ConfigDrive.configIsoFileName(profile.getInstanceName());
         final String isoPath = ConfigDrive.createConfigDrivePath(profile.getInstanceName());
-        final String isoData = ConfigDriveBuilder.buildConfigDrive(profile.getVmData(), isoFileName, profile.getConfigDriveLabel(), customUserdataParamMap);
+        final String isoData = ConfigDriveBuilder.buildConfigDrive(nic, profile.getVmData(), isoFileName, profile.getConfigDriveLabel(), customUserdataParamMap);
         final HandleConfigDriveIsoCommand configDriveIsoCommand = new HandleConfigDriveIsoCommand(isoPath, isoData, null, false, true, true);
 
         final HandleConfigDriveIsoAnswer answer = (HandleConfigDriveIsoAnswer) agentManager.easySend(hostId, configDriveIsoCommand);
@@ -590,7 +596,7 @@ private boolean deleteConfigDriveIsoOnHostCache(final VirtualMachine vm, final L
         return true;
     }
 
-    private boolean createConfigDriveIso(VirtualMachineProfile profile, DeployDestination dest, DiskTO disk) throws ResourceUnavailableException {
+    public boolean createConfigDriveIso(NicProfile nic, VirtualMachineProfile profile, DeployDestination dest, DiskTO disk) throws ResourceUnavailableException {
         DataStore dataStore = getDatastoreForConfigDriveIso(disk, profile, dest);
 
         final Long agentId = findAgentId(profile, dest, dataStore);
@@ -605,7 +611,7 @@ private boolean createConfigDriveIso(VirtualMachineProfile profile, DeployDestin
 
         final String isoFileName = ConfigDrive.configIsoFileName(profile.getInstanceName());
         final String isoPath = ConfigDrive.createConfigDrivePath(profile.getInstanceName());
-        final String isoData = ConfigDriveBuilder.buildConfigDrive(profile.getVmData(), isoFileName, profile.getConfigDriveLabel(), customUserdataParamMap);
+        final String isoData = ConfigDriveBuilder.buildConfigDrive(nic, profile.getVmData(), isoFileName, profile.getConfigDriveLabel(), customUserdataParamMap);
         boolean useHostCacheOnUnsupportedPool = VirtualMachineManager.VmConfigDriveUseHostCacheOnUnsupportedPool.valueIn(dest.getDataCenter().getId());
         boolean preferHostCache = VirtualMachineManager.VmConfigDriveForceHostCacheUse.valueIn(dest.getDataCenter().getId());
         final HandleConfigDriveIsoCommand configDriveIsoCommand = new HandleConfigDriveIsoCommand(isoPath, isoData, dataStore.getTO(), useHostCacheOnUnsupportedPool, preferHostCache, true);
@@ -758,4 +764,52 @@ private boolean configureConfigDriveData(final VirtualMachineProfile profile, fi
         return true;
     }
 
+    @Override
+    public boolean addDhcpEntry(Network network, NicProfile nic, VirtualMachineProfile vm, DeployDestination dest,
+            ReservationContext context) throws ConcurrentOperationException, InsufficientCapacityException, ResourceUnavailableException {
+        // Update nic profile with required information.
+        // Add network checks
+        return true;
+    }
+
+    @Override
+    public boolean configDhcpSupportForSubnet(Network network, NicProfile nic, VirtualMachineProfile vm,
+            DeployDestination dest,
+            ReservationContext context) throws ConcurrentOperationException, InsufficientCapacityException, ResourceUnavailableException {
+        return false;
+    }
+
+    @Override
+    public boolean removeDhcpSupportForSubnet(Network network) throws ResourceUnavailableException {
+        return true;
+    }
+
+    @Override
+    public boolean setExtraDhcpOptions(Network network, long nicId, Map<Integer, String> dhcpOptions) {
+        return false;
+    }
+
+    @Override
+    public boolean removeDhcpEntry(Network network, NicProfile nic,
+            VirtualMachineProfile vmProfile) throws ResourceUnavailableException {
+        return true;
+    }
+
+    @Override
+    public boolean addDnsEntry(Network network, NicProfile nic, VirtualMachineProfile vm, DeployDestination dest,
+            ReservationContext context) throws ConcurrentOperationException, InsufficientCapacityException, ResourceUnavailableException {
+        return true;
+    }
+
+    @Override
+    public boolean configDnsSupportForSubnet(Network network, NicProfile nic, VirtualMachineProfile vm,
+            DeployDestination dest,
+            ReservationContext context) throws ConcurrentOperationException, InsufficientCapacityException, ResourceUnavailableException {
+        return true;
+    }
+
+    @Override
+    public boolean removeDnsSupportForSubnet(Network network) throws ResourceUnavailableException {
+        return true;
+    }
 }
diff --git a/server/src/test/java/com/cloud/network/element/ConfigDriveNetworkElementTest.java b/server/src/test/java/com/cloud/network/element/ConfigDriveNetworkElementTest.java
@@ -264,7 +264,7 @@ public void testAddPasswordAndUserData() throws Exception {
         try (MockedStatic<ConfigDriveBuilder> ignored1 = Mockito.mockStatic(ConfigDriveBuilder.class); MockedStatic<CallContext> ignored2 = Mockito.mockStatic(CallContext.class)) {
             Mockito.when(CallContext.current()).thenReturn(callContextMock);
             Mockito.doReturn(Mockito.mock(Account.class)).when(callContextMock).getCallingAccount();
-            Mockito.when(ConfigDriveBuilder.buildConfigDrive(Mockito.anyList(), Mockito.anyString(), Mockito.anyString(), Mockito.anyMap())).thenReturn("content");
+            Mockito.when(ConfigDriveBuilder.buildConfigDrive(Mockito.any(NicProfile.class), Mockito.anyList(), Mockito.anyString(), Mockito.anyString(), Mockito.anyMap())).thenReturn("content");
 
             final HandleConfigDriveIsoAnswer answer = mock(HandleConfigDriveIsoAnswer.class);
             final UserVmDetailVO userVmDetailVO = mock(UserVmDetailVO.class);

Original file line number	Diff line number	Diff line change
`@@ -1798,6 +1798,7 @@ protected boolean prepareElement(final NetworkElement element, final Network net`
`1798`	`1798`	`final ReservationContext context) throws InsufficientCapacityException, ConcurrentOperationException, ResourceUnavailableException {`
`1799`	`1799`	`element.prepare(network, profile, vmProfile, dest, context);`
`1800`	`1800`	`if (vmProfile.getType() == Type.User && element.getProvider() != null) {`
	`1801`	`+ boolean buildConfigDrive = false;`
`1801`	`1802`	`if (_networkModel.areServicesSupportedInNetwork(network.getId(), Service.Dhcp)`
`1802`	`1803`	`&& _networkModel.isProviderSupportServiceInNetwork(network.getId(), Service.Dhcp, element.getProvider()) && element instanceof DhcpServiceProvider) {`
`1803`	`1804`	`final DhcpServiceProvider sp = (DhcpServiceProvider) element;`
`@@ -1809,6 +1810,7 @@ protected boolean prepareElement(final NetworkElement element, final Network net`
`1809`	`1810`	`if (!sp.addDhcpEntry(network, profile, vmProfile, dest, context)) {`
`1810`	`1811`	`return false;`
`1811`	`1812`	`}`
	`1813`	`+ buildConfigDrive = true;`
`1812`	`1814`	`}`
`1813`	`1815`	`if (_networkModel.areServicesSupportedInNetwork(network.getId(), Service.Dns)`
`1814`	`1816`	`&& _networkModel.isProviderSupportServiceInNetwork(network.getId(), Service.Dns, element.getProvider()) && element instanceof DnsServiceProvider) {`
`@@ -1821,13 +1823,19 @@ protected boolean prepareElement(final NetworkElement element, final Network net`
`1821`	`1823`	`if (!sp.addDnsEntry(network, profile, vmProfile, dest, context)) {`
`1822`	`1824`	`return false;`
`1823`	`1825`	`}`
	`1826`	`+ buildConfigDrive = true;`
`1824`	`1827`	`}`
`1825`	`1828`	`if (_networkModel.areServicesSupportedInNetwork(network.getId(), Service.UserData)`
`1826`	`1829`	`&& _networkModel.isProviderSupportServiceInNetwork(network.getId(), Service.UserData, element.getProvider()) && element instanceof UserDataServiceProvider) {`
`1827`	`1830`	`final UserDataServiceProvider sp = (UserDataServiceProvider) element;`
`1828`	`1831`	`if (!sp.addPasswordAndUserdata(network, profile, vmProfile, dest, context)) {`
`1829`	`1832`	`return false;`
`1830`	`1833`	`}`
	`1834`	`+ buildConfigDrive = true;`
	`1835`	`+ }`
	`1836`	`+ if (buildConfigDrive && element instanceof ConfigDriveNetworkElement) {`
	`1837`	`+ final ConfigDriveNetworkElement sp = (ConfigDriveNetworkElement) element;`
	`1838`	`+ return sp.createConfigDriveIso(profile, vmProfile, dest, null);`
`1831`	`1839`	`}`
`1832`	`1840`	`}`
`1833`	`1841`	`return true;`