Added support for specifying a plan for VMs and VMSSes when using a SIG image.

Author: whites11

api/v1alpha3/azuremachinetemplate_conversion.go

@@ -17,6 +17,7 @@ limitations under the License.
 package v1alpha3
 
 import (
+	apimachineryconversion "k8s.io/apimachinery/pkg/conversion"
 	infrav1alpha4 "sigs.k8s.io/cluster-api-provider-azure/api/v1alpha4"
 	utilconversion "sigs.k8s.io/cluster-api/util/conversion"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
@@ -44,6 +45,12 @@ func (src *AzureMachineTemplate) ConvertTo(dstRaw conversion.Hub) error { // nol
 		}
 	}
 
+	if restored.Spec.Template.Spec.Image.SharedGallery != nil {
+		dst.Spec.Template.Spec.Image.SharedGallery.Offer = restored.Spec.Template.Spec.Image.SharedGallery.Offer
+		dst.Spec.Template.Spec.Image.SharedGallery.Publisher = restored.Spec.Template.Spec.Image.SharedGallery.Publisher
+		dst.Spec.Template.Spec.Image.SharedGallery.SKU = restored.Spec.Template.Spec.Image.SharedGallery.SKU
+	}
+
 	return nil
 }
 
@@ -73,3 +80,11 @@ func (dst *AzureMachineTemplateList) ConvertFrom(srcRaw conversion.Hub) error {
 	src := srcRaw.(*infrav1alpha4.AzureMachineTemplateList)
 	return Convert_v1alpha4_AzureMachineTemplateList_To_v1alpha3_AzureMachineTemplateList(src, dst, nil)
 }
+
+func Convert_v1alpha4_AzureSharedGalleryImage_To_v1alpha3_AzureSharedGalleryImage(in *infrav1alpha4.AzureSharedGalleryImage, out *AzureSharedGalleryImage, s apimachineryconversion.Scope) error { // nolint
+	if err := autoConvert_v1alpha4_AzureSharedGalleryImage_To_v1alpha3_AzureSharedGalleryImage(in, out, s); err != nil {
+		return err
+	}
+
+	return nil
+}

api/v1alpha3/zz_generated.conversion.go

@@ -322,6 +322,23 @@ type AzureSharedGalleryImage struct {
 	// time even if a new version becomes available.
 	// +kubebuilder:validation:MinLength=1
 	Version string `json:"version"`
+	// Publisher is the name of the organization that created the image.
+	// This value will be used to add a `Plan` in the API request when creating the VM/VMSS resource.
+	// This is needed when the source image from which this SIG image was built requires the `Plan` to be used.
+	// +optional
+	Publisher *string `json:"publisher,omitempty"`
+	// Offer specifies the name of a group of related images created by the publisher.
+	// For example, UbuntuServer, WindowsServer
+	// This value will be used to add a `Plan` in the API request when creating the VM/VMSS resource.
+	// This is needed when the source image from which this SIG image was built requires the `Plan` to be used.
+	// +optional
+	Offer *string `json:"offer,omitempty"`
+	// SKU specifies an instance of an offer, such as a major release of a distribution.
+	// For example, 18.04-LTS, 2019-Datacenter
+	// This value will be used to add a `Plan` in the API request when creating the VM/VMSS resource.
+	// This is needed when the source image from which this SIG image was built requires the `Plan` to be used.
+	// +optional
+	SKU *string `json:"sku,omitempty"`
 }
 
 // VMIdentity defines the identity of the virtual machine, if configured.

api/v1alpha4/types.go

@@ -385,6 +385,7 @@ func (s *Service) buildVMSSFromSpec(ctx context.Context, vmssSpec azure.ScaleSet
 			Capacity: to.Int64Ptr(vmssSpec.Capacity),
 		},
 		Zones: to.StringSlicePtr(vmssSpec.FailureDomains),
+		Plan:  s.generateImagePlan(),
 		VirtualMachineScaleSetProperties: &compute.VirtualMachineScaleSetProperties{
 			UpgradePolicy: &compute.UpgradePolicy{
 				Mode: compute.UpgradeModeManual,
@@ -631,6 +632,36 @@ func (s *Service) generateOSProfile(ctx context.Context, vmssSpec azure.ScaleSet
 	return osProfile, nil
 }
 
+func (s *Service) generateImagePlan() *compute.Plan {
+	image, err := s.Scope.GetVMImage()
+	if err != nil {
+		s.Scope.Error(err, "failed to get vm image, disabling Plan")
+		return nil
+	}
+
+	if image.SharedGallery != nil && image.SharedGallery.Publisher != nil && image.SharedGallery.SKU != nil && image.SharedGallery.Offer != nil {
+		return &compute.Plan{
+			Publisher: image.SharedGallery.Publisher,
+			Name:      image.SharedGallery.SKU,
+			Product:   image.SharedGallery.Offer,
+		}
+	}
+
+	if image.Marketplace == nil || !image.Marketplace.ThirdPartyImage {
+		return nil
+	}
+
+	if image.Marketplace.Publisher == "" || image.Marketplace.SKU == "" || image.Marketplace.Offer == "" {
+		return nil
+	}
+
+	return &compute.Plan{
+		Publisher: to.StringPtr(image.Marketplace.Publisher),
+		Name:      to.StringPtr(image.Marketplace.SKU),
+		Product:   to.StringPtr(image.Marketplace.Offer),
+	}
+}
+
 func getVMSSUpdateFromVMSS(vmss compute.VirtualMachineScaleSet) (compute.VirtualMachineScaleSetUpdate, error) {
 	jsonData, err := vmss.MarshalJSON()
 	if err != nil {

api/v1alpha4/zz_generated.deepcopy.go

@@ -1057,7 +1057,7 @@ func setupDefaultVMSSExpectations(s *mock_scalesets.MockScaleSetScopeMockRecorde
 			Version:   "1.0",
 		},
 	}
-	s.GetVMImage().Return(image, nil)
+	s.GetVMImage().Return(image, nil).AnyTimes()
 	s.SaveVMImageToStatus(image)
 }
 
@@ -1071,7 +1071,7 @@ func setupUpdateVMSSExpectations(s *mock_scalesets.MockScaleSetScopeMockRecorder
 			Version:   "2.0",
 		},
 	}
-	s.GetVMImage().Return(image, nil)
+	s.GetVMImage().Return(image, nil).AnyTimes()
 	s.SaveVMImageToStatus(image)
 }
 

azure/services/scalesets/scalesets.go

@@ -251,9 +251,18 @@ func (s *Service) getExisting(ctx context.Context, name string) (*infrav1.VM, er
 func (s *Service) generateImagePlan() *compute.Plan {
 	image, err := s.Scope.GetVMImage()
 	if err != nil {
+		s.Scope.Error(err, "failed to get vm image, disabling Plan")
 		return nil
 	}
 
+	if image.SharedGallery != nil && image.SharedGallery.Publisher != nil && image.SharedGallery.SKU != nil && image.SharedGallery.Offer != nil {
+		return &compute.Plan{
+			Publisher: image.SharedGallery.Publisher,
+			Name:      image.SharedGallery.SKU,
+			Product:   image.SharedGallery.Offer,
+		}
+	}
+
 	if image.Marketplace == nil || !image.Marketplace.ThirdPartyImage {
 		return nil
 	}