Support for Specialized image (#346)

Co-authored-by: V R Ramakrishna Rao <Ramakrishna.Rao@in.bosch.com>

Author: ramakrishnaraov

src/main/java/com/microsoft/azure/vmagent/AzureVMAgentTemplate.java

@@ -100,6 +100,7 @@ public static class ImageReferenceTypeClass implements Serializable {
         private String galleryName;
         private String galleryImageDefinition;
         private String galleryImageVersion;
+        private boolean galleryImageSpecialized;
         private String gallerySubscriptionId;
         private String galleryResourceGroup;
         private ImageReferenceType type;
@@ -189,6 +190,14 @@ public String getGalleryImageVersion() {
             return galleryImageVersion;
         }
 
+        public boolean getGalleryImageSpecialized() {
+            return galleryImageSpecialized;
+        }
+        @DataBoundSetter
+        public void setGalleryImageSpecialized(boolean galleryImageSpecialized) {
+            this.galleryImageSpecialized = galleryImageSpecialized;
+        }
+
         public String getGallerySubscriptionId() {
             return gallerySubscriptionId;
         }
@@ -506,6 +515,14 @@ public String getGalleryImageVersion() {
         return imageReference != null ? imageReference.getGalleryImageVersion() : null;
     }
 
+    /**
+     * Used by jelly for loading the data, not written to.
+     */
+    @Restricted(NoExternalUse.class)
+    public boolean getGalleryImageSpecialized() {
+        return imageReference != null ? imageReference.getGalleryImageSpecialized() : false;
+    }
+
     /**
      * Used by jelly for loading the data, not written to.
      */
@@ -1234,6 +1251,7 @@ public AdvancedImage getAdvancedImageInside() {
                         imageReference.galleryName,
                         imageReference.galleryImageDefinition,
                         imageReference.galleryImageVersion,
+                        imageReference.galleryImageSpecialized,
                         imageReference.gallerySubscriptionId,
                         imageReference.galleryResourceGroup
                 )
@@ -1695,6 +1713,7 @@ public FormValidation doVerifyConfiguration(
                 @QueryParameter String galleryName,
                 @QueryParameter String galleryImageDefinition,
                 @QueryParameter String galleryImageVersion,
+                @QueryParameter boolean galleryImageSpecialized,
                 @QueryParameter String gallerySubscriptionId,
                 @QueryParameter String galleryResourceGroup,
                 @QueryParameter String agentLaunchMethod,

src/main/java/com/microsoft/azure/vmagent/AzureVMManagementServiceDelegate.java

@@ -400,7 +400,11 @@ public AzureVMDeploymentInfo createDeployment(
 
             boolean osDiskSizeChanged = osDiskSize > 0;
             boolean availabilitySetEnabled = availabilitySet != null;
-            if (msiEnabled || uamiEnabled || osDiskSizeChanged || availabilitySetEnabled) {
+            boolean isSpecializedImage = false;
+            if (template.getImageReference() != null) {
+                isSpecializedImage = template.getImageReference().getGalleryImageSpecialized();
+            }
+            if (msiEnabled || uamiEnabled || osDiskSizeChanged || availabilitySetEnabled || isSpecializedImage) {
                 ArrayNode resources = (ArrayNode) tmp.get("resources");
                 for (JsonNode resource : resources) {
                     String type = resource.get("type").asText();
@@ -444,6 +448,11 @@ public AzureVMDeploymentInfo createDeployment(
                             ((ObjectNode) propertiesNode).replace("availabilitySet",
                                     availabilitySetNode);
                         }
+                        if (isSpecializedImage) {
+                            // For specialized image remove the osProfile from the properties of the VirtualMachine resource
+                            JsonNode propertiesNode = resource.get("properties");
+                           ((ObjectNode) propertiesNode).remove("osProfile");
+                        }
                     }
                 }
             }

src/main/java/com/microsoft/azure/vmagent/builders/AdvancedImage.java

@@ -23,7 +23,9 @@ public class AdvancedImage {
 
     private String galleryImageDefinition;
 
-    private String  galleryImageVersion;
+    private String galleryImageVersion;
+
+    private boolean galleryImageSpecialized;
 
     private String gallerySubscriptionId;
 
@@ -74,6 +76,7 @@ public AdvancedImage(String imageReferenceType,
                          String galleryName,
                          String galleryImageDefinition,
                          String galleryImageVersion,
+                         boolean galleryImageSpecialized,
                          String gallerySubscriptionId,
                          String galleryResourceGroup,
                          String agentLaunchMethod,
@@ -104,6 +107,7 @@ public AdvancedImage(String imageReferenceType,
         this.galleryName = galleryName;
         this.galleryImageDefinition = galleryImageDefinition;
         this.galleryImageVersion = galleryImageVersion;
+        this.galleryImageSpecialized = galleryImageSpecialized;
         this.gallerySubscriptionId = gallerySubscriptionId;
         this.galleryResourceGroup = galleryResourceGroup;
         this.agentLaunchMethod = agentLaunchMethod;
@@ -169,6 +173,10 @@ public String getGalleryImageVersion() {
         return galleryImageVersion;
     }
 
+    public boolean getGalleryImageSpecialized() {
+        return galleryImageSpecialized;
+    }
+
     public String getGallerySubscriptionId() {
         return gallerySubscriptionId;
     }

src/main/java/com/microsoft/azure/vmagent/builders/AdvancedImageBuilder.java

@@ -86,6 +86,7 @@ public AdvancedImage build() {
                 fluent.getGalleryName(),
                 fluent.getGalleryImageDefinition(),
                 fluent.getGalleryImageVersion(),
+                fluent.getGalleryImageSpecialized(),
                 fluent.getGallerySubscriptionId(),
                 fluent.getGalleryResourceGroup(),
                 fluent.getAgentLaunchMethod(),

src/main/java/com/microsoft/azure/vmagent/builders/AdvancedImageFluent.java

@@ -28,6 +28,8 @@ public class AdvancedImageFluent<T extends AdvancedImageFluent<T>> {
 
     private String galleryImageVersion;
 
+    private boolean galleryImageSpecialized;
+
     private String gallerySubscriptionId;
 
     private String galleryResourceGroup;
@@ -110,12 +112,14 @@ public T withReferenceImage(String imagePublisher,
     public T withGalleryImage(String galleryName,
                               String galleryImageDefinition,
                               String galleryImageVersion,
+                              boolean galleryImageSpecialized,
                               String gallerySubscriptionId,
                               String galleryResourceGroup) {
         this.imageReferenceType = ImageReferenceType.GALLERY.getName();
         this.galleryName = galleryName;
         this.galleryImageDefinition = galleryImageDefinition;
         this.galleryImageVersion = galleryImageVersion;
+        this.galleryImageSpecialized = galleryImageSpecialized;
         this.gallerySubscriptionId = gallerySubscriptionId;
         this.galleryResourceGroup = galleryResourceGroup;
         return (T) this;
@@ -255,6 +259,10 @@ public String getGalleryImageVersion() {
         return galleryImageVersion;
     }
 
+    public boolean getGalleryImageSpecialized() {
+        return galleryImageSpecialized;
+    }
+
     public String getGallerySubscriptionId() {
         return gallerySubscriptionId;
     }

src/main/java/com/microsoft/azure/vmagent/builders/AzureVMTemplateBuilder.java

@@ -132,6 +132,8 @@ public AzureVMAgentTemplate build() {
         azureVMAgentTemplate.setUamiID(fluent.getAdvancedImage().getUamiID());
         azureVMAgentTemplate.setPreInstallSsh(fluent.getAdvancedImage().isPreInstallSsh());
         azureVMAgentTemplate.setTags(fluent.getCloudTags());
+        azureVMAgentTemplate.getImageReference().setGalleryImageSpecialized(
+            fluent.getAdvancedImage().getGalleryImageSpecialized());
         return azureVMAgentTemplate;
     }
 }

src/main/resources/com/microsoft/azure/vmagent/AzureVMAgentTemplate/config.jelly

@@ -197,6 +197,9 @@
                         <f:entry title="${%Gallery_Image_Version}" field="galleryImageVersion">
                             <f:textbox/>
                         </f:entry>
+                        <f:entry title="${%Gallery_Image_Specialized}" field="galleryImageSpecialized">
+                            <f:checkbox/>
+                        </f:entry>
                     </f:dropdownListBlock>
                 </f:dropdownList>
 
@@ -302,6 +305,6 @@
             </div>
         </f:entry>
         <f:validateButton title="${%Verify_Template}" progress="${%Verifying_Template_MSG}" method="verifyConfiguration"
-                          with="azureCredentialsId,resourceGroupReferenceType,newResourceGroupName,existingResourceGroupName,maxVirtualMachinesLimit,deploymentTimeout,templateName,labels,location,virtualMachineSize,storageAccountNameReferenceType,newStorageAccountName,existingStorageAccountName,storageAccountType,noOfParallelJobs,imageTopLevelType,builtInImage,image,osType,id,uri,publisher,offer,sku,version,galleryName,galleryImageDefinition,galleryImageVersion,gallerySubscriptionId,galleryResourceGroup,agentLaunchMethod,initScript,credentialsId,virtualNetworkName,virtualNetworkResourceGroupName,subnetName,usePrivateIP,nsgName,jvmOptions"/>
+                          with="azureCredentialsId,resourceGroupReferenceType,newResourceGroupName,existingResourceGroupName,maxVirtualMachinesLimit,deploymentTimeout,templateName,labels,location,virtualMachineSize,storageAccountNameReferenceType,newStorageAccountName,existingStorageAccountName,storageAccountType,noOfParallelJobs,imageTopLevelType,builtInImage,image,osType,id,uri,publisher,offer,sku,version,galleryName,galleryImageDefinition,galleryImageVersion,galleryImageSpecialized,gallerySubscriptionId,galleryResourceGroup,agentLaunchMethod,initScript,credentialsId,virtualNetworkName,virtualNetworkResourceGroupName,subnetName,usePrivateIP,nsgName,jvmOptions"/>
     </div>
 </j:jelly>

src/main/resources/com/microsoft/azure/vmagent/AzureVMAgentTemplate/config.properties

@@ -42,6 +42,7 @@ Gallery_Subscription_Id=Gallery Subscription Id
 Gallery_Resource_Group=Resource Group
 Gallery_Image_Definition=Image Definition
 Gallery_Image_Version=Image Version
+Gallery_Image_Specialized=Specialized Image
 
 Launch_Method=Launch Method
 Pre_Install_Ssh=Pre-Install SSH in Windows Agent (Check when using Windows and SSH)

src/main/resources/com/microsoft/azure/vmagent/AzureVMAgentTemplate/help-galleryImageSpecialized.html

@@ -0,0 +1,3 @@
+<div>
+    If your image is <a href="https://docs.microsoft.com/en-us/azure/virtual-machines/shared-image-galleries#generalized-and-specialized-images">Specialized</a> then you need to enable this option. 
+</div>

src/test/java/com/microsoft/azure/vmagent/test/IntegrationTest.java

@@ -114,6 +114,7 @@ protected static class TestEnvironment {
         public String galleryName;
         public String galleryImageDefinition;
         public String galleryImageVersion;
+        public boolean galleryImageSpecialized;
         public String gallerySubscriptionId;
         public String galleryResourceGroup;
         public List<AzureTagPair> customTags;